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

The CustomPlugins API from Kong — 2 operation(s) for customplugins.

Kong CustomPlugins 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 CustomPlugins. 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 4 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 4 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 CustomPlugins 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.

CustomPlugins 5
GET
/v2/control-planes/{controlPlaneId}/core-entities/custom-plugins
List all CustomPlugins
list-custom-plugin 4 params → 200401
POST
/v2/control-planes/{controlPlaneId}/core-entities/custom-plugins
Create a new CustomPlugin
create-custom-plugin 1 param body → 201401
DELETE
/v2/control-planes/{controlPlaneId}/core-entities/custom-plugins/{CustomPluginId}
Delete a CustomPlugin
delete-custom-plugin 3 params → 204401
GET
/v2/control-planes/{controlPlaneId}/core-entities/custom-plugins/{CustomPluginId}
Get a CustomPlugin
get-custom-plugin 2 params → 200401404
PUT
/v2/control-planes/{controlPlaneId}/core-entities/custom-plugins/{CustomPluginId}
Upsert a CustomPlugin
upsert-custom-plugin 2 params body → 200401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are CustomPlugin (7 properties), GatewayUnauthorizedError (2 properties). Each schema is shown below with its type and property counts.

PaginationOffsetResponse
string
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
GatewayUnauthorizedError
object
2 properties 2 required
CustomPlugin
object
7 properties 3 required
PaginationNextResponse
string
URI to the next page (may be null)

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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