Create Add-On

Creates a new add-on. Specific add-on types (e.g., managed cache)
are defined by the sub-kind configuration.

post
https://global.api.konghq.com/v2/cloud-gateways/add-ons

Body

application/json

CreateAddOnRequest

Request schema for creating an add-on.

* Additional properties are NOT allowed.
namestringrequired

Unique human-readable name of the add-on.

>= 1 characters<= 70 characters

Example:my-add-on

ownerOne Of
objectrequired

Owner for the add-on.

ControlPlaneAddOnOwnerobject

Control Plane is the owner for the add-on.

* Additional properties are NOT allowed.
Show Child Parameters
configOne Of
objectrequired

Configuration for creating different types of add-ons.

CreateManagedCacheAddOnConfigobject

Configuration for creating a managed cache add-on.

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Response format for creating an add-on.

AddOnResponse

Object containing information about an add-on.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Example:550e8400-e29b-41d4-a716-446655440000

namestringrequired

Unique human-readable name of the add-on.

>= 1 characters<= 70 characters

Example:my-add-on

ownerOne Of
objectrequired

Owner for the add-on.

ControlPlaneAddOnOwnerobject

Control Plane is the owner for the add-on.

* Additional properties are NOT allowed.
Show Child Parameters
configOne Of
objectrequired

Configuration object for different types of add-ons.

ManagedCacheAddOnConfigResponseobject

Configuration for managed cache add-on.

* Additional properties are NOT allowed.
Show Child Parameters
entity_versionintegerrequiredread-only

Monotonically-increasing version count of the add-on, to indicate the order of updates to the add-on.

Example:1

statestringrequiredread-only

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 operational.
  • terminating - The add-on is in the process of being deleted.

Allowed values:initializingreadyterminating

created_atstring(date-time)requiredread-only

RFC-3339 timestamp representation of add-on creation date.

Example:2025-08-26T06:56:41Z

updated_atstring(date-time)requiredread-only

RFC-3339 timestamp representation of add-on update date.

Example:2025-08-26T06:56:41Z

post/cloud-gateways/add-ons

Body

{ "name": "my-cache-add-on", "owner": { "kind": "control-plane", "control_plane_id": "123e4567-e89b-12d3-a456-426614174000", "control_plane_geo": "us" }, "config": { "kind": "managed-cache.v0", "capacity_config": { "kind": "tiered", "tier": "small" } } }
 
application/json

List Add-Ons

Returns a paginated collection of add-ons for an organization.

get
https://global.api.konghq.com/v2/cloud-gateways/add-ons

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filter parameters for add-ons list operation.

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

A paginated list for a collection of add-ons.

ListAddOnsResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Object containing information about an add-on.

* Additional properties are NOT allowed.
Show Child Parameters
get/cloud-gateways/add-ons
 
application/json

Get Add-On

Retrieves an add-on by ID.

get
https://global.api.konghq.com/v2/cloud-gateways/add-ons/{addOnId}

Path Parameters

addOnIdstring(uuid)requiredread-only

ID of the add-on to operate on.

Example:550e8400-e29b-41d4-a716-446655440000

Response

application/json

Response format for retrieving an add-on by ID.

AddOnResponse

Object containing information about an add-on.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Example:550e8400-e29b-41d4-a716-446655440000

namestringrequired

Unique human-readable name of the add-on.

>= 1 characters<= 70 characters

Example:my-add-on

ownerOne Of
objectrequired

Owner for the add-on.

ControlPlaneAddOnOwnerobject

Control Plane is the owner for the add-on.

* Additional properties are NOT allowed.
Show Child Parameters
configOne Of
objectrequired

Configuration object for different types of add-ons.

ManagedCacheAddOnConfigResponseobject

Configuration for managed cache add-on.

* Additional properties are NOT allowed.
Show Child Parameters
entity_versionintegerrequiredread-only

Monotonically-increasing version count of the add-on, to indicate the order of updates to the add-on.

Example:1

statestringrequiredread-only

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 operational.
  • terminating - The add-on is in the process of being deleted.

Allowed values:initializingreadyterminating

created_atstring(date-time)requiredread-only

RFC-3339 timestamp representation of add-on creation date.

Example:2025-08-26T06:56:41Z

updated_atstring(date-time)requiredread-only

RFC-3339 timestamp representation of add-on update date.

Example:2025-08-26T06:56:41Z

get/cloud-gateways/add-ons/{addOnId}
 
application/json

Delete Add-On

Deletes an add-on by ID. The request will be rejected if the managed cache partial is still in use by some plugins.

delete
https://global.api.konghq.com/v2/cloud-gateways/add-ons/{addOnId}

Path Parameters

addOnIdstring(uuid)requiredread-only

ID of the add-on to operate on.

Example:550e8400-e29b-41d4-a716-446655440000

Response

No Content

delete/cloud-gateways/add-ons/{addOnId}
 

Provider Accounts