AddOnResponse

object

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

Example

AddOnName

string

Unique human-readable name of the add-on.

>= 1 characters<= 70 characters

Example

AddOnOwner

object

Owner for the add-on.

One Of
kindstringrequired

Type of owner for the add-on.

Allowed values:control-plane

control_plane_idstring(uuid)required

ID of the control-plane that owns this add-on.

Example:123e4567-e89b-12d3-a456-426614174000

control_plane_geostringrequired

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

Allowed values:useuaumeinsg

Example

ControlPlaneAddOnOwner

object

Control Plane is the owner for the add-on.

* Additional properties are NOT allowed.
kindstringrequired

Type of owner for the add-on.

Allowed values:control-plane

control_plane_idstring(uuid)required

ID of the control-plane that owns this add-on.

Example:123e4567-e89b-12d3-a456-426614174000

control_plane_geostringrequired

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

Allowed values:useuaumeinsg

Example

ControlPlaneGroupAddOnOwner

object

Control Plane Group is the owner for the add-on.

* Additional properties are NOT allowed.
kindstringrequired

Type of owner for the add-on.

Allowed values:control-plane-group

control_plane_group_idstring(uuid)required

ID of the control-plane group that owns this add-on.

Example:123e4567-e89b-12d3-a456-426614174000

control_plane_group_geostringrequired

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

Allowed values:useuaumeinsg

Example