Kong Custom Domains 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 Custom Domains. 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 3 paths,
and defines 36 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 operations3 paths36 schemas1 DELETE3 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Kong Custom Domains 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 3 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are CustomDomain (12 properties), BaseError (5 properties), InvalidParameterDependentItem (5 properties), InvalidParameterChoiceItem (5 properties). Each schema is shown below with its type and property counts.
InvalidParameterMinimumLength
object
5 properties4 required
ControlPlaneGeo
string
Set of control-plane geos supported for deploying cloud-gateways configurations.
CustomDomainOnlinePropertyStatus
string
Set of available statuses for the online properties of a custom domain.
ControlPlaneId
string
ControlPlaneGeoFieldEqualsFilter
Filter a control-plane geo by exact match.
CustomDomainOnlineStatus
object
2 properties2 required
ConflictError
InvalidParameterChoiceItem
object
5 properties4 required
InvalidParameterMaximumLength
object
5 properties4 required
CloudGatewaysStringFieldFilterOverride
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
CreateCustomDomainRequest
object
Request schema for creating a custom domain in the global API.
4 properties3 required
CustomDomainState
string
State of the custom domain.
ForbiddenError
CustomDomainKind
string
Pre-release Feature This feature is currently in beta and is subject to change. Kind of the custom domain based on Cloud Gateway deployment.
CustomDomainStateFieldNotEqualsFilter
object
Filter custom domain state by inequality match.
1 property1 required
UnauthorizedError
CustomDomainsFilterParameters
object
4 properties
CustomDomainName
string
Domain name of the custom domain.
PaginatedMeta
object
returns the pagination information
1 property1 required
BaseError
object
standard error
5 properties4 required
InvalidParameterDependentItem
object
5 properties4 required
ControlPlaneGeoFieldFilter
CustomDomainStateFieldEqualsFilter
Filter custom domain state by exact match.
ControlPlaneGeoFieldOrEqualityFilter
object
Filter a control-plane geo 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
InvalidRules
string
invalid parameters rules
BadRequestError
InvalidParameters
array
invalid parameters
IDFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
InvalidParameterStandard
object
4 properties2 required
CustomDomain
object
Object containing information about a custom domain for a control-plane.
12 properties9 required
NotFoundError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties3 required
CustomDomainStateFieldOrEqualityFilter
object
Filter custom domain 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
ControlPlaneGeoFieldNotEqualsFilter
object
Filter a control-plane geo by inequality match.
1 property1 required
CustomDomainStateFieldFilter
CustomDomainId
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
