Create a Dynamic DNS entry

POST

/dynamic-dns/entries

curl --request POST \
  --url https://sylve.lan:8181/api/dynamic-dns/entries \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "hostname": "example", "intervalMinutes": 1, "provider": "example", "providerSettings": { "additionalProperty": "example" }, "recordType": "example", "sourceSettings": { "additionalProperty": "example" }, "sourceType": "example", "token": "example" }'

Create and validate a Dynamic DNS entry

Authorizations

• BearerAuth

Request Body

Dynamic DNS entry

Media typeapplication/json

object

enabled

boolean

hostname

string

intervalMinutes

integer

provider

string

providerSettings

object

key

additional properties

string

recordType

string

sourceSettings

object

key

additional properties

string

sourceType

string

token

string

Example^generated

{
  "enabled": true,
  "hostname": "example",
  "intervalMinutes": 1,
  "provider": "example",
  "providerSettings": {
    "additionalProperty": "example"
  },
  "recordType": "example",
  "sourceSettings": {
    "additionalProperty": "example"
  },
  "sourceType": "example",
  "token": "example"
}

Responses

201

Created

Media typeapplication/json

object

data

object

consecutiveFailures

integer

createdAt

string

credentialConfigured

boolean

enabled

boolean

hostname

string

id

integer

intervalMinutes

integer

ipv4Error

string

ipv4Status

string

ipv6Error

string

ipv6Status

string

lastError

string

lastIPv4

string

lastIPv6

string

lastStatus

string

lastSuccessAt

string

lastSyncAt

string

nextRetryAt

string

provider

string

providerSettings

object

key

additional properties

string

recordType

string

sourceSettings

object

key

additional properties

string

sourceType

string

updatedAt

string

error

string

message

string

status

string

Example^generated

{
  "data": {
    "consecutiveFailures": 1,
    "createdAt": "example",
    "credentialConfigured": true,
    "enabled": true,
    "hostname": "example",
    "id": 1,
    "intervalMinutes": 1,
    "ipv4Error": "example",
    "ipv4Status": "example",
    "ipv6Error": "example",
    "ipv6Status": "example",
    "lastError": "example",
    "lastIPv4": "example",
    "lastIPv6": "example",
    "lastStatus": "example",
    "lastSuccessAt": "example",
    "lastSyncAt": "example",
    "nextRetryAt": "example",
    "provider": "example",
    "providerSettings": {
      "additionalProperty": "example"
    },
    "recordType": "example",
    "sourceSettings": {
      "additionalProperty": "example"
    },
    "sourceType": "example",
    "updatedAt": "example"
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Conflict

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Payload Too Large

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

502

Bad Gateway

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}