---
title: "Konnect Cloud Gateways"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-dev-2/versions/34323df8-534b-4175-a049-34445622158f"
---

# Konnect Cloud Gateways

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"description":"Konnect API for managing cloud-gateways infrastructure.","version":"3.0.0","title":"Konnect Cloud Gateways","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"servers":[{"url":"https://global.api.konghq.com/v3","description":"Base URL for the global region"}],"paths":{"/cloud-gateways/add-ons":{"post":{"operationId":"create-add-on","summary":"Create Add-On","description":"Creates a new add-on. Specific add-on types (e.g., managed cache)\nare defined by the sub-kind configuration.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAddOnRequest"},"examples":{"control-plane-owner":{"$ref":"#/components/examples/CreateAddOnControlPlaneOwnerExample"},"control-plane-group-owner":{"$ref":"#/components/examples/CreateAddOnControlPlaneGroupOwnerExample"}}}}},"responses":{"201":{"$ref":"#/components/responses/CreateAddOnResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"Cache Tier Unavailable":{"$ref":"#/components/examples/CreateAddOnCacheTierUnavailableBadRequestExample"},"Duplicate Add-On Kind":{"$ref":"#/components/examples/CreateAddOnDuplicateKindBadRequestExample"},"Invalid Control Plane ID":{"$ref":"#/components/examples/CreateAddOnInvalidControlPlaneIdBadRequestExample"},"Invalid Control Plane Group ID":{"$ref":"#/components/examples/CreateAddOnInvalidControlPlaneGroupIdBadRequestExample"},"Unsupported Cloud Provider":{"$ref":"#/components/examples/CreateAddOnUnsupportedProviderBadRequestExample"}}}}},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"Unauthorized":{"$ref":"#/components/examples/AddOnUnauthorizedExample"}}}}},"403":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"Forbidden":{"$ref":"#/components/examples/AddOnForbiddenExample"}}}}},"404":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"Add-On Functionality Not Available":{"$ref":"#/components/examples/CreateAddOnFunctionalityNotFoundExample"},"Control Plane Not Found":{"$ref":"#/components/examples/CreateAddOnControlPlaneNotFoundExample"}}}}},"409":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"Add-On Name Conflict":{"$ref":"#/components/examples/CreateAddOnNameConflictExample"}}}}}},"tags":["Add-Ons"]},"get":{"operationId":"list-add-ons","summary":"List Add-Ons","description":"Returns a paginated collection of add-ons for an organization.\n","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/AddOnsFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListAddOnsResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"Invalid Control Plane ID":{"$ref":"#/components/examples/ListAddOnsInvalidControlPlaneIdBadRequestExample"},"Invalid Control Plane Group ID":{"$ref":"#/components/examples/ListAddOnsInvalidControlPlaneGroupIdBadRequestExample"},"Invalid Control Plane Geo":{"$ref":"#/components/examples/ListAddOnsInvalidControlPlaneGeoBadRequestExample"},"Invalid Control Plane Group Geo":{"$ref":"#/components/examples/ListAddOnsInvalidControlPlaneGroupGeoBadRequestExample"}}}}},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"Unauthorized":{"$ref":"#/components/examples/AddOnUnauthorizedExample"}}}}},"403":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"Forbidden":{"$ref":"#/components/examples/AddOnForbiddenExample"}}}}}},"tags":["Add-Ons"]}},"/cloud-gateways/add-ons/{addOnId}":{"get":{"operationId":"get-add-on","summary":"Get Add-On","description":"Retrieves an add-on by ID.","parameters":[{"$ref":"#/components/parameters/AddOnId"}],"responses":{"200":{"$ref":"#/components/responses/RetrieveAddOnResponse"},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"Unauthorized":{"$ref":"#/components/examples/AddOnUnauthorizedExample"}}}}},"403":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"Forbidden":{"$ref":"#/components/examples/AddOnForbiddenExample"}}}}},"404":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"Not Found":{"$ref":"#/components/examples/AddOnNotFoundExample"}}}}}},"tags":["Add-Ons"]},"delete":{"operationId":"delete-add-on","summary":"Delete Add-On","description":"Deletes an add-on by ID. The request will be rejected if the managed cache partial is still in use by some plugins.\n","parameters":[{"$ref":"#/components/parameters/AddOnId"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"Linked Plugins Exist":{"$ref":"#/components/examples/DeleteAddOnLinkedPluginsBadRequestExample"}}}}},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"Unauthorized":{"$ref":"#/components/examples/AddOnUnauthorizedExample"}}}}},"403":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"Forbidden":{"$ref":"#/components/examples/AddOnForbiddenExample"}}}}},"404":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"Not Found":{"$ref":"#/components/examples/AddOnNotFoundExample"}}}}}},"tags":["Add-Ons"]},"patch":{"operationId":"update-add-on","summary":"Update Add-On","description":"Updates the configuration of an existing add-on.","parameters":[{"$ref":"#/components/parameters/AddOnId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAddOnRequest"},"examples":{"update-managed-cache-tier":{"$ref":"#/components/examples/UpdateAddOnManagedCacheTierExample"}}}}},"responses":{"200":{"$ref":"#/components/responses/UpdateAddOnResponse"},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"Cache Tier Unavailable":{"$ref":"#/components/examples/PatchAddOnTierUnavailableBadRequestExample"},"Identical Tier":{"$ref":"#/components/examples/PatchAddOnIdenticalTierBadRequestExample"},"Tier Downgrade Not Supported":{"$ref":"#/components/examples/PatchAddOnTierDowngradeBadRequestExample"}}}}},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"Unauthorized":{"$ref":"#/components/examples/AddOnUnauthorizedExample"}}}}},"403":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"Forbidden":{"$ref":"#/components/examples/AddOnForbiddenExample"}}}}},"404":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"Not Found":{"$ref":"#/components/examples/AddOnNotFoundExample"}}}}}},"tags":["Add-Ons"]}}},"components":{"parameters":{"AddOnId":{"name":"addOnId","description":"ID of the add-on to operate on.","required":true,"in":"path","schema":{"$ref":"#/components/schemas/AddOnId"}},"AddOnsFilter":{"name":"filter","description":"Filters supported for add-ons.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/AddOnsFilterParameters"},"style":"deepObject"},"PageNumber":{"name":"page[number]","description":"Determines which page of the entities to retrieve.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":1}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}}},"schemas":{"ControlPlaneGeo":{"description":"Set of control-plane geos supported for deploying cloud-gateways configurations.","type":"string","enum":["us","eu","au","me","in","sg"],"title":"Control-Plane Geo"},"CloudGatewaysProviderName":{"description":"Name of cloud provider.","type":"string","example":"aws","enum":["aws","azure","gcp"]},"ControlPlaneGeoFieldFilter":{"oneOf":[{"$ref":"#/components/schemas/ControlPlaneGeoFieldEqualsFilter"},{"$ref":"#/components/schemas/ControlPlaneGeoFieldNotEqualsFilter"},{"$ref":"#/components/schemas/ControlPlaneGeoFieldOrEqualityFilter"}],"title":"ControlPlaneGeoFieldFilter"},"ControlPlaneGeoFieldEqualsFilter":{"description":"Filter a control-plane geo by exact match.","oneOf":[{"$ref":"#/components/schemas/ControlPlaneGeo"},{"type":"object","title":"ControlPlaneGeoFieldEqualsComparison","properties":{"eq":{"$ref":"#/components/schemas/ControlPlaneGeo"}},"required":["eq"]}],"title":"ControlPlaneGeoFieldEqualsFilter","x-examples":{"example-1":"us","example-2":{"eq":"us"}}},"ControlPlaneGeoFieldNotEqualsFilter":{"description":"Filter a control-plane geo by inequality match.","type":"object","properties":{"neq":{"$ref":"#/components/schemas/ControlPlaneGeo"}},"required":["neq"],"title":"ControlPlaneGeoFieldNotEqualsFilter","x-examples":{"example-1":{"neq":"us"}}},"ControlPlaneGeoFieldOrEqualityFilter":{"description":"Filter a control-plane geo by determining if the value is equal to any in a set of values, where the set is a\ncomma-delimited list.\n","type":"object","properties":{"oeq":{"type":"string"}},"required":["oeq"],"title":"ControlPlaneGeoFieldOrEqualityFilter","x-examples":{"example-1":{"oeq":"us,eu"}}},"CloudGatewaysStringFieldFilterOverride":{"oneOf":[{"$ref":"#/components/schemas/CloudGatewaysStringFieldEqualsFilterOverride"},{"$ref":"#/components/schemas/StringFieldContainsFilter"},{"$ref":"#/components/schemas/StringFieldNEQFilter"},{"$ref":"#/components/schemas/StringFieldOEQFilter"},{"$ref":"#/components/schemas/StringFieldOContainsFilter"}],"title":"CloudGatewaysStringFieldFilterOverride"},"CloudGatewaysStringFieldEqualsFilterOverride":{"description":"Filters on the given string field value by exact match.","oneOf":[{"type":"string"},{"type":"object","title":"StringFieldEqualsComparison","additionalProperties":false,"properties":{"eq":{"type":"string"}},"required":["eq"]}],"title":"StringFieldEqualsFilter","x-examples":{"example-1":"equals-some-value","example-2":{"eq":"some-value"}}},"AddOnId":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","readOnly":true},"AddOnConfigResponse":{"description":"Configuration object for different types of add-ons.","type":"object","oneOf":[{"$ref":"#/components/schemas/ManagedCacheAddOnConfigResponse"}],"title":"AddOnConfigResponse"},"ManagedCacheAddOnConfigResponse":{"description":"Configuration for managed cache add-on.","type":"object","properties":{"kind":{"description":"Type of add-on configuration.","type":"string","enum":["managed-cache.v0"]},"capacity_config":{"$ref":"#/components/schemas/ManagedCacheCapacityConfig"},"data_plane_groups":{"description":"List of data-plane groups where the managed cache is deployed.","type":"array","items":{"$ref":"#/components/schemas/ManagedCacheAddOnDataPlaneGroup"}},"state_metadata":{"description":"Metadata describing the state of the managed cache add-on.\n","type":"object","additionalProperties":false,"properties":{"cache_config_id":{"description":"Reference to cache configuration for this add-on.","type":"string","format":"uuid","example":"edaf40f9-9fb0-4ffe-bb74-4e763a6bd471"},"cache_server_name":{"description":"Env vault path to cache server name.","type":"string","example":"{vault://env/ADDON_MANAGED_CACHE_SERVER_NAME}"},"cache_host":{"description":"Env vault path to cache hostname.","type":"string","example":"{vault://env/ADDON_MANAGED_CACHE_HOST}"},"cache_port":{"description":"Env vault path to cache port.","type":"string","example":"{vault://env/ADDON_MANAGED_CACHE_PORT}"},"cache_username":{"description":"Env vault path to cache username.","type":"string","example":"{vault://env/ADDON_MANAGED_CACHE_USERNAME}"},"cloud_authentication":{"description":"Metadata describing the cloud authentication details for managed cache add-on.\n","type":"object","additionalProperties":false,"properties":{"auth_provider":{"description":"Env vault path to cache auth provider.","type":"string","example":"{vault://env/ADDON_MANAGED_CACHE_AUTH_PROVIDER}"},"aws_cache_name":{"description":"Env vault path to aws cache name.","type":"string","example":"{vault://env/ADDON_MANAGED_CACHE_AWS_CACHE_NAME}"},"aws_region":{"description":"Env vault path to aws region.","type":"string","example":"{vault://env/ADDON_MANAGED_CACHE_AWS_REGION}"},"aws_assume_role_arn":{"description":"Env vault path to aws assume role arn.","type":"string","example":"{vault://env/ADDON_MANAGED_CACHE_AWS_ASSUME_ROLE_ARN}"},"azure_tenant_id":{"description":"Env vault path to azure tenant id.","type":"string","example":"{vault://env/ADDON_MANAGED_CACHE_AZURE_TENANT_ID}"}}}}}},"additionalProperties":false,"required":["kind","capacity_config","data_plane_groups","state_metadata"],"title":"ManagedCacheAddOnConfigResponse"},"ManagedCacheAddOnDataPlaneGroup":{"description":"Object that describes a data-plane group where managed cache add-on is deployed.","type":"object","properties":{"id":{"description":"ID of the data-plane group.","type":"string","format":"uuid","example":"1150820b-c69f-4a2a-b9be-bbcdbc5cd618"},"cloud_gateway_network_id":{"description":"Network ID this data-plane group is attached to.","type":"string","format":"uuid","example":"36ae63d3-efd1-4bec-b246-62aa5d3f5695"},"provider":{"$ref":"#/components/schemas/CloudGatewaysProviderName"},"region":{"description":"Region of cloud provider the data-plane group is deployed to.","type":"string","example":"us-east-1"},"state":{"description":"The current state of the managed cache add-on in the data-plane group. Possible values:\n- `initializing` - The add-on is in the process of being initialized/updated and is setting up necessary resources for this data-plane group.\n- `ready` - The add-on is fully operational for this data-plane group.\n- `error` - The add-on is in an error state, and is not operational for this data-plane group.\n- `terminating` - The add-on is in the process of being deleted for this data-plane group.\n","type":"string","enum":["initializing","ready","error","terminating"],"readOnly":true},"state_metadata":{"description":"Metadata describing the state of the managed cache add-on in the data-plane group.\n","type":"object","additionalProperties":false,"properties":{"error_reason":{"description":"Reason why the managed cache add-on may be in an error state, reported from backing infrastructure.\n","type":"string","example":"Failed to create managed cache add-on due to invalid configuration.\n"}}}},"additionalProperties":false,"required":["id","cloud_gateway_network_id","provider","region","state","state_metadata"],"title":"ManagedCacheAddOnDataPlaneGroup"},"AddOnState":{"description":"The current state of the add-on. Possible values:\n- `initializing` - The add-on is in the process of being initialized/updated.\n- `ready` - The add-on is fully operational.\n- `terminating` - The add-on is in the process of being deleted.\n","type":"string","enum":["initializing","ready","terminating"],"readOnly":true,"title":"Add-On State"},"AddOnResponse":{"description":"Object containing information about an add-on.","type":"object","properties":{"id":{"$ref":"#/components/schemas/AddOnId"},"name":{"$ref":"#/components/schemas/AddOnName"},"owner":{"$ref":"#/components/schemas/AddOnOwner"},"config":{"$ref":"#/components/schemas/AddOnConfigResponse"},"entity_version":{"description":"Monotonically-increasing version count of the add-on, to indicate the order of updates to the add-on.","type":"integer","example":1,"readOnly":true},"state":{"$ref":"#/components/schemas/AddOnState"},"created_at":{"description":"RFC-3339 timestamp representation of add-on creation date.","type":"string","format":"date-time","example":"2025-08-26T06:56:41Z","readOnly":true},"updated_at":{"description":"RFC-3339 timestamp representation of add-on update date.","type":"string","format":"date-time","example":"2025-08-26T06:56:41Z","readOnly":true}},"additionalProperties":false,"required":["id","name","owner","config","entity_version","state","created_at","updated_at"],"title":"AddOnResponse"},"CreateAddOnRequest":{"description":"Request schema for creating an add-on.","type":"object","properties":{"name":{"$ref":"#/components/schemas/AddOnName"},"owner":{"$ref":"#/components/schemas/AddOnOwner"},"config":{"$ref":"#/components/schemas/CreateAddOnConfig"}},"additionalProperties":false,"required":["name","owner","config"],"title":"CreateAddOnRequest"},"AddOnName":{"description":"Unique human-readable name of the add-on.","type":"string","example":"my-add-on","maxLength":70,"minLength":1,"title":"AddOnName"},"AddOnOwner":{"description":"Owner for the add-on.","type":"object","oneOf":[{"$ref":"#/components/schemas/ControlPlaneAddOnOwner"},{"$ref":"#/components/schemas/ControlPlaneGroupAddOnOwner"}],"title":"AddOnOwner"},"ControlPlaneAddOnOwner":{"description":"Control Plane is the owner for the add-on.","type":"object","properties":{"kind":{"description":"Type of owner for the add-on.","type":"string","enum":["control-plane"]},"control_plane_id":{"description":"ID of the control-plane that owns this add-on.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"control_plane_geo":{"$ref":"#/components/schemas/ControlPlaneGeo"}},"additionalProperties":false,"required":["kind","control_plane_id","control_plane_geo"],"title":"ControlPlaneAddOnOwner"},"ControlPlaneGroupAddOnOwner":{"description":"Control Plane Group is the owner for the add-on.","type":"object","properties":{"kind":{"description":"Type of owner for the add-on.","type":"string","enum":["control-plane-group"]},"control_plane_group_id":{"description":"ID of the control-plane group that owns this add-on.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"control_plane_group_geo":{"$ref":"#/components/schemas/ControlPlaneGeo"}},"additionalProperties":false,"required":["kind","control_plane_group_id","control_plane_group_geo"],"title":"ControlPlaneGroupAddOnOwner"},"CreateAddOnConfig":{"description":"Configuration for creating different types of add-ons.","type":"object","oneOf":[{"$ref":"#/components/schemas/CreateManagedCacheAddOnConfig"}],"title":"CreateAddOnConfig"},"CreateManagedCacheAddOnConfig":{"description":"Configuration for creating a managed cache add-on.","type":"object","properties":{"kind":{"description":"Type of add-on configuration.","type":"string","enum":["managed-cache.v0"]},"capacity_config":{"$ref":"#/components/schemas/ManagedCacheCapacityConfig"}},"additionalProperties":false,"required":["kind","capacity_config"],"title":"CreateManagedCacheAddOnConfig"},"UpdateAddOnRequest":{"description":"Request body for updating an add-on.","type":"object","properties":{"config":{"$ref":"#/components/schemas/UpdateAddOnConfig"}},"additionalProperties":false,"required":["config"],"title":"UpdateAddOnRequest"},"UpdateAddOnConfig":{"description":"Configuration for updating different types of add-ons.","type":"object","oneOf":[{"$ref":"#/components/schemas/UpdateManagedCacheAddOnConfig"}],"title":"UpdateAddOnConfig"},"UpdateManagedCacheAddOnConfig":{"description":"Configuration for updating a managed cache add-on.","type":"object","properties":{"kind":{"description":"Type of add-on configuration.","type":"string","enum":["managed-cache.v0"]},"capacity_config":{"$ref":"#/components/schemas/ManagedCacheCapacityConfig"}},"additionalProperties":false,"required":["kind","capacity_config"],"title":"UpdateManagedCacheAddOnConfig"},"ManagedCacheCapacityConfig":{"description":"Configuration for managed cache capacity and performance characteristics.","type":"object","oneOf":[{"$ref":"#/components/schemas/TieredCapacityConfig"}],"title":"ManagedCacheCapacityConfig"},"TieredCapacityConfig":{"description":"Capacity tiers with pre-configured size and performance characteristics.","type":"object","properties":{"kind":{"description":"Type of capacity configuration.","type":"string","enum":["tiered"]},"tier":{"description":"Capacity tier that determines both cache size and performance characteristics:\n- micro: ~0.5 GiB capacity\n- small: ~1 GiB capacity\n- medium: ~3 GiB capacity\n- large: ~6 GiB capacity\n- xlarge: ~12 GiB capacity\n- 2xlarge: ~25 GiB capacity\n- 4xlarge: ~52 GiB capacity\n- 8xlarge: ~100 GiB capacity\n- 12xlarge: ~150 GiB capacity\n- 16xlarge: ~200 GiB capacity\n- 24xlarge: ~300 GiB capacity\n","type":"string","enum":["micro","small","medium","large","xlarge","2xlarge","4xlarge","8xlarge","12xlarge","16xlarge","24xlarge"]}},"example":{"kind":"tiered","tier":"small"},"additionalProperties":false,"required":["kind","tier"],"title":"TieredCapacityConfig"},"AddOnsFilterParameters":{"description":"Filter parameters for add-ons list operation.","type":"object","properties":{"name":{"$ref":"#/components/schemas/CloudGatewaysStringFieldFilterOverride"},"state":{"$ref":"#/components/schemas/AddOnStateFieldFilter"},"config.kind":{"$ref":"#/components/schemas/AddOnConfigKindFieldFilter"},"owner.control_plane_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"owner.control_plane_geo":{"$ref":"#/components/schemas/ControlPlaneGeoFieldFilter"},"owner.control_plane_group_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"owner.control_plane_group_geo":{"$ref":"#/components/schemas/ControlPlaneGeoFieldFilter"}},"additionalProperties":false,"title":"Add-Ons Filter Parameters"},"AddOnStateFieldFilter":{"oneOf":[{"$ref":"#/components/schemas/AddOnStateFieldEqualsFilter"},{"$ref":"#/components/schemas/AddOnStateFieldNotEqualsFilter"},{"$ref":"#/components/schemas/AddOnStateFieldOrEqualityFilter"}],"title":"AddOnStateFieldFilter"},"AddOnStateFieldEqualsFilter":{"description":"Filter add-on state by exact match.","oneOf":[{"$ref":"#/components/schemas/AddOnState"},{"$ref":"#/components/schemas/AddOnStateFieldEqualsComparison"}],"title":"AddOnStateFieldEqualsFilter","x-examples":{"example-1":"ready","example-2":{"eq":"ready"}}},"AddOnStateFieldEqualsComparison":{"type":"object","properties":{"eq":{"$ref":"#/components/schemas/AddOnState"}},"additionalProperties":false,"required":["eq"],"title":"AddOnStateFieldEqualsComparison"},"AddOnStateFieldNotEqualsFilter":{"description":"Filter add-on state by inequality match.","type":"object","properties":{"neq":{"$ref":"#/components/schemas/AddOnState"}},"additionalProperties":false,"required":["neq"],"title":"AddOnStateFieldNotEqualsFilter","x-examples":{"example-1":{"neq":"ready"}}},"AddOnStateFieldOrEqualityFilter":{"description":"Filter add-on state by determining if the value is equal to any in a set of values, where the set is a comma-delimited list.\n","type":"object","properties":{"oeq":{"type":"string"}},"additionalProperties":false,"required":["oeq"],"title":"AddOnStateFieldOrEqualityFilter","x-examples":{"example-1":{"oeq":"ready,initializing"}}},"AddOnConfigKindFieldFilter":{"description":"Filter for add-on config kind field.","oneOf":[{"$ref":"#/components/schemas/AddOnConfigKindFieldEqualsFilter"},{"$ref":"#/components/schemas/AddOnConfigKindFieldNotEqualsFilter"},{"$ref":"#/components/schemas/AddOnConfigKindFieldOrEqualityFilter"}],"title":"Add-On Config Kind Field Filter"},"AddOnConfigKindFieldEqualsFilter":{"description":"Filter add-on config kind by exact match.","oneOf":[{"$ref":"#/components/schemas/AddOnConfigKind"},{"$ref":"#/components/schemas/AddOnConfigKindFieldEqualsComparison"}],"title":"Add-On Config Kind Field Equals Filter"},"AddOnConfigKindFieldEqualsComparison":{"type":"object","properties":{"eq":{"$ref":"#/components/schemas/AddOnConfigKind"}},"additionalProperties":false,"required":["eq"],"title":"AddOnConfigKindFieldEqualsComparison"},"AddOnConfigKindFieldNotEqualsFilter":{"description":"Filter add-on config kind by inequality match.","type":"object","properties":{"neq":{"$ref":"#/components/schemas/AddOnConfigKind"}},"additionalProperties":false,"required":["neq"],"title":"Add-On Config Kind Field Not Equals Filter"},"AddOnConfigKindFieldOrEqualityFilter":{"description":"Filter add-on config kind by determining if the value is equal to any in a set of values.","type":"object","properties":{"oeq":{"description":"Comma-delimited list of add-on kinds.","type":"string"}},"additionalProperties":false,"required":["oeq"],"title":"Add-On Config Kind Field Or Equality Filter"},"AddOnConfigKind":{"description":"Type of add-on config.","type":"string","enum":["managed-cache.v0"],"title":"Add-On Config Kind"},"StringFieldEqualsFilter":{"description":"Filters on the given string field value by exact match.","oneOf":[{"type":"string"},{"type":"object","title":"StringFieldEqualsComparison","additionalProperties":false,"properties":{"eq":{"type":"string"}},"required":["eq"]}],"title":"StringFieldEqualsFilter","x-examples":{"example-1":"equals-some-value","example-2":{"eq":"some-value"}}},"StringFieldOEQFilter":{"description":"Returns entities that exact match any of the comma-delimited phrases in the filter string.","type":"object","properties":{"oeq":{"type":"string"}},"additionalProperties":false,"required":["oeq"],"title":"StringFieldOEQFilter","x-examples":{"example-1":{"oeq":"some-value,some-other-value"}}},"StringFieldNEQFilter":{"description":"Filters on the given string field value by exact match inequality.","type":"object","properties":{"neq":{"type":"string"}},"additionalProperties":false,"required":["neq"],"title":"StringFieldNEQFilter","x-examples":{"example-1":{"neq":"not-this-value"}}},"UuidFieldFilter":{"description":"Filters on the given UUID field value by exact match.","oneOf":[{"$ref":"#/components/schemas/StringFieldEqualsFilter"},{"$ref":"#/components/schemas/StringFieldOEQFilter"},{"$ref":"#/components/schemas/StringFieldNEQFilter"}],"title":"UuidFieldFilter","x-examples":{"example-1":"3bbfd3a-e9ab-48a9-9881-ed589e4615d1","example-2":{"eq":"3bbfd3a-e9ab-48a9-9881-ed589e4615d1"},"example-3":{"oeq":"3bbfd3a-e9ab-48a9-9881-ed589e4615d1"},"example-4":{"neq":"3bbfd3a-e9ab-48a9-9881-ed589e4615d1"}}},"PageMeta":{"description":"Contains pagination query parameters and the total number of objects returned.","type":"object","properties":{"number":{"type":"number","example":1},"size":{"type":"number","example":10},"total":{"type":"number","example":100}},"required":["number","size","total"]},"PaginatedMeta":{"description":"returns the pagination information","type":"object","properties":{"page":{"$ref":"#/components/schemas/PageMeta"}},"required":["page"],"title":"PaginatedMeta"},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"ConflictError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":409},"title":{"example":"Conflict"},"type":{"example":"https://httpstatuses.com/409"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Conflict"}}}]},"StringFieldContainsFilter":{"description":"Filters on the given string field value by fuzzy match.","type":"object","properties":{"contains":{"type":"string"}},"additionalProperties":false,"required":["contains"],"title":"StringFieldContainsFilter","x-examples":{"example-1":{"contains":"some-value"}}},"StringFieldOContainsFilter":{"description":"Returns entities that fuzzy-match any of the comma-delimited phrases in the filter string.","type":"object","properties":{"ocontains":{"type":"string"}},"additionalProperties":false,"required":["ocontains"],"title":"StringFieldOContainsFilter","x-examples":{"example-1":{"ocontains":"this-value,or-that-value"}}}},"examples":{"CreateAddOnControlPlaneOwnerExample":{"summary":"Create a managed cache add-on owned by a control plane","value":{"name":"my-cache-add-on","owner":{"kind":"control-plane","control_plane_id":"123e4567-e89b-12d3-a456-426614174000","control_plane_geo":"us"},"config":{"kind":"managed-cache.v0","capacity_config":{"kind":"tiered","tier":"small"}}}},"CreateAddOnControlPlaneGroupOwnerExample":{"summary":"Create a managed cache add-on owned by a control plane group","value":{"name":"my-cache-add-on-group","owner":{"kind":"control-plane-group","control_plane_group_id":"123e4567-e89b-12d3-a456-426614174001","control_plane_group_geo":"us"},"config":{"kind":"managed-cache.v0","capacity_config":{"kind":"tiered","tier":"small"}}}},"ListAddOnsInvalidControlPlaneIdBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:3847291650183746291","detail":"Invalid Parameters","invalid_parameters":[{"field":"filter[owner.control_plane_id][oeq]","rule":"is_uuid","reason":"\"filter[owner.control_plane_id][oeq]\" must be a valid GUID","source":"query"}]}},"ListAddOnsInvalidControlPlaneGroupIdBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:5920384716482910573","detail":"Invalid Parameters","invalid_parameters":[{"field":"filter[owner.control_plane_group_id][oeq]","rule":"is_uuid","reason":"\"filter[owner.control_plane_group_id][oeq]\" must be a valid GUID","source":"query"}]}},"ListAddOnsInvalidControlPlaneGeoBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:7163849025716384920","detail":"Invalid Parameters","invalid_parameters":[{"field":"filter[owner.control_plane_geo][neq]","rule":"enum","reason":"\"filter[owner.control_plane_geo][neq]\" must be one of [us, eu, au, me, in, sg]","source":"query","choices":["us","eu","au","me","in","sg"]}]}},"ListAddOnsInvalidControlPlaneGroupGeoBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:9284736150294837561","detail":"Invalid Parameters","invalid_parameters":[{"field":"filter[owner.control_plane_group_geo][neq]","rule":"enum","reason":"\"filter[owner.control_plane_group_geo][neq]\" must be one of [us, eu, au, me, in, sg]","source":"query","choices":["us","eu","au","me","in","sg"]}]}},"DeleteAddOnLinkedPluginsBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:16584985546322141095","detail":"Invalid Parameters","invalid_parameters":[{"field":"id","rule":"invalid","reason":"Managed cache add-on has 1 linked plugin(s) that must be removed before deletion. Cache config ID: '301e4655-96bd-48f8-ae65-2ce2c2459f90'.","source":"path"}]}},"CreateAddOnCacheTierUnavailableBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"config.capacity_config.tier","rule":"invalid","reason":"Cache tier 'medium' is not available.","source":"body"}]}},"CreateAddOnDuplicateKindBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"owner.control_plane_group_id","rule":"invalid","reason":"Control plane group '43f05344-681f-4881-ac29-9a46c544fb81' already has an add-on of kind 'managed-cache.v0'. Only one add-on of a kind is allowed per control plane group.","source":"body"}]}},"CreateAddOnInvalidControlPlaneIdBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:12395978209700448850","detail":"Invalid Parameters","invalid_parameters":[{"field":"owner.control_plane_id","rule":"is_uuid","source":"body","reason":"control_plane_id must be a UUID"}]}},"CreateAddOnInvalidControlPlaneGroupIdBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:14582039471628394750","detail":"Invalid Parameters","invalid_parameters":[{"field":"owner.control_plane_group_id","rule":"is_uuid","source":"body","reason":"control_plane_group_id must be a UUID"}]}},"CreateAddOnUnsupportedProviderBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"owner","rule":"invalid","reason":"Data plane group with ID '43f05344-681f-4881-ac29-9a46c544fb81' has unsupported provider 'gcp'. Provider is not supported for managed cache add-ons.","source":"body"}]}},"CreateAddOnFunctionalityNotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:16702783886103429947","detail":"Add-on functionality is not available"}},"CreateAddOnControlPlaneNotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:1195136281317684685","detail":"Invalid owner: Control plane '123e4567-e89b-12d3-a456-426614174000' not found in geo 'us'"}},"CreateAddOnNameConflictExample":{"value":{"status":409,"title":"Conflict","instance":"kong:trace:8358517352623967169","detail":"Add on property 'name' must be unique per org."}},"AddOnNotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:3180784359748741888","detail":"The requested resource was not found."}},"AddOnUnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:9108763905133773926","detail":"You must be authenticated to perform this action."}},"AddOnForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2909730654778726250","detail":"You do not have permission to perform this action."}},"UpdateAddOnManagedCacheTierExample":{"summary":"Update managed cache add-on tier","value":{"config":{"kind":"managed-cache.v0","capacity_config":{"kind":"tiered","tier":"large"}}}},"PatchAddOnTierUnavailableBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"config.capacity_config.tier","rule":"invalid","reason":"Cache tier 'medium' is not available. Available tiers: micro, small. Please contact support or sales to select larger sizes.","source":"body"}]}},"PatchAddOnIdenticalTierBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"config.capacity_config.tier","rule":"invalid","reason":"Proposed tier is identical to existing tier","source":"body"}]}},"PatchAddOnTierDowngradeBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"config.capacity_config.tier","rule":"invalid","reason":"Cache tier downgrade is not supported","source":"body"}]}}},"responses":{"ListAddOnsResponse":{"description":"A paginated list for a collection of add-ons.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AddOnResponse"}}},"required":["meta","data"],"title":"ListAddOnsResponse"}}}},"CreateAddOnResponse":{"description":"Response format for creating an add-on.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOnResponse"}}}},"RetrieveAddOnResponse":{"description":"Response format for retrieving an add-on by ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOnResponse"}}}},"UpdateAddOnResponse":{"description":"Response format for updating an add-on.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOnResponse"}}}}},"securitySchemes":{"konnectAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.\n"},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/account/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n"},"systemAccountAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The system account access token is meant for automations and integrations that are not directly associated with a human identity.\nYou can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.\nThe access token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'`\n"}}},"tags":[{"name":"Add-Ons"}],"security":[{"konnectAccessToken":[]},{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
