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 Custom Plugin Schemas API

Custom Plugin Schemas

Kong Custom Plugin Schemas 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 Plugin Schemas. 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 17 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 operations 2 paths 17 schemas 1 DELETE2 GET1 POST1 PUT

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 Custom Plugin Schemas 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 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Plugin Schemas 5

Custom Plugin Schemas

GET
/v2/control-planes/{controlPlaneId}/core-entities/plugin-schemas
List Custom Plugin Schemas
list-plugin-schemas 3 params → 200400401403
POST
/v2/control-planes/{controlPlaneId}/core-entities/plugin-schemas
Upload custom plugin schema
create-plugin-schemas 1 param body → 201400401403409
GET
/v2/control-planes/{controlPlaneId}/core-entities/plugin-schemas/{name}
Get a custom plugin schema
get-plugin-schema 2 params → 200401403404
DELETE
/v2/control-planes/{controlPlaneId}/core-entities/plugin-schemas/{name}
Delete custom plugin schema
delete-plugin-schemas 2 params → 204401403404
PUT
/v2/control-planes/{controlPlaneId}/core-entities/plugin-schemas/{name}
Create or update a custom plugin schema
update-plugin-schemas 2 params body → 200400401403404

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are InvalidParameterDependentItem (5 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
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
KonnectCPLegacyUnauthorizedError
ForbiddenError
UnauthorizedError
KonnectCPLegacyForbiddenError
KonnectCPLegacyBaseError
object
standard error
1 property
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
KonnectCPLegacyConflictError
BadRequestError
InvalidParameters
array
invalid parameters
KonnectCPLegacyBadRequestError
InvalidParameterStandard
object
4 properties 2 required
KonnectCPLegacyNotFoundError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-custom-plugin-schemas-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