Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Portal Custom Domains API

APIs related to configuration of Konnect Developer Portals custom domains.

Kong Portal 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 Portal 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 4 operations across 1 path, and defines 26 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}.

4 operations 1 paths 26 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Kong Portal 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 4

Across 1 path, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Portal Custom Domains 4

APIs related to configuration of Konnect Developer Portals custom domains.

GET
/v3/portals/{portalId}/custom-domain
Get Custom Domain
get-portal-custom-domain 1 param → 200401403404
POST
/v3/portals/{portalId}/custom-domain
Create Custom Domain
create-portal-custom-domain 1 param body → 201400401403404
PATCH
/v3/portals/{portalId}/custom-domain
Enable or Disable Domain
update-portal-custom-domain 1 param body → 200400401403
DELETE
/v3/portals/{portalId}/custom-domain
Remove Domain
delete-portal-custom-domain 1 param → 204404

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are PortalCustomDomain (6 properties), PortalCustomDomainSSL (6 properties), InvalidParameterMaximumLength (5 properties), BaseError (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
PortalCustomDomain
object
6 properties 6 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
UpdatePortalCustomDomainRequest
object
2 properties
PortalCustomDomainSSL
object
6 properties 2 required
PortalCustomDomainValidationErrors
array
ForbiddenError
UnauthorizedError
PortalCustomDomainVerificationMethod
string
CreatePortalCustomDomainRequest
object
3 properties 3 required
CreatePortalCustomDomainSSLStandard
object
1 property 1 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
PortalCustomDomainCnameStatus
string
BadRequestError
CreatePortalCustomDomainSSL
object
PortalCustomDomainVerificationStatus
string
InvalidParameterStandard
object
4 properties 2 required
CreatePortalCustomDomainSSLWithCustomCertificate
object
4 properties 3 required
UpdatePortalCustomDomainSSL
object
3 properties
NotFoundError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-portal-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