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/v3/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}
 

Update Add-On

Updates the configuration of an existing add-on.

patch
https://global.api.konghq.com/v3/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

Body

application/json

UpdateAddOnRequest

Request body for updating an add-on.

* Additional properties are NOT allowed.
configOne Of
objectrequired

Configuration for updating different types of add-ons.

UpdateManagedCacheAddOnConfigobject

Configuration for updating a managed cache add-on.

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Response format for updating 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

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

Body

{ "config": { "kind": "managed-cache.v0", "capacity_config": { "kind": "tiered", "tier": "large" } } }
 
application/json

Control-Plane Geo

string

Set of control-plane geos supported for deploying cloud-gateways configurations.

Allowed values:useuaumeinsg

CloudGatewaysProviderName

string

Name of cloud provider.

Allowed values:awsazuregcp

Example

ControlPlaneGeoFieldFilter

One Of
ControlPlaneGeoFieldEqualsFilterOne Of

Filter a control-plane geo by exact match.

Control-Plane Geostring

Set of control-plane geos supported for deploying cloud-gateways configurations.

Allowed values:useuaumeinsg