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 API Specification API

The API Specification API from Kong — 3 operation(s) for api specification.

Kong API Specification 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 API Specification. 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 6 operations across 3 paths, and defines 24 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}.

6 operations 3 paths 24 schemas 1 DELETE2 GET1 PATCH2 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 API Specification 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 6

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

API Specification 6
POST
/v3/apis/{apiId}/specificationsdeprecated
Create API Specification
create-api-spec 1 param body → 201400401403404409415
GET
/v3/apis/{apiId}/specificationsdeprecated
List API Specifications
list-api-specs 4 params → 200401403404
GET
/v3/apis/{apiId}/specifications/{specId}deprecated
Get API Specification
fetch-api-spec 2 params → 200401403404
PATCH
/v3/apis/{apiId}/specifications/{specId}deprecated
Update API Specification
update-api-spec 2 params body → 200400401403404409415
DELETE
/v3/apis/{apiId}/specifications/{specId}deprecated
Delete API Specification
delete-api-spec 2 params → 204401403404
POST
/v3/apis/validate-specification
Validate API Specification
validate-specification body → 201400401403415

Schemas 24

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

InvalidParameterMinimumLength
object
5 properties 4 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterChoiceItem
object
5 properties 4 required
ApiSpecFilterParameters
object
1 property
InvalidParameterMaximumLength
object
5 properties 4 required
ConflictError
ValidateApiSpecSuccessResponse
object
1 property 1 required
UnauthorizedError
ForbiddenError
PaginatedMeta
object
returns the pagination information
1 property 1 required
StringFieldFilter
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
ApiSpecType
string
The type of specification being stored. This allows us to render the specification correctly.
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
ValidateApiSpecRequestPayload
object
1 property 1 required
InvalidParameterStandard
object
4 properties 2 required
UnsupportedMediaTypeError
ApiSpec
object
6 properties
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
NotFoundError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-api-specification-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