How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Add-Ons API

The Add-Ons API from Kong — 2 operation(s) for add-ons.

Kong Add-Ons 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 Addons. 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 53 schemas. It is described by OpenAPI 3.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

5 operations 2 paths 53 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.14.0
Base URL
https://global.api.konghq.com
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Add-Ons API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

Paths & Operations 5

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

Add Ons 5
POST
/v2/cloud-gateways/add-ons
Create Add-On
create-add-on body → 201400401403404409
GET
/v2/cloud-gateways/add-ons
List Add-Ons
list-add-ons 3 params → 200400401403
GET
/v2/cloud-gateways/add-ons/{addOnId}
Get Add-On
get-add-on 1 param → 200401403404
DELETE
/v2/cloud-gateways/add-ons/{addOnId}
Delete Add-On
delete-add-on 1 param → 204400401403404
PATCH
/v2/cloud-gateways/add-ons/{addOnId}
Update Add-On
update-add-on 1 param body → 200400401403404

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are AddOnResponse (8 properties), AddOnsFilterParameters (7 properties), ManagedCacheAddOnDataPlaneGroup (6 properties), CloudGatewaysStringFieldFilterOverride (5 properties). Each schema is shown below with its type and property counts.

AddOnName
string
Unique human-readable name of the add-on.
AddOnConfigKindFieldEqualsComparison
object
1 property 1 required
AddOnConfigResponse
object
Configuration object for different types of add-ons.
AddOnConfigKindFieldEqualsFilter
Filter add-on config kind by exact match.
ControlPlaneGeoFieldOrEqualityFilter
object
Filter a control-plane geo by determining if the value is equal to any in a set of values, where the set is a comma-delimited list.
1 property 1 required
AddOnStateFieldFilter
InvalidParameterChoiceItem
object
5 properties 4 required
ControlPlaneGeoFieldNotEqualsFilter
object
Filter a control-plane geo by inequality match.
1 property 1 required
CreateAddOnConfig
object
Configuration for creating different types of add-ons.
UpdateAddOnRequest
object
Request body for updating an add-on.
1 property 1 required
AddOnId
string
ControlPlaneGroupAddOnOwner
object
Control Plane Group is the owner for the add-on.
3 properties 3 required
AddOnConfigKindFieldOrEqualityFilter
object
Filter add-on config kind by determining if the value is equal to any in a set of values.
1 property 1 required
CreateManagedCacheAddOnConfig
object
Configuration for creating a managed cache add-on.
2 properties 2 required
UpdateAddOnConfig
object
Configuration for updating different types of add-ons.
AddOnStateFieldOrEqualityFilter
object
Filter add-on state by determining if the value is equal to any in a set of values, where the set is a comma-delimited list.
1 property 1 required
BaseError
object
standard error
5 properties 4 required
AddOnStateFieldEqualsFilter
Filter add-on state by exact match.
InvalidParameters
array
invalid parameters
ProviderName
string
Name of cloud provider.
AddOnStateFieldNotEqualsFilter
object
Filter add-on state by inequality match.
1 property 1 required
BadRequestError
PaginatedMeta
object
returns the pagination information
1 property 1 required
ManagedCacheCapacityConfig
object
Configuration for managed cache capacity and performance characteristics.
ManagedCacheAddOnDataPlaneGroup
object
Object that describes a data-plane group where managed cache add-on is deployed.
6 properties 6 required
AddOnResponse
object
Object containing information about an add-on.
8 properties 8 required
TieredCapacityConfig
object
Capacity tiers with pre-configured size and performance characteristics.
2 properties 2 required
InvalidParameterMinimumLength
object
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
UpdateManagedCacheAddOnConfig
object
Configuration for updating a managed cache add-on.
2 properties 2 required
ForbiddenError
NotFoundError
UnauthorizedError
InvalidRules
string
invalid parameters rules
CloudGatewaysStringFieldFilterOverride
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
AddOnStateFieldEqualsComparison
object
1 property 1 required
CreateAddOnRequest
object
Request schema for creating an add-on.
3 properties 3 required
ManagedCacheAddOnConfigResponse
object
Configuration for managed cache add-on.
4 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
ControlPlaneGeo
string
Set of control-plane geos supported for deploying cloud-gateways configurations.
AddOnOwner
object
Owner for the add-on.
AddOnState
string
The current state of the add-on. Possible values: - initializing - The add-on is in the process of being initialized/updated. - ready - The add-on is fully ope…
ConflictError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
ControlPlaneGeoFieldFilter
AddOnConfigKindFieldNotEqualsFilter
object
Filter add-on config kind by inequality match.
1 property 1 required
AddOnConfigKind
string
Type of add-on config.
ControlPlaneAddOnOwner
object
Control Plane is the owner for the add-on.
3 properties 3 required
AddOnsFilterParameters
object
Filter parameters for add-ons list operation.
7 properties
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
InvalidParameterStandard
object
4 properties 2 required
ControlPlaneGeoFieldEqualsFilter
Filter a control-plane geo by exact match.
AddOnConfigKindFieldFilter
Filter for add-on config kind field.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-add-ons-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 API Attributes API
Kong API Documentation API
Kong API Image API
Kong API Implementation API
Kong API-keys API
Where this information came from

This is an independent, third-party profile of Kong Add-Ons API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.