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 Custom Domains API

The Custom Domains API from Kong — 3 operation(s) for custom domains.

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.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 3 paths 36 schemas 1 DELETE3 GET1 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 Custom Domains 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 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.

Custom Domains 5
GET
/v2/cloud-gateways/custom-domains
List Custom Domains
list-custom-domains 3 params → 200400401403404
POST
/v2/cloud-gateways/custom-domains
Create Custom Domain
create-custom-domains body → 201400401403404409
GET
/v2/cloud-gateways/custom-domains/{customDomainId}
Get Custom Domain
get-custom-domain 1 param → 200401403404
DELETE
/v2/cloud-gateways/custom-domains/{customDomainId}
Delete Custom Domain
delete-custom-domain 1 param → 204400401403404
GET
/v2/cloud-gateways/custom-domains/{customDomainId}/online-status
Get Custom Domain Online Status
get-custom-domain-online-status 1 param → 200401403404

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are CustomDomain (12 properties), InvalidParameterMinimumLength (5 properties), InvalidParameterMaximumLength (5 properties), CloudGatewaysStringFieldFilterOverride (5 properties). Each schema is shown below with its type and property counts.

BaseError
object
standard error
5 properties 4 required
BadRequestError
ControlPlaneGeoFieldNotEqualsFilter
object
Filter a control-plane geo by inequality match.
1 property 1 required
CustomDomainStateFieldNotEqualsFilter
object
Filter custom domain state by inequality match.
1 property 1 required
InvalidParameterMinimumLength
object
5 properties 4 required
PaginatedMeta
object
returns the pagination information
1 property 1 required
ControlPlaneGeo
string
Set of control-plane geos supported for deploying cloud-gateways configurations.
CustomDomainName
string
Domain name of the custom domain.
UnauthorizedError
NotFoundError
CustomDomainsFilterParameters
object
4 properties
ControlPlaneGeoFieldEqualsFilter
Filter a control-plane geo 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 property 1 required
CustomDomainStateFieldFilter
CreateCustomDomainRequest
object
Request schema for creating a custom domain in the global API.
4 properties 3 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 property 1 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
InvalidParameterMaximumLength
object
5 properties 4 required
InvalidParameterStandard
object
4 properties 2 required
CustomDomain
object
Object containing information about a custom domain for a control-plane.
12 properties 9 required
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameters
array
invalid parameters
CustomDomainId
string
CustomDomainOnlinePropertyStatus
string
Set of available statuses for the online properties of a custom domain.
ConflictError
ForbiddenError
CustomDomainState
string
State of the custom domain.
CustomDomainStateFieldEqualsFilter
Filter custom domain state by exact match.
InvalidParameterDependentItem
object
5 properties 4 required
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.
CustomDomainOnlineStatus
object
2 properties 2 required
IDFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
ControlPlaneId
string
CloudGatewaysStringFieldFilterOverride
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
InvalidRules
string
invalid parameters rules
ControlPlaneGeoFieldFilter

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-custom-domains-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 Custom Domains 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.