Add-Ons
List Add-Ons
Returns a paginated list of add-ons for the organization. Use filter parameters to narrow results by owner (control plane or control plane group), lifecycle state, or config kind.
get/v2/cloud-gateways/add-ons
Query parameters
page[size]integer
Example:10
The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]integer
Example:1
Determines which page of the entities to retrieve.
Filters supported for add-ons.
Response
A paginated list for a collection of add-ons.
Example response
{
"meta": {
"page": {
"number": 1,
"size": 10,
"total": 100
}
},
"data": [
{
"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"
}
]
}