External DNS Webhook Server (0.14.0)

Download OpenAPI specification:Download

Implements the external DNS webhook endpoints.

k8s

Endpoints to handle k8s features.

Health check

Used by kubernetes to make sure service is ok.

Responses

Response samples

Content type
text/plain
ok

initialization

Endpoints for initial negotiation.

Initialisation and negotiates headers and returns domain filter.

Initialisation and negotiates headers and returns domain filter.

Responses

Response samples

Content type
application/external.dns.webhook+json;version=1
{
  • "filters": [
    ]
}

listing

Endpoints to get listings of DNS records.

Returns the current records.

Get the current records from the DNS provider and return them.

Responses

Response samples

Content type
application/external.dns.webhook+json;version=1
[
  • {
    }
]

update

Endpoints to update DNS records.

Applies the changes.

Set the records in the DNS provider based on those supplied here.

Request Body schema: application/external.dns.webhook+json;version=1
required

This is the list of changes that need to be applied. There are four lists of endpoints. The create and delete lists are lists of records to create and delete respectively. The updateOld and updateNew lists are paired. For each entry there's the old version of the record and a new version of the record.

Array of objects (endpoints)

This is a list of DNS records.

Array of objects (endpoints)

This is a list of DNS records.

Array of objects (endpoints)

This is a list of DNS records.

Array of objects (endpoints)

This is a list of DNS records.

Responses

Request samples

Content type
application/external.dns.webhook+json;version=1
{
  • "create": [
    ],
  • "updateOld": [
    ],
  • "updateNew": [
    ],
  • "delete": [
    ]
}

Executes the AdjustEndpoints method.

Adjusts the records in the provider based on those supplied here.

Request Body schema: application/external.dns.webhook+json;version=1
required

This is the list of changes to be applied.

Array
dnsName
string
targets
Array of strings (targets)

This is the list of targets that this DNS record points to. So for an A record it will be a list of IP addresses.

recordType
string
setIdentifier
string
recordTTL
integer <int64>
object
Array of objects (providerSpecificProperty)

Responses

Request samples

Content type
application/external.dns.webhook+json;version=1
[
  • {
    }
]

Response samples

Content type
application/external.dns.webhook+json;version=1
[
  • {
    }
]