Sign in

v50

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-068428533.0 MB
Add-Ons

Get Add-On

Retrieves a single add-on by ID, including its current lifecycle state and per data plane group deployment status.

get/v2/cloud-gateways/add-ons/{addOnId}

Path parameters

addOnIdstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

ID of the add-on to operate on.

Response

Response format for retrieving an add-on by ID.

idstring uuid required
namestring required

Unique human-readable name of the add-on.

entity_versioninteger required

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

state'initializing' | 'ready' | 'terminating' required

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.
created_atstring date-time required

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

updated_atstring date-time required

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

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "my-add-on",
  "owner": {
    "control_plane_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "config": {
    "capacity_config": {
      "kind": "tiered",
      "tier": "small"
    },
    "data_plane_groups": [
      {
        "id": "1150820b-c69f-4a2a-b9be-bbcdbc5cd618",
        "cloud_gateway_network_id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
        "provider": "aws",
        "region": "us-east-1",
        "state_metadata": {
          "error_reason": "Failed to create managed cache add-on due to invalid configuration.\n"
        }
      }
    ],
    "state_metadata": {
      "cache_config_id": "edaf40f9-9fb0-4ffe-bb74-4e763a6bd471",
      "cache_server_name": "{vault://env/ADDON_MANAGED_CACHE_SERVER_NAME}",
      "cache_host": "{vault://env/ADDON_MANAGED_CACHE_HOST}",
      "cache_port": "{vault://env/ADDON_MANAGED_CACHE_PORT}",
      "cache_username": "{vault://env/ADDON_MANAGED_CACHE_USERNAME}",
      "cloud_authentication": {
        "auth_provider": "{vault://env/ADDON_MANAGED_CACHE_AUTH_PROVIDER}",
        "aws_cache_name": "{vault://env/ADDON_MANAGED_CACHE_AWS_CACHE_NAME}",
        "aws_region": "{vault://env/ADDON_MANAGED_CACHE_AWS_REGION}",
        "aws_assume_role_arn": "{vault://env/ADDON_MANAGED_CACHE_AWS_ASSUME_ROLE_ARN}",
        "azure_tenant_id": "{vault://env/ADDON_MANAGED_CACHE_AZURE_TENANT_ID}"
      }
    }
  },
  "entity_version": 1,
  "created_at": "2025-08-26T06:56:41Z",
  "updated_at": "2025-08-26T06:56:41Z"
}