Kong Private DNS API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Private DNS. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.
This API exposes
5 operations
across 2 paths,
and defines 42 schemas.
It is described by OpenAPI 3.1.0, at version 3.14.0.
Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.
5 operations2 paths42 schemas1 DELETE2 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Kong Private DNS API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Kong-Admin-Token (adminToken).
By default, every request must be authenticated.
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are GcpPrivateHostedZoneResponse (8 properties), AzurePrivateHostedZoneResponse (8 properties), AzurePrivateDnsResolverResponse (8 properties), AwsPrivateHostedZoneResponse (8 properties). Each schema is shown below with its type and property counts.
PrivateDnsStateFieldOrEqualityFilter
object
Filter Private DNS state by determining if the value is equal to any in a set of values, where the set is a comma-delimited list.
1 property1 required
InvalidParameterMinimumLength
object
5 properties4 required
PrivateDnsResponse
AwsPrivateDnsResolverAttachmentConfig
object
2 properties2 required
PatchPrivateDnsRequest
object
Request schema for updating a Private DNS.
PatchAwsPrivateDnsResolver
object
Request schema for updating a Private DNS AWS Resolver.
2 properties
ConflictError
InvalidParameterChoiceItem
object
5 properties4 required
InvalidParameterMaximumLength
object
5 properties4 required
AzurePrivateDnsResolverAttachmentConfig
object
2 properties2 required
PrivateDnsResolverConfigObject
object
1 property1 required
AwsPrivateHostedZoneResponse
object
8 properties8 required
PrivateDnsName
string
Human-readable name of the Private DNS.
CloudGatewaysStringFieldFilterOverride
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
ForbiddenError
UnauthorizedError
AzurePrivateHostedZoneResponse
object
8 properties8 required
PrivateDnsResolverConfig
object
Object that contains mappings from proxied internal domains to remote DNS server IP address for a Private DNS Resolver.
PrivateDnsStateFieldEqualsFilter
Filter Private DNS state by exact match.
PrivateDnsStateFieldNotEqualsFilter
object
Filter private-dns state by inequality match.
1 property1 required
PaginatedMeta
object
returns the pagination information
1 property1 required
AzurePrivateHostedZoneAttachmentConfig
object
6 properties6 required
PrivateDnsStateFieldFilter
PrivateDnsId
string
BaseError
object
standard error
5 properties4 required
InvalidParameterDependentItem
object
5 properties4 required
GcpPrivateHostedZoneAttachmentConfig
object
4 properties4 required
InvalidRules
string
invalid parameters rules
PatchAzurePrivateDnsResolver
object
Request schema for updating a Private DNS Azure Resolver.
2 properties
BadRequestError
InvalidParameters
array
invalid parameters
InvalidParameterStandard
object
4 properties2 required
AzurePrivateDnsResolverResponse
object
8 properties8 required
NetworkId
string
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
PrivateDnsState
string
The current state of the Private DNS attachment. Possible values: - created - The attachment has been created but is not attached to Private DNS. - initializin…
AwsPrivateHostedZoneAttachmentConfig
object
2 properties2 required
AwsPrivateDnsResolverResponse
object
8 properties8 required
CreatePrivateDnsRequest
object
Request schema for creating a Private DNS.
2 properties
NotFoundError
GcpPrivateHostedZoneResponse
object
8 properties8 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties3 required
PrivateDnsFilterParameters
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
