---
title: "Update Add-On"
method: PATCH
path: "/v2/cloud-gateways/add-ons/{addOnId}"
tags: ["Add-Ons"]
---

# Update Add-On

`PATCH /v2/cloud-gateways/add-ons/{addOnId}`

Updates the configuration of an existing add-on, such as changing the managed cache
capacity tier. Tier upgrades are supported; downgrades are not.

## Path parameters

- `addOnId` string, uuid, required

## Request body

- UpdateAddOnRequest — Request body for updating an add-on.
  - `config` UpdateAddOnConfig, required — Configuration for updating a managed cache add-on.
    - `kind` 'managed-cache.v0', required — Type of add-on configuration.
    - `capacity_config` ManagedCacheCapacityConfig, required — Capacity tiers with pre-configured size and performance characteristics.
      - `kind` 'tiered', required — Type of capacity configuration.
      - `tier` 'micro' | 'small' | 'medium' | 'large' | 'xlarge' | '2xlarge' | '4xlarge' | '8xlarge' | '12xlarge' | '16xlarge' | '24xlarge', required — Capacity tier that determines both cache size and performance characteristics: - micro: ~0.5 GiB capacity - small: ~1 GiB capacity - medium: ~3 GiB capacity - large: ~6 GiB capacity - xlarge: ~12 GiB capacity - 2xlarge: ~25 GiB capacity - 4xlarge: ~52 GiB capacity - 8xlarge: ~100 GiB capacity - 12xlarge: ~150 GiB capacity - 16xlarge: ~200 GiB capacity - 24xlarge: ~300 GiB capacity

## Response `200`

Response format for updating an add-on.

- AddOnResponse — Object containing information about an add-on.
  - `id` string, uuid, required
  - `name` string, required — Unique human-readable name of the add-on.
  - `owner` union, required — Owner for the add-on.
    - object — Control Plane is the owner for the add-on.
      - `kind` 'control-plane', required — Type of owner for the add-on.
      - `control_plane_id` string, uuid, required — ID of the control-plane that owns this add-on.
      - `control_plane_geo` 'us' | 'eu' | 'au' | 'me' | 'in' | 'sg', required — Geographic region of the control plane. Supported values: - `us` — United States - `eu` — Europe - `au` — Australia - `me` — Middle East - `in` — India - `sg` — Singapore
    - object — Control Plane Group is the owner for the add-on.
      - `kind` 'control-plane-group', required — Type of owner for the add-on.
      - `control_plane_group_id` string, uuid, required — ID of the control-plane group that owns this add-on.
      - `control_plane_group_geo` 'us' | 'eu' | 'au' | 'me' | 'in' | 'sg', required — Geographic region of the control plane. Supported values: - `us` — United States - `eu` — Europe - `au` — Australia - `me` — Middle East - `in` — India - `sg` — Singapore
  - `config` AddOnConfigResponse, required — Configuration for managed cache add-on.
    - `kind` 'managed-cache.v0', required — Type of add-on configuration.
    - `capacity_config` ManagedCacheCapacityConfig, required — Capacity tiers with pre-configured size and performance characteristics.
      - `kind` 'tiered', required — Type of capacity configuration.
      - `tier` 'micro' | 'small' | 'medium' | 'large' | 'xlarge' | '2xlarge' | '4xlarge' | '8xlarge' | '12xlarge' | '16xlarge' | '24xlarge', required — Capacity tier that determines both cache size and performance characteristics: - micro: ~0.5 GiB capacity - small: ~1 GiB capacity - medium: ~3 GiB capacity - large: ~6 GiB capacity - xlarge: ~12 GiB capacity - 2xlarge: ~25 GiB capacity - 4xlarge: ~52 GiB capacity - 8xlarge: ~100 GiB capacity - 12xlarge: ~150 GiB capacity - 16xlarge: ~200 GiB capacity - 24xlarge: ~300 GiB capacity
    - `data_plane_groups` ManagedCacheAddOnDataPlaneGroup[], required — List of data-plane groups where the managed cache is deployed.
      - `id` string, uuid, required — ID of the data-plane group.
      - `cloud_gateway_network_id` string, uuid, required — Network ID this data-plane group is attached to.
      - `provider` 'aws' | 'azure' | 'gcp', required — Name of cloud provider.
      - `region` string, required — Region of cloud provider the data-plane group is deployed to.
      - `state` 'initializing' | 'ready' | 'error' | 'terminating', required — The current state of the managed cache add-on in the data-plane group. Possible values: - `initializing` - The add-on is in the process of being initialized/updated and is setting up necessary resources for this data-plane group. - `ready` - The add-on is fully operational for this data-plane group. - `error` - The add-on is in an error state, and is not operational for this data-plane group. - `terminating` - The add-on is in the process of being deleted for this data-plane group.
      - `state_metadata` object, required — Metadata describing the state of the managed cache add-on in the data-plane group.
        - `error_reason` string — Reason why the managed cache add-on may be in an error state, reported from backing infrastructure.
    - `state_metadata` object, required — Metadata describing the state of the managed cache add-on.
      - `cache_config_id` string, uuid — Reference to cache configuration for this add-on.
      - `cache_server_name` string — Env vault path to cache server name.
      - `cache_host` string — Env vault path to cache hostname.
      - `cache_port` string — Env vault path to cache port.
      - `cache_username` string — Env vault path to cache username.
      - `cloud_authentication` object — Metadata describing the cloud authentication details for managed cache add-on.
        - `auth_provider` string — Env vault path to cache auth provider.
        - `aws_cache_name` string — Env vault path to aws cache name.
        - `aws_region` string — Env vault path to aws region.
        - `aws_assume_role_arn` string — Env vault path to aws assume role arn.
        - `azure_tenant_id` string — Env vault path to azure tenant id.
  - `entity_version` integer, 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_at` string, date-time, required — RFC-3339 timestamp representation of add-on creation date.
  - `updated_at` string, date-time, required — RFC-3339 timestamp representation of add-on update date.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/kong/apis/konnect-api.md) · [All operations](https://skmtc.net/kong/apis/konnect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api/versions/06734a9c491f/schema)