---
title: "Konnect Cloud Gateways"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-dev-2/versions/ecf70889-e649-4a6a-8151-214a472a1044"
---

# Konnect Cloud Gateways

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"description":"Konnect API for managing cloud-gateways infrastructure.","version":"2.0.0","title":"Konnect Cloud Gateways","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"servers":[{"url":"https://global.api.konghq.com/v2","description":"Base URL for the global region"}],"paths":{"/cloud-gateways/networks":{"get":{"operationId":"list-networks","summary":"List Networks","description":"Returns a paginated list of networks.","parameters":[{"$ref":"#/components/parameters/NetworksFilter"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListNetworksResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Networks"]},"post":{"operationId":"create-network","summary":"Create Network","description":"Creates a new network for a given provider account.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNetworkRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateNetworkResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/CloudGatewaysForbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Networks"]}},"/cloud-gateways/networks/{networkId}":{"get":{"operationId":"get-network","summary":"Get Network","description":"Retrieves a network by ID.","parameters":[{"$ref":"#/components/parameters/NetworkId"}],"responses":{"200":{"$ref":"#/components/responses/RetrieveNetworkResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Networks"]},"patch":{"operationId":"update-network","summary":"Update Network","description":"Updates a network by ID.","parameters":[{"$ref":"#/components/parameters/NetworkId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchNetworkRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/PatchNetworkResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/CloudGatewaysForbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Networks"]}},"/cloud-gateways/default-resource-quotas":{"get":{"operationId":"list-default-resource-quotas","summary":"List Default Resource Quotas","description":"Returns a paginated collection of default resource quotas for cloud-gateways, along with\norganizationally-defined overrides for those resource quotas.\n","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListDefaultResourceQuotasResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Cloud Gateways Resource Quotas"]}},"/cloud-gateways/resource-quotas":{"get":{"operationId":"list-resource-quotas","summary":"List Resource Quotas","description":"Returns a paginated collection of resource quotas for an organization.\n","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListResourceQuotasResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Cloud Gateways Resource Quotas"]},"post":{"operationId":"create-resource-quota","summary":"Create Resource Quota","description":"Creates a new resource quota, scoped to a given resource, for an organization.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResourceQuotaRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateResourceQuotaResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Cloud Gateways Resource Quotas"]}},"/cloud-gateways/resource-quotas/{resourceQuotaId}":{"get":{"operationId":"get-resource-quota","summary":"Get Resource Quota","description":"Retrieves a resource quota by ID.","parameters":[{"$ref":"#/components/parameters/ResourceQuotaId"}],"responses":{"200":{"$ref":"#/components/responses/RetrieveResourceQuotaResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Cloud Gateways Resource Quotas"]},"patch":{"operationId":"update-resource-quota","summary":"Update Resource Quota","description":"Updates a resource quota by ID.","parameters":[{"$ref":"#/components/parameters/ResourceQuotaId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchResourceQuotaRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/PatchResourceQuotasResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Cloud Gateways Resource Quotas"]}},"/cloud-gateways/default-resource-configurations":{"get":{"operationId":"list-default-resource-configurations","summary":"List Default Resource Configurations","description":"Returns a paginated collection of default resource configurations for cloud-gateways, along with\norganizationally-defined overrides for those resource configurations.\nResource configurations are settings that are applied to all cloud gateway resources in an organization.\nFor example, the \"data-plane-group-idle-timeout-minutes\" resource configuration sets the idle timeout for all data plane groups in an organization.\n","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListDefaultResourceConfigurationsResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Resource Configurations"]}},"/cloud-gateways/resource-configurations":{"get":{"operationId":"list-resource-configurations","summary":"List Resource Configurations","description":"Returns a paginated collection of resource configurations for an organization.\nResource configurations are settings that are applied to all cloud gateway resources in an organization.\nFor example, the \"data-plane-group-idle-timeout-minutes\" resource configuration sets the idle timeout for all data plane groups in an organization.\n","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListResourceConfigurationsResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Resource Configurations"]},"post":{"operationId":"create-resource-configuration","summary":"Create Resource Configuration","description":"Creates a new resource configuration for an organization.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResourceConfigurationRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateResourceConfigurationResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Resource Configurations"]}},"/cloud-gateways/resource-configurations/{resourceConfigurationId}":{"get":{"operationId":"get-resource-configuration","summary":"Get Resource Configuration","description":"Retrieves a resource configuration by ID.","parameters":[{"$ref":"#/components/parameters/ResourceConfigurationId"}],"responses":{"200":{"$ref":"#/components/responses/RetrieveResourceConfigurationResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Resource Configurations"]},"patch":{"operationId":"update-resource-configuration","summary":"Update Resource Configuration","description":"Updates a resource configuration by ID.","parameters":[{"$ref":"#/components/parameters/ResourceConfigurationId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchResourceConfigurationRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/PatchResourceConfigurationsResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Resource Configurations"]}},"/cloud-gateways/add-ons/{addOnId}":{"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"}},"NetworkId":{"name":"networkId","in":"path","description":"The network to operate on.","required":true,"schema":{"$ref":"#/components/schemas/NetworkId"}},"NetworksFilter":{"name":"filter","description":"Filters supported for networks.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/NetworksFilterParameters"},"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}},"ResourceConfigurationId":{"name":"resourceConfigurationId","in":"path","description":"The ID of the resource configuration to operate on.","required":true,"schema":{"$ref":"#/components/schemas/ResourceConfigurationId"}},"ResourceQuotaId":{"name":"resourceQuotaId","in":"path","description":"The ID of the resource quota to operate on.","required":true,"schema":{"$ref":"#/components/schemas/ResourceQuotaId"}}},"schemas":{"NetworkId":{"description":"The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.","type":"string","format":"uuid","example":"36ae63d3-efd1-4bec-b246-62aa5d3f5695"},"ProviderAccountId":{"type":"string","format":"uuid","example":"929b2449-c69f-44c4-b6ad-9ecec6f811ae"},"ResourceQuotaId":{"type":"string","format":"uuid","example":"9678f205-49a1-47bb-82d9-d01cafa42a0d","readOnly":true},"DefaultResourceQuotaId":{"type":"string","format":"uuid","example":"cc504063-f3bb-4e09-8e32-bbcdbc5cd618","readOnly":true},"ResourceConfigurationId":{"type":"string","format":"uuid","example":"9678f205-49a1-47bb-82d9-d01cafa42a0d","readOnly":true},"DefaultResourceConfigurationId":{"type":"string","format":"uuid","example":"cc504063-f3bb-4e09-8e32-bbcdbc5cd618","readOnly":true},"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"},"ProviderRegionId":{"description":"Region ID for cloud provider region.","type":"string","example":"us-east-2","title":"Provider Region ID"},"ProviderName":{"description":"Name of cloud provider.","type":"string","example":"aws","enum":["aws","azure","gcp"],"title":"Provider Name"},"NetworkCreateState":{"description":"Initial state for creating a network.","type":"string","default":"initializing","enum":["initializing","offline"],"title":"Network Create State"},"NetworkState":{"description":"State of the network.","enum":["created","initializing","offline","ready","terminating","terminated"],"readOnly":true,"title":"Network State"},"NetworkStateMetadata":{"description":"Metadata describing the backing state of the network and why it may be in an erroneous state.\n","type":"object","properties":{"reported_status":{"description":"Reported status of the network from backing infrastructure.","type":"string","example":"INVALID"},"reason":{"description":"Reason why the network may be in an erroneous state, reported from backing infrastructure.\n","type":"string","example":"Network could not be deployed due to insufficient cloud provider compute instances.\n"}},"additionalProperties":false,"readOnly":true,"title":"Network State Metadata"},"NetworkFirewallConfig":{"description":"Firewall configuration for a network.","type":"object","properties":{"allowed_cidr_blocks":{"description":"List of allowed CIDR blocks to access a network.","type":"array","items":{"type":"string"},"example":["10.0.0.0/8"],"title":"Allowed CIDR Blocks"},"denied_cidr_blocks":{"description":"List of denied CIDR blocks to access a network.","type":"array","items":{"type":"string"},"example":["10.100.0.0/16"],"title":"Denied CIDR Blocks"}},"additionalProperties":false,"title":"Network Firewall Config"},"NetworkProviderMetadata":{"description":"Metadata describing attributes returned by cloud-provider for the network.","type":"object","properties":{"vpc_id":{"type":"string","title":"VPC ID"},"subnet_ids":{"type":"array","items":{"type":"string"},"title":"Subnet IDs"}},"additionalProperties":false,"readOnly":true,"title":"Network Provider Metadata"},"NetworkName":{"description":"Human-readable name of the network.","type":"string","example":"us-east-2 network","title":"Network Name"},"NetworkCIDRBlock":{"description":"CIDR block configuration for the network.","type":"string","example":"10.0.0.0/8","title":"Network CIDR Block"},"NetworkDDOSProtection":{"description":"Whether DDOS protection is enabled for the network.","type":"boolean","example":false,"title":"Network DDOS Protection"},"NetworkAvailabilityZones":{"description":"List of availability zones that the network is attached to.","type":"array","items":{"type":"string"},"example":["use2-az1","use2-az2","use2-az3"]},"Network":{"description":"Object containing information about a network to be used in configurations.","type":"object","properties":{"id":{"$ref":"#/components/schemas/NetworkId"},"name":{"$ref":"#/components/schemas/NetworkName"},"default":{"description":"Whether the network is a default network or not. Default networks are Networks that are created\nautomatically by Konnect when an organization is linked to a provider account.\n","type":"boolean","example":false},"cloud_gateway_provider_account_id":{"$ref":"#/components/schemas/ProviderAccountId"},"region":{"$ref":"#/components/schemas/ProviderRegionId"},"availability_zones":{"$ref":"#/components/schemas/NetworkAvailabilityZones"},"cidr_block":{"$ref":"#/components/schemas/NetworkCIDRBlock"},"firewall":{"$ref":"#/components/schemas/NetworkFirewallConfig"},"ddos_protection":{"$ref":"#/components/schemas/NetworkDDOSProtection"},"state":{"$ref":"#/components/schemas/NetworkState"},"state_metadata":{"$ref":"#/components/schemas/NetworkStateMetadata"},"provider_metadata":{"$ref":"#/components/schemas/NetworkProviderMetadata"},"transit_gateway_count":{"description":"The number of transit gateways attached to this network.","type":"integer","example":0,"readOnly":true},"configuration_reference_count":{"description":"The number of configurations that reference this network.","type":"integer","example":0,"readOnly":true},"entity_version":{"description":"Monotonically-increasing version count of the network, to indicate the order of updates to the network.\n","type":"integer","example":1,"readOnly":true},"created_at":{"description":"An RFC-3339 timestamp representation of network creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"updated_at":{"description":"An RFC-3339 timestamp representation of network update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"required":["id","name","default","cloud_gateway_provider_account_id","region","availability_zones","cidr_block","provider_metadata","state","transit_gateway_count","configuration_reference_count","entity_version","created_at","updated_at"],"title":"Network"},"CreateNetworkRequest":{"description":"Request schema for creating a network.","type":"object","properties":{"name":{"$ref":"#/components/schemas/NetworkName"},"cloud_gateway_provider_account_id":{"$ref":"#/components/schemas/ProviderAccountId"},"region":{"$ref":"#/components/schemas/ProviderRegionId"},"availability_zones":{"$ref":"#/components/schemas/NetworkAvailabilityZones"},"cidr_block":{"$ref":"#/components/schemas/NetworkCIDRBlock"},"firewall":{"$ref":"#/components/schemas/NetworkFirewallConfig"},"ddos_protection":{"$ref":"#/components/schemas/NetworkDDOSProtection"},"state":{"$ref":"#/components/schemas/NetworkCreateState"}},"additionalProperties":false,"required":["name","cloud_gateway_provider_account_id","region","availability_zones","cidr_block"],"title":"CreateNetworkRequest"},"PatchNetworkRequest":{"description":"Request schema for updating a network.","type":"object","properties":{"name":{"$ref":"#/components/schemas/NetworkName"},"firewall":{"$ref":"#/components/schemas/NetworkFirewallConfig"}},"additionalProperties":false,"title":"PatchNetworkRequest"},"ResourceQuotaQualifier":{"description":"Enumeration of resources available for quota enforcement.","type":"string","enum":["count/provider-accounts.per-provider","count/networks.not-offline","count/data-planes-estimate","count/serverless-data-planes-estimate","count/data-plane-groups-estimate"]},"ResourceQuotaName":{"description":"The human-readable name of this resource quota.","type":"string","example":"Active Networks","readOnly":true},"ResourceQuotaDescription":{"description":"A more verbose description of what this resource quota enforces.","type":"string","example":"Across the organization, the aggregate number of active networks cannot exceed this value.","readOnly":true},"ResourceQuotaValue":{"description":"The aggregate non-negative integer count of this resource that's allowed for the organization.\n","type":"integer","example":2,"minimum":0},"ResourceQuota":{"description":"Object containing information about a resource quota for an organization.","type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceQuotaId"},"resource":{"$ref":"#/components/schemas/ResourceQuotaQualifier"},"name":{"$ref":"#/components/schemas/ResourceQuotaName"},"description":{"$ref":"#/components/schemas/ResourceQuotaDescription"},"value":{"$ref":"#/components/schemas/ResourceQuotaValue"},"created_at":{"description":"An RFC-3339 timestamp representation of resource quota creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"updated_at":{"description":"An RFC-3339 timestamp representation of resource quota update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"required":["id","resource","name","description","value","created_at","updated_at"],"title":"Resource Quota"},"DefaultResourceQuota":{"description":"Object containing information about a default resource quota, and any organizational overrides.","type":"object","properties":{"id":{"$ref":"#/components/schemas/DefaultResourceQuotaId"},"resource":{"$ref":"#/components/schemas/ResourceQuotaQualifier"},"name":{"$ref":"#/components/schemas/ResourceQuotaName"},"description":{"$ref":"#/components/schemas/ResourceQuotaDescription"},"value":{"$ref":"#/components/schemas/ResourceQuotaValue"},"overrides":{"description":"Organizational overrides for this default resource quota.","type":"array","items":{"$ref":"#/components/schemas/ResourceQuota"}},"created_at":{"description":"An RFC-3339 timestamp representation of default resource quota creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"updated_at":{"description":"An RFC-3339 timestamp representation of default resource quota update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"required":["id","resource","name","description","value","overrides","created_at","updated_at"],"title":"Default Resource Quota"},"CreateResourceQuotaRequest":{"description":"Request schema for creating a resource quota for an organization.","type":"object","properties":{"resource":{"$ref":"#/components/schemas/ResourceQuotaQualifier"},"value":{"$ref":"#/components/schemas/ResourceQuotaValue"}},"additionalProperties":false,"required":["resource","value"],"title":"CreateResourceQuotaRequest"},"PatchResourceQuotaRequest":{"description":"Request schema for patching a resource quota for an organization.","type":"object","properties":{"value":{"$ref":"#/components/schemas/ResourceQuotaValue"}},"additionalProperties":false,"required":["value"],"title":"PatchResourceQuotaRequest"},"ResourceConfigurationQualifier":{"description":"Enumeration of configuration qualifiers available for organization-wide configuration.","type":"string","enum":["data-plane-group-idle-timeout-minutes","auto-pilot-base-rps-max-value"]},"ResourceConfigurationValue":{"description":"The value of this resource configuration.","type":"integer","example":45},"ResourceConfigurationName":{"description":"The human-readable name of this resource configuration.","type":"string","example":"Data Plane Group Idle Timeout Minutes","readOnly":true},"ResourceConfigurationDescription":{"description":"A more verbose description of what this resource configuration enforces.","type":"string","example":"The number of minutes that a data plane group can be idle before it is automatically scaled down to zero instances.","readOnly":true},"CreateResourceConfigurationRequest":{"description":"Request schema for creating a resource configuration for an organization.","type":"object","properties":{"qualifier":{"$ref":"#/components/schemas/ResourceConfigurationQualifier"},"value":{"$ref":"#/components/schemas/ResourceConfigurationValue"}},"additionalProperties":false,"required":["qualifier","value"],"title":"CreateResourceConfigurationRequest"},"PatchResourceConfigurationRequest":{"description":"Request schema for patching a resource configuration for an organization.","type":"object","properties":{"qualifier":{"$ref":"#/components/schemas/ResourceConfigurationQualifier"},"value":{"$ref":"#/components/schemas/ResourceConfigurationValue"}},"additionalProperties":false,"required":["qualifier","value"],"title":"PatchResourceConfigurationRequest"},"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"],"x-terraform-transform-const":true},"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/ProviderName"},"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"},"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"],"x-terraform-transform-const":true},"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"],"x-terraform-transform-const":true},"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"},"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"],"x-terraform-transform-const":true},"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"},"NetworksFilterParameters":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/CloudGatewaysStringFieldFilterOverride"},"state":{"$ref":"#/components/schemas/NetworkStateFieldFilter"}},"additionalProperties":false,"title":"NetworksFilterParameters"},"CloudGatewaysStringFieldFilterOverride":{"description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`","type":"object","properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"contains":{"description":"The field contains the provided value.","type":"string","example":"?filter[field_name_here][contains]=foo"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"ocontains":{"description":"The field contains any of the provided values.","type":"string","example":"?filter[field_name_here][ocontains]=foo,bar"}},"additionalProperties":false,"x-examples":{"example-1":{"contains":"some-value","neq":"not-this-value","oeq":"some-value,some-other-value","ocontains":"this-value,or-that-value"},"example-2":{"eq":"some-value"}}},"NetworkStateFieldFilter":{"description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`","type":"object","properties":{"eq":{"description":"The field exactly matches the provided value.","example":"?filter[field_name_here][eq]=foo","$ref":"#/components/schemas/NetworkState"},"neq":{"description":"The field does not match the provided value.","example":"?filter[field_name_here][neq]=bar","$ref":"#/components/schemas/NetworkState"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"}},"x-examples":{"example-1":{"neq":"ready","oeq":"ready,initializing"},"example-2":{"eq":"ready"}}},"ResourceConfiguration":{"description":"Object containing information about a resource configuration.","type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceConfigurationId"},"qualifier":{"$ref":"#/components/schemas/ResourceConfigurationQualifier"},"value":{"$ref":"#/components/schemas/ResourceConfigurationValue"}},"required":["id","qualifier","value"],"title":"Resource Configuration"},"DefaultResourceConfiguration":{"description":"Object containing information about a default resource configurations, and any organizational overrides.","type":"object","properties":{"id":{"$ref":"#/components/schemas/DefaultResourceConfigurationId"},"qualifier":{"$ref":"#/components/schemas/ResourceConfigurationQualifier"},"name":{"$ref":"#/components/schemas/ResourceConfigurationName"},"description":{"$ref":"#/components/schemas/ResourceConfigurationDescription"},"value":{"$ref":"#/components/schemas/ResourceConfigurationValue"},"overrides":{"description":"Organizational overrides for this default resource configuration.","type":"array","items":{"$ref":"#/components/schemas/ResourceConfiguration"}},"created_at":{"description":"An RFC-3339 timestamp representation of default resource configuration creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"updated_at":{"description":"An RFC-3339 timestamp representation of default resource configuration update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"required":["id","qualifier","name","description","value","overrides","created_at","updated_at"],"title":"Default Resource Configuration"},"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"}}}]}},"examples":{"PermissionDeniedExample":{"value":{"status":403,"title":"Forbidden","instance":"konnect:trace:2822394689570210664","detail":"You do not have permission to perform this action."}},"QuotaExceededExample":{"value":{"status":403,"title":"Quota Exceeded","instance":"konnect:trace:2822394689570210664","detail":"Maximum number of <quota name> exceeded. Max allowed: <quota value>."}},"NetworkNameLengthCheckBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"konnect:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"name","rule":"max_length","reason":"name must be shorter than or equal to 120 characters","maximum":120}]}},"TransitGatewayNameLengthCheckBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"konnect:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"name","rule":"max_length","reason":"name must be shorter than or equal to 120 characters","maximum":120}]}},"CustomDomainLengthCheckBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"konnect:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"domain","rule":"min_length","minimum":1,"reason":"domain must be longer than or equal to 1 characters"}]}},"ConfigurationApiAccessBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"konnect:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"api_access","rule":"enum","choices":["private","public","private+public"],"reason":"api_access must be one of the following values: private, public, private+public"}]}},"ConfigurationDataPlaneGroupStaticRequestedInstancesBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"konnect:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"dataplane_groups.0.autoscale.requested_instances","rule":"is_integer","reason":"dataplane_groups.0.autoscale.requested_instances must be an integer number"}]}},"ConfigurationDataPlaneGroupAutopilotBaseRpsBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"konnect:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"dataplane_groups.0.autoscale.base_rps","rule":"is_integer","reason":"dataplane_groups.0.autoscale.base_rps must be an integer number"}]}},"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"}]}},"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"ForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"responses":{"ListNetworksResponse":{"description":"A paginated list for a collection of networks.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Network"}}},"required":["meta","data"],"title":"ListNetworksResponse"}}}},"RetrieveNetworkResponse":{"description":"Response format for retrieving a network.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Network"}}}},"CreateNetworkResponse":{"description":"Response format for creating a network.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Network"}}}},"PatchNetworkResponse":{"description":"Response format for patching a network.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Network"}}}},"CreateResourceQuotaResponse":{"description":"Response format for creating a resource quota for an organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceQuota"}}}},"RetrieveResourceQuotaResponse":{"description":"Response format for retrieving a resource quota for an organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceQuota"}}}},"ListResourceQuotasResponse":{"description":"A paginated list for a collection of resource quotas.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceQuota"}}},"required":["meta","data"],"title":"ListResourceQuotasResponse"}}}},"ListDefaultResourceQuotasResponse":{"description":"A paginated list for a collection of default resource quotas.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DefaultResourceQuota"}}},"required":["meta","data"],"title":"ListDefaultResourceQuotasResponse"}}}},"PatchResourceQuotasResponse":{"description":"Response format for patching a resource quota for an organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceQuota"}}}},"CloudGatewaysBadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"Network Name Length Exceeded":{"$ref":"#/components/examples/NetworkNameLengthCheckBadRequestExample"},"Transit Gateway Name Length Exceeded":{"$ref":"#/components/examples/TransitGatewayNameLengthCheckBadRequestExample"},"Custom Domain Domain Length Too Short":{"$ref":"#/components/examples/CustomDomainLengthCheckBadRequestExample"},"Configuration Api Access Enum Validation":{"$ref":"#/components/examples/ConfigurationApiAccessBadRequestExample"},"Configuration Data-Plane Group Static Request Instances Minimum":{"$ref":"#/components/examples/ConfigurationDataPlaneGroupStaticRequestedInstancesBadRequestExample"},"Configuration Data-Plane Group Autopilot Base RPS Minimum":{"$ref":"#/components/examples/ConfigurationDataPlaneGroupAutopilotBaseRpsBadRequestExample"}}}}},"CloudGatewaysForbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"Permission Denied":{"$ref":"#/components/examples/PermissionDeniedExample"},"Quota Exceeded":{"$ref":"#/components/examples/QuotaExceededExample"}}}}},"ListDefaultResourceConfigurationsResponse":{"description":"A paginated list for a collection of default resource configurations.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DefaultResourceConfiguration"}}},"required":["meta","data"],"title":"ListDefaultResourceConfigurationsResponse"}}}},"ListResourceConfigurationsResponse":{"description":"A paginated list for a collection of resource configurations.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceConfiguration"}}},"required":["meta","data"],"title":"ListResourceConfigurationsResponse"}}}},"CreateResourceConfigurationResponse":{"description":"Response format for creating a resource configuration for an organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConfiguration"}}}},"RetrieveResourceConfigurationResponse":{"description":"Response format for retrieving a resource configuration for an organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConfiguration"}}}},"PatchResourceConfigurationsResponse":{"description":"Response format for patching a resource configuration for an organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConfiguration"}}}},"UpdateAddOnResponse":{"description":"Response format for updating an add-on.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOnResponse"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"Forbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/ForbiddenExample"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"Conflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}},"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":"Networks"},{"name":"Add-Ons"},{"name":"Cloud Gateways Resource Quotas"},{"name":"Resource Configurations"}],"security":[{"konnectAccessToken":[]},{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
