How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Private DNS API

The Private DNS API from Kong — 2 operation(s) for private dns.

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.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

5 operations 2 paths 42 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Private DNS API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

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.

Private DNS 5
GET
/v2/cloud-gateways/networks/{networkId}/private-dns
List Private DNS
list-private-dns 4 params → 200400401403404
POST
/v2/cloud-gateways/networks/{networkId}/private-dns
Create Private DNS
create-private-dns 1 param body → 201400401403404409
GET
/v2/cloud-gateways/networks/{networkId}/private-dns/{privateDnsId}
Get Private DNS
get-private-dns 2 params → 200401403404
PATCH
/v2/cloud-gateways/networks/{networkId}/private-dns/{privateDnsId}
Update Private DNS
update-private-dns 2 params body → 200400401403404409
DELETE
/v2/cloud-gateways/networks/{networkId}/private-dns/{privateDnsId}
Delete Private DNS
delete-private-dns 2 params → 204400401403404

Schemas 42

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), AwsPrivateDnsResolverResponse (8 properties). Each schema is shown below with its type and property counts.

BaseError
object
standard error
5 properties 4 required
BadRequestError
InvalidParameterMinimumLength
object
5 properties 4 required
GcpPrivateHostedZoneAttachmentConfig
object
4 properties 4 required
AwsPrivateDnsResolverAttachmentConfig
object
2 properties 2 required
AzurePrivateDnsResolverAttachmentConfig
object
2 properties 2 required
PaginatedMeta
object
returns the pagination information
1 property 1 required
UnauthorizedError
NotFoundError
PrivateDnsStateFieldNotEqualsFilter
object
Filter private-dns state by inequality match.
1 property 1 required
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…
PrivateDnsResolverConfigObject
object
1 property 1 required
AzurePrivateDnsResolverResponse
object
8 properties 8 required
PatchAzurePrivateDnsResolver
object
Request schema for updating a Private DNS Azure Resolver.
2 properties
PatchAwsPrivateDnsResolver
object
Request schema for updating a Private DNS AWS Resolver.
2 properties
PrivateDnsStateFieldFilter
InvalidParameterMaximumLength
object
5 properties 4 required
InvalidParameterStandard
object
4 properties 2 required
PatchPrivateDnsRequest
object
Request schema for updating a Private DNS.
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
InvalidParameterChoiceItem
object
5 properties 4 required
PrivateDnsStateFieldEqualsFilter
Filter Private DNS state by exact match.
AzurePrivateHostedZoneAttachmentConfig
object
6 properties 6 required
AwsPrivateHostedZoneAttachmentConfig
object
2 properties 2 required
PrivateDnsResponse
PrivateDnsResolverConfig
object
Object that contains mappings from proxied internal domains to remote DNS server IP address for a Private DNS Resolver.
InvalidParameters
array
invalid parameters
AwsPrivateHostedZoneResponse
object
8 properties 8 required
CreatePrivateDnsRequest
object
Request schema for creating a Private DNS.
2 properties
GcpPrivateHostedZoneResponse
object
8 properties 8 required
ConflictError
ForbiddenError
AzurePrivateHostedZoneResponse
object
8 properties 8 required
PrivateDnsName
string
Human-readable name of the Private DNS.
InvalidParameterDependentItem
object
5 properties 4 required
CloudGatewaysStringFieldFilterOverride
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
AwsPrivateDnsResolverResponse
object
8 properties 8 required
PrivateDnsFilterParameters
object
2 properties
NetworkId
string
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
InvalidRules
string
invalid parameters rules
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 property 1 required
PrivateDnsId
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-private-dns-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API
Where this information came from

This is an independent, third-party profile of Kong Private DNS API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.