Get Add-On
Retrieves an add-on by ID.
Path Parameters
ID of the add-on to operate on.
Example:550e8400-e29b-41d4-a716-446655440000
Response
application/json
Response
Response format for retrieving an add-on by ID.
AddOnResponse
Object containing information about an add-on.
Example:550e8400-e29b-41d4-a716-446655440000
Unique human-readable name of the add-on.
>= 1 characters<= 70 characters
Example:my-add-on
One OfOwner for the add-on.
Control Plane is the owner for the add-on.
Show Child Parameters
One OfConfiguration object for different types of add-ons.
Configuration for managed cache add-on.
Show Child Parameters
Monotonically-increasing version count of the add-on, to indicate the order of updates to the add-on.
Example:1
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
RFC-3339 timestamp representation of add-on creation date.
Example:2025-08-26T06:56:41Z
RFC-3339 timestamp representation of add-on update date.
Example:2025-08-26T06:56:41Z
Authentication
Path Parameters
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.
Path Parameters
ID of the add-on to operate on.
Example:550e8400-e29b-41d4-a716-446655440000
Response
Response
No Content
Authentication
Path Parameters
Update Add-On
Updates the configuration of an existing add-on.
Path Parameters
ID of the add-on to operate on.
Example:550e8400-e29b-41d4-a716-446655440000
Body
application/json
Body
UpdateAddOnRequest
Request body for updating an add-on.
One OfConfiguration for updating different types of add-ons.
Configuration for updating a managed cache add-on.
Show Child Parameters
Response
application/json
Response
Response format for updating an add-on.
AddOnResponse
Object containing information about an add-on.
Example:550e8400-e29b-41d4-a716-446655440000
Unique human-readable name of the add-on.
>= 1 characters<= 70 characters
Example:my-add-on
One OfOwner for the add-on.
Control Plane is the owner for the add-on.
Show Child Parameters
One OfConfiguration object for different types of add-ons.
Configuration for managed cache add-on.
Show Child Parameters
Monotonically-increasing version count of the add-on, to indicate the order of updates to the add-on.
Example:1
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
RFC-3339 timestamp representation of add-on creation date.
Example:2025-08-26T06:56:41Z
RFC-3339 timestamp representation of add-on update date.
Example:2025-08-26T06:56:41Z
Authentication
Path Parameters
Body
Control-Plane Geo
stringSet of control-plane geos supported for deploying cloud-gateways configurations.
Allowed values:useuaumeinsg
CloudGatewaysProviderName
stringName of cloud provider.
Allowed values:awsazuregcp