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

Some entities in Kong Gateway share common configuration settings that often need to be repeated. For example, multiple plugins that connect to Redis may require the same connection settings. Without Partials, you would need to replicate this configuration across all plugins. If the settings change, you would need to update each plugin individually.

Kong Partials 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 Partials. 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 9 operations across 4 paths, and defines 15 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}.

9 operations 4 paths 15 schemas 2 DELETE3 GET2 POST2 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 Partials 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 9

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

Partials 9

Some entities in Kong Gateway share common configuration settings that often need to be repeated. For example, multiple plugins that connect to Redis may require the same connecti…

POST
/{workspace}/partials
Create a new Partial
create-partial 1 param body → 201401
DELETE
/{workspace}/partials/{PartialId}
Delete a Partial
delete-partial 3 params → 204401
GET
/{workspace}/partials/{PartialId}
Get a Partial
get-partial 2 params → 200401404
PUT
/{workspace}/partials/{PartialId}
Upsert a Partial
upsert-partial 2 params body → 200401
GET
/v2/control-planes/{controlPlaneId}/core-entities/partials
List all Partials
list-partial 4 params → 200401
POST
/v2/control-planes/{controlPlaneId}/core-entities/partials
Create a new Partial
create-partial 1 param body → 201401
DELETE
/v2/control-planes/{controlPlaneId}/core-entities/partials/{PartialId}
Delete a Partial
delete-partial 3 params → 204401
GET
/v2/control-planes/{controlPlaneId}/core-entities/partials/{PartialId}
Get a Partial
get-partial 2 params → 200401404
PUT
/v2/control-planes/{controlPlaneId}/core-entities/partials/{PartialId}
Upsert a Partial
upsert-partial 2 params body → 200401

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are PartialModel (7 properties), PartialVectordb_2 (7 properties), PartialRedisEe_2 (7 properties), PartialEmbeddings_2 (7 properties). Each schema is shown below with its type and property counts.

Partial
object
PartialRedisEe_2
object
7 properties 2 required
PartialVectordb_2
object
7 properties 2 required
PartialModel
object
7 properties 2 required
Partial_2
object
PartialRedisEe
object
7 properties 2 required
PartialRedisCe
object
7 properties 2 required
PaginationNextResponse
string
URI to the next page (may be null)
PartialVectordb
object
7 properties 2 required
PartialRedisCe_2
object
7 properties 2 required
PartialEmbeddings
object
7 properties 2 required
PartialEmbeddings_2
object
7 properties 2 required
PaginationOffsetResponse
string
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
PartialModel_2
object
7 properties 2 required
GatewayUnauthorizedError
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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