---
title: "Konnect Cloud Gateways"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b"
---

# 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/availability.json":{"get":{"operationId":"get-availability-json","summary":"Get Resource Availability JSON","description":"Get Cloud Gateways Availability JSON document for describing cloud provider and region availability, pricing,\ngateway version availability, and instance type information.\n","responses":{"200":{"$ref":"#/components/responses/RetrieveCloudGatewaysAvailabilityDocumentResponse"}},"security":[],"tags":["Resource Availability"]}},"/cloud-gateways/configurations":{"get":{"operationId":"list-configurations","summary":"List Configurations","description":"Returns a paginated collection of configurations across control-planes for an organization (restricted by\npermitted control-plane reads).\n","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ConfigurationsFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListConfigurationsResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Data-Plane Group Configurations"]},"put":{"operationId":"create-configuration","summary":"Create Configuration","description":"Creates a new configuration for a control-plane (restricted by permitted control-plane permissions for\nconfigurations). This request will replace any existing configuration for the requested control_plane_id and\ncontrol_plane_geo by performing a diff. From this diff, new resources detected in the requested configuration\nwill be added, resources not found in the request configuration but in the previous will be deleted, and\nresources found in both will be updated to the requested configuration. Networks referenced in this request that\nare in an offline state will automatically initialize (i.e. move to an initializing state).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConfigurationRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/CreateConfigurationResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/CloudGatewaysForbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/CloudGatewaysConflict"}},"tags":["Data-Plane Group Configurations"]}},"/cloud-gateways/configurations/{configurationId}":{"get":{"operationId":"get-configuration","summary":"Get Configuration","description":"Retrieves a configuration by ID (restricted by permitted control-plane read).","parameters":[{"$ref":"#/components/parameters/ConfigurationId"}],"responses":{"200":{"$ref":"#/components/responses/RetrieveConfigurationResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Data-Plane Group Configurations"]}},"/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"]},"delete":{"operationId":"delete-network","summary":"Delete Network","description":"Deletes a network by ID.","parameters":[{"$ref":"#/components/parameters/NetworkId"}],"responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Networks"]}},"/cloud-gateways/networks/{networkId}/transit-gateways":{"get":{"operationId":"list-transit-gateways","summary":"List Transit Gateways","description":"Returns a paginated collection of transit gateways for a given network.","parameters":[{"$ref":"#/components/parameters/NetworkId"},{"$ref":"#/components/parameters/TransitGatewaysFilter"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListTransitGatewaysResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Transit Gateways"]},"post":{"operationId":"create-transit-gateway","summary":"Create Transit Gateway","description":"Creates a new transit gateway for a given network.","parameters":[{"$ref":"#/components/parameters/NetworkId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransitGatewayRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateTransitGatewayResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Transit Gateways"]}},"/cloud-gateways/networks/{networkId}/transit-gateways/{transitGatewayId}":{"get":{"operationId":"get-transit-gateway","summary":"Get Transit Gateway","description":"Retrieves a transit gateway by ID for a given network.","parameters":[{"$ref":"#/components/parameters/NetworkId"},{"$ref":"#/components/parameters/TransitGatewayId"}],"responses":{"200":{"$ref":"#/components/responses/RetrieveTransitGatewayResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Transit Gateways"]},"patch":{"operationId":"update-transit-gateway","summary":"Update Transit Gateway","description":"Updates a transit gateway by ID for a given network.","parameters":[{"$ref":"#/components/parameters/NetworkId"},{"$ref":"#/components/parameters/TransitGatewayId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchTransitGatewayRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/PatchTransitGatewayResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Transit Gateways"]},"delete":{"operationId":"delete-transit-gateway","summary":"Delete Transit Gateway","description":"Deletes a transit gateway by ID for a given network.","parameters":[{"$ref":"#/components/parameters/NetworkId"},{"$ref":"#/components/parameters/TransitGatewayId"}],"responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Transit Gateways"]}},"/cloud-gateways/networks/{networkId}/private-dns":{"get":{"operationId":"list-private-dns","summary":"List Private DNS","description":"Returns a paginated collection of Private DNS for a given network.","parameters":[{"$ref":"#/components/parameters/NetworkId"},{"$ref":"#/components/parameters/PrivateDnsFilter"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListPrivateDnsResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Private DNS"]},"post":{"operationId":"create-private-dns","summary":"Create Private DNS","description":"Creates a new Private DNS for a given network.","parameters":[{"$ref":"#/components/parameters/NetworkId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePrivateDnsRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreatePrivateDnsResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Private DNS"]}},"/cloud-gateways/networks/{networkId}/private-dns/{privateDnsId}":{"get":{"operationId":"get-private-dns","summary":"Get Private DNS","description":"Retrieves a Private DNS by ID for a given network.","parameters":[{"$ref":"#/components/parameters/NetworkId"},{"$ref":"#/components/parameters/PrivateDnsId"}],"responses":{"200":{"$ref":"#/components/responses/RetrievePrivateDnsResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Private DNS"]},"patch":{"operationId":"update-private-dns","summary":"Update Private DNS","description":"Updates a Private DNS by ID for a given network.","parameters":[{"$ref":"#/components/parameters/NetworkId"},{"$ref":"#/components/parameters/PrivateDnsId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchPrivateDnsRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/PatchPrivateDnsResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Private DNS"]},"delete":{"operationId":"delete-private-dns","summary":"Delete Private DNS","description":"Deletes a Private DNS by ID for a given network.","parameters":[{"$ref":"#/components/parameters/NetworkId"},{"$ref":"#/components/parameters/PrivateDnsId"}],"responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Private DNS"]}},"/cloud-gateways/networks/{networkId}/configuration-references":{"get":{"operationId":"list-network-configurations","summary":"List Network Configuration References","description":"Returns a paginated collection of configurations that reference a network.\n","parameters":[{"$ref":"#/components/parameters/NetworkId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListNetworkConfigurationReferencesResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Networks"]}},"/cloud-gateways/provider-accounts":{"get":{"operationId":"list-provider-accounts","summary":"List Provider Accounts","description":"Returns a a paginated collection of provider accounts for an organization.","parameters":[{"$ref":"#/components/parameters/ProviderAccountsFilter"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListProviderAccountsResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Provider Accounts"]}},"/cloud-gateways/provider-accounts/{providerAccountId}":{"get":{"operationId":"get-provider-account","summary":"Get Provider Account","description":"Retrieves a provider account by ID.","parameters":[{"$ref":"#/components/parameters/ProviderAccountId"}],"responses":{"200":{"$ref":"#/components/responses/RetrieveProviderAccountResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Provider Accounts"]}},"/cloud-gateways/custom-domains":{"get":{"operationId":"list-custom-domains","summary":"List Custom Domains","description":"Returns a paginated collection of custom domains across control-planes for an organization (restricted by\npermitted control-plane reads).\n","parameters":[{"$ref":"#/components/parameters/CustomDomainsFilter"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListCustomDomainsResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Custom Domains"]},"post":{"operationId":"create-custom-domains","summary":"Create Custom Domain","description":"Creates a new custom domain for a control-plane (restricted by permitted control-plane associate-custom-domain\naction).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomDomainRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateCustomDomainResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Custom Domains"]}},"/cloud-gateways/custom-domains/{customDomainId}":{"get":{"operationId":"get-custom-domain","summary":"Get Custom Domain","description":"Retrieves a custom domain by ID (restricted by permitted control-plane reads).","parameters":[{"$ref":"#/components/parameters/CustomDomainId"}],"responses":{"200":{"$ref":"#/components/responses/RetrieveCustomDomainResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Custom Domains"]},"delete":{"operationId":"delete-custom-domain","summary":"Delete Custom Domain","description":"Deletes a custom domain by ID (restricted by permitted control-plane reads).","parameters":[{"$ref":"#/components/parameters/CustomDomainId"}],"responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Custom Domains"]}},"/cloud-gateways/custom-domains/{customDomainId}/online-status":{"get":{"operationId":"get-custom-domain-online-status","summary":"Get Custom Domain Online Status","description":"Retrieves the CNAME and SSL status of a custom domain.","parameters":[{"$ref":"#/components/parameters/CustomDomainId"}],"responses":{"200":{"$ref":"#/components/responses/RetrieveCustomDomainOnlineStatusResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Custom Domains"]}},"/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"]}},"/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"]}},"/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"]}},"/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"]}},"/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"]}}},"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"},"ConfigurationId":{"name":"configurationId","in":"path","description":"The ID of the configuration to operate on.","required":true,"schema":{"$ref":"#/components/schemas/ConfigurationId"}},"ConfigurationsFilter":{"name":"filter","description":"Filters supported for configurations.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ConfigurationsFilterParameters"},"style":"deepObject"},"CustomDomainId":{"name":"customDomainId","description":"ID of the custom domain to operate on.","required":true,"in":"path","schema":{"$ref":"#/components/schemas/CustomDomainId"}},"CustomDomainsFilter":{"name":"filter","description":"Filters supported for custom domains on the global API.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/CustomDomainsFilterParameters"},"style":"deepObject"},"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}},"PrivateDnsFilter":{"name":"filter","description":"Filters supported for Private DNS.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/PrivateDnsFilterParameters"},"style":"deepObject"},"PrivateDnsId":{"name":"privateDnsId","in":"path","description":"The ID of the Private DNS to operate on.","required":true,"schema":{"$ref":"#/components/schemas/PrivateDnsId"}},"ProviderAccountId":{"name":"providerAccountId","in":"path","description":"The ID of the provider account to operate on.","required":true,"schema":{"$ref":"#/components/schemas/ProviderAccountId"}},"ProviderAccountsFilter":{"name":"filter","description":"Filters supported for provider accounts.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ProviderAccountsFilterParameters"},"style":"deepObject"},"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"}},"TransitGatewayId":{"name":"transitGatewayId","in":"path","description":"The ID of the transit gateway to operate on.","required":true,"schema":{"$ref":"#/components/schemas/TransitGatewayId"}},"TransitGatewaysFilter":{"name":"filter","description":"Filters supported for transit gateways.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/TransitGatewaysFilterParameters"},"style":"deepObject"}},"schemas":{"ControlPlaneId":{"type":"string","format":"uuid","example":"0949471e-b759-45ba-87ab-ee63fb781388"},"ConfigurationId":{"type":"string","format":"uuid","example":"edaf40f9-9fb0-4ffe-bb74-4e763a6bd471","readOnly":true},"DataPlaneGroupId":{"description":"ID of the data-plane group that represents a deployment target for a set of data-planes.","type":"string","format":"uuid","example":"cbb8872a-1f83-4806-bf69-fdf0b4783c7e","readOnly":true},"CustomDomainId":{"type":"string","format":"uuid","example":"39ed3790-085d-4605-9627-f96d86aaf425","readOnly":true},"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"},"TransitGatewayId":{"type":"string","format":"uuid","example":"0850820b-d153-4a2a-b9be-7d2204779139","readOnly":true},"PrivateDnsId":{"type":"string","format":"uuid","example":"1850820b-c69f-4a2a-b9be-bbcdbc5cd618","readOnly":true},"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"},"GatewayVersion":{"description":"Supported gateway version. For serverless.v1 kind of cloud gateways, this field should be omitted.","type":"string","example":"3.2","title":"Gateway Version"},"VersionList":{"description":"List of supported gateway versions for cloud gateways.","type":"array","items":{"$ref":"#/components/schemas/GatewayVersion"},"readOnly":true,"title":"Version List"},"InstanceTypeName":{"description":"Instance type name to indicate capacity.","type":"string","enum":["small","medium","large"]},"ApiAccess":{"description":"Type of API access data-plane groups will support for a configuration.","type":"string","example":"private+public","default":"private+public","enum":["private","public","private+public"]},"InstanceType":{"description":"Resource parameters and pricing of a given supported instance type.","type":"object","properties":{"name":{"$ref":"#/components/schemas/InstanceTypeName"},"hourly_cost":{"description":"Hourly cost to run a single cloud gateway instance of this instance type.","type":"string","format":"^(\\d)+(\\.(\\d)+)?$","example":"1.00"},"v_cpu":{"description":"Number of virtual CPUs available to a cloud gateway instance of this instance type.","type":"string","format":"^(\\d)+","example":"2"},"gb_memory":{"description":"Number of gigabytes of memory available to a cloud gateway instance of this instance type.","type":"string","format":"^(\\d)+","example":"2"}},"additionalProperties":false,"readOnly":true,"required":["name","hourly_cost","v_cpu","gb_memory"],"title":"Instance Type"},"InstanceTypes":{"description":"List of supported instance types, along with their associated resource parameters and pricing.","type":"array","items":{"$ref":"#/components/schemas/InstanceType"},"title":"Instance Types"},"ProviderRegionName":{"description":"Human-readable name for cloud provider region. The list of available provider regions can be retrieved via the\navailability endpoint `/v2/cloud-gateways/availability.json`.\n","type":"string","example":"N. Virginia","title":"Provider Region Name"},"ProviderRegionId":{"description":"Region ID for cloud provider region.","type":"string","example":"us-east-2","title":"Provider Region ID"},"ServerlessV1ProviderRegionId":{"description":"Region ID for serverless v1 cloud provider region.","type":"string","example":"us","title":"Serverless V1 Provider Region ID"},"ProviderRegion":{"description":"Region ID and human-readable name for a cloud provider region.","type":"object","properties":{"region":{"$ref":"#/components/schemas/ProviderRegionId"},"name":{"$ref":"#/components/schemas/ProviderRegionName"},"availability_zones":{"description":"List of supported availability zones for cloud provider region, for network AZ configuration.\n","type":"array","items":{"type":"string"},"example":["use2-az1","use2-az2","use2-az3"]},"cidr_blocks":{"description":"List of supported CIDR blocks for cloud provider region, for network CIDR block configuration.\n","type":"array","items":{"type":"string"},"example":["10.0.0.0/8","100.64.0.0/10","172.16.0.0/12","192.168.0.0/16","198.18.0.0/15"]},"reserved_cidr_blocks":{"description":"List of reserved CIDR blocks for cloud provider region, to restrict allowed network CIDR block\nconfiguration.\n","type":"array","items":{"type":"string"},"example":["10.100.0.0/16","172.17.0.0/16"]}},"additionalProperties":false,"required":["region","name","availability_zones","cidr_blocks","reserved_cidr_blocks"],"title":"Provider Region"},"ServerlessV1ProviderRegion":{"description":"Region ID and human-readable name for a cloud provider region.","type":"object","properties":{"region":{"$ref":"#/components/schemas/ServerlessV1ProviderRegionId"}},"additionalProperties":false,"required":["region"],"title":"Serverless V1 Provider Region"},"ProviderRegions":{"description":"List of available regions to run cloud gateway instances on for a given cloud provider.","type":"array","items":{"$ref":"#/components/schemas/ProviderRegion"},"title":"Provider Regions"},"ServerlessV1ProviderRegions":{"description":"List of available regions to run serverless v1 cloud gateway instances on for a given cloud provider.","type":"array","items":{"$ref":"#/components/schemas/ServerlessV1ProviderRegion"},"title":"Serverless V1 Provider Regions"},"ProviderName":{"description":"Name of cloud provider.","type":"string","example":"aws","enum":["aws","azure","gcp"],"title":"Provider Name"},"ServerlessV1ProviderName":{"description":"Name of cloud provider.","type":"string","example":"aws","enum":["aws"]},"Provider":{"description":"Description of cloud provider that runs cloud gateway instances.","type":"object","properties":{"provider":{"$ref":"#/components/schemas/ProviderName"},"regions":{"$ref":"#/components/schemas/ProviderRegions"}},"additionalProperties":false,"required":["provider","regions"],"title":"Provider"},"ServerlessV1Provider":{"description":"Description of cloud provider that runs serverless v1 cloud gateway instances.","type":"object","properties":{"provider":{"$ref":"#/components/schemas/ServerlessV1ProviderName"},"regions":{"$ref":"#/components/schemas/ServerlessV1ProviderRegions"}},"additionalProperties":false,"required":["provider","regions"],"title":"Serverless V1 Provider"},"Providers":{"description":"List of supported cloud providers that run cloud gateway instances.","type":"array","items":{"$ref":"#/components/schemas/Provider"},"title":"Providers"},"ServerlessV1Providers":{"description":"List of supported cloud providers that run serverless v1 cloud gateway instances.","type":"array","items":{"$ref":"#/components/schemas/ServerlessV1Provider"},"title":"Serverless V1 Providers"},"AvailabilityDocument":{"description":"Document containing availability information for configurations.","type":"object","properties":{"versions":{"$ref":"#/components/schemas/VersionList"},"instance_types":{"$ref":"#/components/schemas/InstanceTypes"},"providers":{"$ref":"#/components/schemas/Providers"},"serverless_v1_providers":{"$ref":"#/components/schemas/ServerlessV1Providers"}},"additionalProperties":false,"required":["versions","instance_types","providers","serverless_v1_providers"],"title":"Availability Document"},"ConfigurationDataPlaneGroupAutoscale":{"oneOf":[{"$ref":"#/components/schemas/ConfigurationDataPlaneGroupAutoscaleStatic"},{"$ref":"#/components/schemas/ConfigurationDataPlaneGroupAutoscaleAutopilot"}]},"ConfigurationDataPlaneGroupAutoscaleStatic":{"description":"Object that describes the static autoscaling strategy. Deprecated in favor of the autopilot autoscaling strategy. Static autoscaling will be removed in a future version. For serverless.v1 kind of cloud gateways, this field should be omitted.","type":"object","properties":{"kind":{"type":"string","enum":["static"]},"instance_type":{"$ref":"#/components/schemas/InstanceTypeName"},"requested_instances":{"description":"Number of data-planes the deployment target will contain.","type":"integer","example":3}},"additionalProperties":false,"deprecated":true,"required":["kind","instance_type","requested_instances"],"title":"Configuration Autoscale Static"},"ConfigurationDataPlaneGroupAutoscaleAutopilot":{"description":"Object that describes the autopilot autoscaling strategy. For serverless.v1 kind of cloud gateways, this field should be omitted.","type":"object","properties":{"kind":{"type":"string","enum":["autopilot"]},"base_rps":{"description":"Base number of requests per second that the deployment target should support.","type":"integer","example":1},"max_rps":{"description":"Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps. This field is deprecated and shouldn't be used in new configurations as it will be removed in a future version. max_rps is now calculated as 10x base_rps.","type":"integer","example":1000,"deprecated":true}},"additionalProperties":false,"required":["kind","base_rps"],"title":"Configuration Autoscale Autopilot"},"ConfigurationDataPlaneGroupEnvironment":{"description":"Array of environment variables to set for a data-plane group.","type":"array","items":{"$ref":"#/components/schemas/ConfigurationDataPlaneGroupEnvironmentField"},"title":"Configuration Data-Plane Group Environment"},"ConfigurationDataPlaneGroupEnvironmentField":{"description":"Environment variable name and value to set for a data-plane group.","type":"object","properties":{"name":{"description":"Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_.\n","type":"string","format":"^KONG_[a-zA-Z_]+[a-zA-Z0-9_]*","example":"KONG_LOG_LEVEL","maxLength":120,"minLength":6},"value":{"description":"Value assigned to the environment variable field for the data-plane group.","type":"string","example":"info","maxLength":120,"minLength":1}},"required":["name","value"],"title":"Configuration Data-Plane Group Environment Field"},"ConfigurationDataPlaneGroupConfig":{"description":"Object that describes where a data-plane group will be deployed to, along with how many instances.","type":"object","properties":{"provider":{"$ref":"#/components/schemas/ProviderName"},"region":{"$ref":"#/components/schemas/ProviderRegionId"},"cloud_gateway_network_id":{"$ref":"#/components/schemas/NetworkId"},"autoscale":{"$ref":"#/components/schemas/ConfigurationDataPlaneGroupAutoscale"},"environment":{"$ref":"#/components/schemas/ConfigurationDataPlaneGroupEnvironment"}},"additionalProperties":false,"required":["provider","region"],"title":"Configuration Data-Plane Group Config Item"},"ConfigurationDataPlaneGroup":{"description":"Object that describes the set of data-plane groups currently pointed to this configuration.","type":"object","properties":{"id":{"$ref":"#/components/schemas/DataPlaneGroupId"},"provider":{"$ref":"#/components/schemas/ProviderName"},"region":{"$ref":"#/components/schemas/ProviderRegionId"},"autoscale":{"$ref":"#/components/schemas/ConfigurationDataPlaneGroupAutoscale"},"environment":{"$ref":"#/components/schemas/ConfigurationDataPlaneGroupEnvironment"},"cloud_gateway_network_id":{"$ref":"#/components/schemas/NetworkId"},"state":{"description":"State of the data-plane group.","type":"string","enum":["created","initializing","ready","terminating","terminated"]},"state_metadata":{"description":"Metadata describing the backing state of the dataplane group and why it may be in an erroneous state.\n","type":"object","additionalProperties":false,"properties":{"reported_status":{"description":"Reported status of the dataplane group from backing infrastructure.","type":"string","example":"ERROR"},"reason":{"description":"Reason why the dataplane group may be in an erroneous state, reported from backing infrastructure.\n","type":"string","example":"Dataplane group could not be deployed due to insufficient cloud provider compute instances.\n"}}},"private_ip_addresses":{"description":"List of private IP addresses of the internal load balancer that proxies traffic to this data-plane group.\n","type":"array","items":{"type":"string"},"example":["192.168.248.132","192.168.66.81","192.168.137.135"]},"egress_ip_addresses":{"description":"List of egress IP addresses for the network that this data-plane group runs on.\n","type":"array","items":{"type":"string"},"example":["71.78.149.75","91.149.112.244","51.235.15.121"]},"created_at":{"description":"An RFC-3339 timestamp representation of data-plane group 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 data-plane group update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"required":["id","provider","region","state","created_at","updated_at"],"title":"Cloud Gateway Configuration Data-Plane Group"},"NetworkConfigurationReference":{"$ref":"#/components/schemas/ConfigurationManifest"},"ConfigurationKind":{"description":"**Pre-release Feature**\nThis feature is currently in beta and is subject to change.\n\nKind of the Cloud Gateway deployment. If serverless.v1 is specified, the following fields\nshould be omitted (will be ignored if provided): autoscale, cloud_gateway_network_id, version.","type":"string","default":"dedicated.v0","enum":["dedicated.v0","serverless.v1"],"title":"ConfigurationKind"},"CustomDomainKind":{"description":"**Pre-release Feature**\nThis feature is currently in beta and is subject to change.\n\nKind of the custom domain based on Cloud Gateway deployment.","type":"string","default":"dedicated.v0","enum":["dedicated.v0","serverless.v1"],"title":"CustomDomainKind"},"ConfigurationManifest":{"description":"Object containing information about a control-plane's cloud-gateways configuration.","type":"object","properties":{"id":{"$ref":"#/components/schemas/ConfigurationId"},"version":{"$ref":"#/components/schemas/GatewayVersion"},"api_access":{"$ref":"#/components/schemas/ApiAccess"},"dataplane_group_config":{"description":"Object that describes where data-planes will be deployed to, along with how many instances.","type":"array","items":{"$ref":"#/components/schemas/ConfigurationDataPlaneGroupConfig"},"title":"Configuration Data-Plane Group Configs"},"dataplane_groups":{"description":"List of data-plane groups that describe where data-planes will be deployed to, along with how many\ninstances.\n","type":"array","items":{"$ref":"#/components/schemas/ConfigurationDataPlaneGroup"},"format":"set"},"kind":{"$ref":"#/components/schemas/ConfigurationKind"},"entity_version":{"description":"Positive, monotonically increasing version integer, to serialize configuration changes.\n","type":"number","example":1,"readOnly":true},"created_at":{"description":"An RFC-3339 timestamp representation of 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 configuration update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"control_plane_id":{"$ref":"#/components/schemas/ControlPlaneId"},"control_plane_geo":{"$ref":"#/components/schemas/ControlPlaneGeo"}},"required":["id","control_plane_id","control_plane_geo","dataplane_group_config","dataplane_groups","entity_version","created_at","updated_at"],"title":"Configuration"},"CreateConfigurationDataPlaneGroup":{"description":"Object that describes where to deploy a data-plane group, along with how many instances.","type":"object","properties":{"provider":{"$ref":"#/components/schemas/ProviderName"},"region":{"$ref":"#/components/schemas/ProviderRegionId"},"cloud_gateway_network_id":{"$ref":"#/components/schemas/NetworkId"},"autoscale":{"$ref":"#/components/schemas/ConfigurationDataPlaneGroupAutoscale"},"environment":{"$ref":"#/components/schemas/ConfigurationDataPlaneGroupEnvironment"}},"additionalProperties":false,"required":["provider","region"],"title":"CreateConfigurationDataPlaneGroup"},"ProviderAccount":{"description":"Object containing mapping for organization and cloud provider to account ID.","type":"object","properties":{"id":{"$ref":"#/components/schemas/ProviderAccountId"},"provider":{"$ref":"#/components/schemas/ProviderName"},"provider_account_id":{"description":"ID of the cloud provider account.","type":"string","readOnly":true},"created_at":{"description":"An RFC-3339 timestamp representation of provider account 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 provider account update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"required":["id","provider","provider_account_id","created_at","updated_at"],"title":"Cloud Gateway Provider Account"},"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"},"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"},"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"},"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"},"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"}},"additionalProperties":false,"title":"PatchNetworkRequest"},"TransitGatewayState":{"description":"The current state of the Transit Gateway. Possible values:\n- `created` - The attachment has been created but is not attached to transit gateway.\n- `initializing` - The attachment is in the process of being initialized and is setting up necessary resources.\n- `pending-acceptance` The attachment request is awaiting acceptance in customer VPC.\n- `pending-user-action` The attachment request is awaiting user action in customer VPC.\n- `ready` - The transit gateway attachment is fully operational and can route traffic as configured.\n- `terminating` - The attachment is in the process of being deleted and is no longer accepting new traffic.\n- `terminated` - The attachment has been fully deleted and is no longer available.\n- `error` - The attachment is in an error state.\n","type":"string","enum":["created","initializing","pending-acceptance","pending-user-action","ready","terminating","terminated","error"],"readOnly":true,"title":"Transit Gateway State"},"AwsResourceEndpointConfigState":{"description":"The current state of the resource config in AWS Resource Endpoint. Possible values:\n- `initializing` - The config is in the process of being initialized and is setting up necessary resources.\n- `missing` - The config is missing and is no longer accepting new traffic.\n- `ready` - The config is fully operational and can route traffic as configured.\n- `error` - The config is in an error state, and is not operational.\n- `terminating` - The config is in the process of being deleted and is no longer accepting new traffic.\n","type":"string","enum":["initializing","missing","ready","error","terminating"],"readOnly":true,"title":"AWS Resource Endpoint Config State"},"AwsTransitGatewayAttachmentConfig":{"type":"object","properties":{"kind":{"enum":["aws-transit-gateway-attachment"],"title":"AWS Transit Gateway Attachment Type"},"transit_gateway_id":{"description":"AWS Transit Gateway ID to create attachment to.","type":"string","title":"Transit Gateway ID"},"ram_share_arn":{"description":"Resource Share ARN to verify request to create transit gateway attachment.","type":"string","title":"RAM Share ARN"}},"additionalProperties":false,"required":["kind","transit_gateway_id","ram_share_arn"],"title":"AWS Transit Gateway Attachment Config"},"AwsTransitGatewayAttachmentConfigForResponse":{"type":"object","properties":{"kind":{"enum":["aws-transit-gateway-attachment"],"title":"AWS Transit Gateway Attachment Type"},"transit_gateway_id":{"description":"AWS Transit Gateway ID to create attachment to.","type":"string","title":"Transit Gateway ID"},"ram_share_arn":{"description":"Resource Share ARN to verify request to create transit gateway attachment.","type":"string","title":"RAM Share ARN"},"attachment_id":{"description":"ID of the AWS Transit Gateway attachment.","type":"string","title":"AWS Transit Gateway Attachment ID"}},"additionalProperties":false,"required":["kind","transit_gateway_id","ram_share_arn"],"title":"AWS Transit Gateway Attachment Config"},"AwsVpcPeeringGatewayAttachmentConfig":{"type":"object","properties":{"kind":{"enum":["aws-vpc-peering-attachment"],"title":"AWS VPC Peering Attachment Config"},"peer_account_id":{"type":"string"},"peer_vpc_id":{"type":"string"},"peer_vpc_region":{"type":"string"}},"additionalProperties":false,"required":["kind","peer_account_id","peer_vpc_id","peer_vpc_region"],"title":"AWS VPC Peering Attachment Config"},"AwsVpcPeeringGatewayAttachmentConfigForResponse":{"type":"object","properties":{"kind":{"enum":["aws-vpc-peering-attachment"],"title":"AWS VPC Peering Attachment Config"},"peer_account_id":{"type":"string"},"peer_vpc_id":{"type":"string"},"peer_vpc_region":{"type":"string"},"peering_connection_id":{"type":"string"}},"additionalProperties":false,"required":["kind","peer_account_id","peer_vpc_id","peer_vpc_region"],"title":"AWS VPC Peering Attachment Config"},"AwsResourceEndpointAttachmentConfig":{"type":"object","properties":{"kind":{"enum":["aws-resource-endpoint-attachment"],"title":"AWS Resource Endpoint Attachment Type"},"ram_share_arn":{"description":"Resource Share ARN to verify request to create transit gateway attachment.","type":"string","title":"RAM Share ARN"},"resource_config":{"$ref":"#/components/schemas/AwsResourceEndpointConfig"}},"additionalProperties":false,"required":["kind","ram_share_arn"],"title":"AWS Resource Endpoint Attachment Config"},"AwsResourceEndpointAttachmentConfigResponse":{"type":"object","properties":{"kind":{"enum":["aws-resource-endpoint-attachment"],"title":"AWS Resource Endpoint Attachment Type"},"ram_share_arn":{"description":"Resource Share ARN to verify request to create transit gateway attachment.","type":"string","title":"RAM Share ARN"},"resource_config":{"$ref":"#/components/schemas/AwsResourceEndpointConfigResponse"}},"additionalProperties":false,"required":["kind","ram_share_arn","resource_config"],"title":"AWS Resource Endpoint Attachment Config Response"},"AwsResourceEndpointConfig":{"description":"List of unique resource config mapping for aws resource endpoint.\n","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"resource_config_id":{"description":"Resource Config ID to uniquely identify a resource configuration.","type":"string","title":"Resource Config ID"},"domain_name":{"description":"Domain Name to uniquely identify a resource configuration.","type":"string","title":"Domain Name"}},"required":["resource_config_id","domain_name"]},"title":"AWS Resource Endpoint Config"},"AwsResourceEndpointConfigResponse":{"description":"List of unique resource config mapping for aws resource endpoint.\n","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"resource_config_id":{"description":"Resource Config ID to uniquely identify a resource configuration.","type":"string","title":"Resource Config ID"},"domain_name":{"description":"Domain Name to uniquely identify a resource configuration.","type":"string","title":"Domain Name"},"state":{"$ref":"#/components/schemas/AwsResourceEndpointConfigState"}},"required":["resource_config_id","domain_name","state"]},"title":"AWS Resource Endpoint Config Response"},"AzureVNETPeeringAttachmentConfig":{"type":"object","properties":{"kind":{"enum":["azure-vnet-peering-attachment"],"title":"Azure VNET Peering Attachment Type"},"tenant_id":{"description":"Tenant ID for the Azure VNET Peering attachment.","type":"string","title":"Tenant ID"},"subscription_id":{"description":"Subscription ID for the Azure VNET Peering attachment.","type":"string","title":"Subscription ID"},"resource_group_name":{"description":"Resource Group Name for the Azure VNET Peering attachment.","type":"string","title":"Resource Group Name"},"vnet_name":{"description":"VNET Name for the Azure VNET Peering attachment.","type":"string","title":"VNET Name"}},"additionalProperties":false,"required":["kind","tenant_id","subscription_id","resource_group_name","vnet_name"],"title":"Azure VNET Peering Attachment Config"},"AzureVHubPeeringAttachmentConfig":{"type":"object","properties":{"kind":{"enum":["azure-vhub-peering-attachment"],"title":"Azure Virtual Hub Peering Attachment Type"},"tenant_id":{"description":"Tenant ID of the Azure Virtual Hub resource.","type":"string","title":"Tenant ID"},"subscription_id":{"description":"Subscription ID of the Azure Virtual Hub resource.","type":"string","title":"Subscription ID"},"resource_group_name":{"description":"Resource Group Name of the Azure Virtual Hub resource.","type":"string","title":"Resource Group Name"},"vhub_name":{"description":"Name of the Azure Virtual Hub resource.","type":"string","title":"Virtual Hub Name"}},"additionalProperties":false,"required":["kind","tenant_id","subscription_id","resource_group_name","vhub_name"],"title":"Azure Virtual Hub Peering Attachment Config"},"GCPVPCPeeringAttachmentConfig":{"type":"object","properties":{"kind":{"enum":["gcp-vpc-peering-attachment"],"title":"GCP VPC Peering Attachment Type"},"peer_project_id":{"description":"GCP Project ID of the peer account to create attachment to.","type":"string","title":"GCP Project ID"},"peer_vpc_name":{"description":"GCP VPC Name of the peer account to create attachment to.","type":"string","title":"GCP VPC Name"}},"additionalProperties":false,"required":["kind","peer_project_id","peer_vpc_name"],"title":"GCP VPC Peering Attachment Config"},"TransitGatewayDnsConfig":{"description":"List of mappings from remote DNS server IP address sets to proxied internal domains, for a transit gateway\nattachment.\n","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"remote_dns_server_ip_addresses":{"description":"Remote DNS Server IP Addresses to connect to for resolving internal DNS via a transit gateway.","type":"array","items":{"type":"string"},"example":["10.0.0.2"],"title":"Remote DNS Server IP Addresses"},"domain_proxy_list":{"description":"Internal domain names to proxy for DNS resolution from the listed remote DNS server IP addresses,\nfor a transit gateway.\n","type":"array","items":{"type":"string"},"example":["foobar.com"],"title":"Domain Proxy List"}},"required":["remote_dns_server_ip_addresses","domain_proxy_list"]},"title":"Transit Gateway DNS Config"},"TransitGatewayName":{"description":"Human-readable name of the transit gateway.","type":"string","example":"us-east-2 transit gateway","title":"Transit Gateway Name"},"TransitGatewayCIDRBlocks":{"description":"CIDR blocks for constructing a route table for the transit gateway, when attaching to the owning\nnetwork.\n","type":"array","items":{"type":"string"},"example":["10.0.0.0/8","100.64.0.0/10","172.16.0.0/12"],"title":"Transit Gateway CIDR Blocks"},"PrivateDnsResponse":{"oneOf":[{"$ref":"#/components/schemas/AwsPrivateHostedZoneResponse"},{"$ref":"#/components/schemas/AwsPrivateDnsResolverResponse"},{"$ref":"#/components/schemas/GcpPrivateHostedZoneResponse"},{"$ref":"#/components/schemas/AzurePrivateHostedZoneResponse"},{"$ref":"#/components/schemas/AzurePrivateDnsResolverResponse"}]},"AwsPrivateHostedZoneResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PrivateDnsId"},"state":{"$ref":"#/components/schemas/PrivateDnsState"},"state_metadata":{"description":"Metadata describing the backing state of the Private Dns and why it may be in an erroneous state.\n","type":"object","additionalProperties":false,"properties":{"reported_status":{"description":"Reported status of the Private Dns from backing infrastructure.","type":"string","example":"ERROR"},"reason":{"description":"Reason why the Private Dns may be in an erroneous state, reported from backing infrastructure.\n","type":"string","example":"Failed to create Private Dns due to invalid Cloud Provider configuration.\n"}},"title":"PrivateDnsStateMetadata"},"entity_version":{"description":"Monotonically-increasing version count of the Private DNS, to indicate the order of updates to the\nPrivate DNS.\n","type":"integer","example":1,"readOnly":true},"created_at":{"description":"An RFC-3339 timestamp representation of Private DNS 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 Private DNS update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"name":{"$ref":"#/components/schemas/PrivateDnsName"},"private_dns_attachment_config":{"$ref":"#/components/schemas/AwsPrivateHostedZoneAttachmentConfig"}},"required":["id","state","state_metadata","entity_version","created_at","updated_at","name","private_dns_attachment_config"]},"AwsPrivateHostedZoneAttachmentConfig":{"type":"object","properties":{"kind":{"enum":["aws-private-hosted-zone-attachment"],"title":"AWS Private Hosted Zone Type"},"hosted_zone_id":{"description":"AWS Hosted Zone to create attachment to.","type":"string","title":"Hosted Zone Id"}},"additionalProperties":false,"required":["kind","hosted_zone_id"],"title":"AWS Private Hosted Zone Attachment Config"},"GcpPrivateHostedZoneAttachmentConfig":{"type":"object","properties":{"kind":{"enum":["gcp-private-hosted-zone-attachment"],"title":"GCP Private Hosted Zone Type"},"domain_name":{"description":"Domain name to create attachment to.","type":"string","title":"Domain Name"},"peer_project_id":{"description":"Customer's GCP Project ID.","type":"string","title":"Peer Project Id"},"peer_vpc_name":{"description":"Customer's GCP VPC ID.","type":"string","title":"Peer VPC Name"}},"additionalProperties":false,"required":["kind","domain_name","peer_project_id","peer_vpc_name"],"title":"GCP Private Hosted Zone Attachment Config"},"GcpPrivateHostedZoneResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PrivateDnsId"},"state":{"$ref":"#/components/schemas/PrivateDnsState"},"state_metadata":{"description":"Metadata describing the backing state of the Private Dns and why it may be in an erroneous state.\n","type":"object","additionalProperties":false,"properties":{"reported_status":{"description":"Reported status of the Private Dns from backing infrastructure.","type":"string","example":"ERROR"},"reason":{"description":"Reason why the Private Dns may be in an erroneous state, reported from backing infrastructure.\n","type":"string","example":"Failed to create Private Dns due to invalid Cloud Provider configuration.\n"}},"title":"PrivateDnsStateMetadata"},"entity_version":{"description":"Monotonically-increasing version count of the Private DNS, to indicate the order of updates to the\nPrivate DNS.\n","type":"integer","example":1,"readOnly":true},"created_at":{"description":"An RFC-3339 timestamp representation of Private DNS 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 Private DNS update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"name":{"$ref":"#/components/schemas/PrivateDnsName"},"private_dns_attachment_config":{"$ref":"#/components/schemas/GcpPrivateHostedZoneAttachmentConfig"}},"required":["id","state","state_metadata","entity_version","created_at","updated_at","name","private_dns_attachment_config"]},"AzurePrivateHostedZoneAttachmentConfig":{"type":"object","properties":{"kind":{"enum":["azure-private-hosted-zone-attachment"],"title":"Azure Private Hosted Zone Type"},"domain_name":{"description":"Customer's Azure Private DNS Zone Name.","type":"string","title":"Domain Name"},"peer_tenant_id":{"description":"Customer's Azure Tenant ID.","type":"string","title":"Peer Tenant Id"},"peer_subscription_id":{"description":"Customer's Azure Subscription ID.","type":"string","title":"Peer Subscription Id"},"peer_resource_group_id":{"description":"Customer's Azure Resource Group ID.","type":"string","title":"Peer Resource Group Id"},"peer_vnet_link_name":{"description":"Customer's Azure VNet Link Name.","type":"string","title":"Peer VNet Link Name"}},"example":{"kind":"azure-private-hosted-zone-attachment","domain_name":"example.private.azure.com","peer_tenant_id":"87654321-4321-4321-4321-210987654321","peer_subscription_id":"12345678-1234-1234-1234-123456789012","peer_resource_group_id":"customer-dns-rg","peer_vnet_link_name":"kong-vnet-link"},"additionalProperties":false,"required":["kind","domain_name","peer_tenant_id","peer_subscription_id","peer_resource_group_id","peer_vnet_link_name"],"title":"Azure Private Hosted Zone Attachment Config"},"AzurePrivateHostedZoneResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PrivateDnsId"},"state":{"$ref":"#/components/schemas/PrivateDnsState"},"state_metadata":{"description":"Metadata describing the backing state of the Private Dns and why it may be in an erroneous state.\n","type":"object","additionalProperties":false,"properties":{"reported_status":{"description":"Reported status of the Private Dns from backing infrastructure.","type":"string","example":"ERROR"},"reason":{"description":"Reason why the Private Dns may be in an erroneous state, reported from backing infrastructure.\n","type":"string","example":"Failed to create Private Dns due to invalid Cloud Provider configuration.\n"}},"title":"PrivateDnsStateMetadata"},"entity_version":{"description":"Monotonically-increasing version count of the Private DNS, to indicate the order of updates to the\nPrivate DNS.\n","type":"integer","example":1,"readOnly":true},"created_at":{"description":"An RFC-3339 timestamp representation of Private DNS 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 Private DNS update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"name":{"$ref":"#/components/schemas/PrivateDnsName"},"private_dns_attachment_config":{"$ref":"#/components/schemas/AzurePrivateHostedZoneAttachmentConfig"}},"required":["id","state","state_metadata","entity_version","created_at","updated_at","name","private_dns_attachment_config"]},"AwsPrivateDnsResolverResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PrivateDnsId"},"state":{"$ref":"#/components/schemas/PrivateDnsState"},"state_metadata":{"description":"Metadata describing the backing state of the Private Dns and why it may be in an erroneous state.\n","type":"object","additionalProperties":false,"properties":{"reported_status":{"description":"Reported status of the Private Dns from backing infrastructure.","type":"string","example":"ERROR"},"reason":{"description":"Reason why the Private Dns may be in an erroneous state, reported from backing infrastructure.\n","type":"string","example":"Failed to create Private Dns due to invalid Cloud Provider configuration.\n"}},"title":"PrivateDnsStateMetadata"},"entity_version":{"description":"Monotonically-increasing version count of the Private DNS, to indicate the order of updates to the\nPrivate DNS.\n","type":"integer","example":1,"readOnly":true},"created_at":{"description":"An RFC-3339 timestamp representation of Private DNS 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 Private DNS update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"name":{"$ref":"#/components/schemas/PrivateDnsName"},"private_dns_attachment_config":{"$ref":"#/components/schemas/AwsPrivateDnsResolverAttachmentConfig"}},"required":["id","state","state_metadata","entity_version","created_at","updated_at","name","private_dns_attachment_config"]},"AzurePrivateDnsResolverResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PrivateDnsId"},"state":{"$ref":"#/components/schemas/PrivateDnsState"},"state_metadata":{"description":"Metadata describing the backing state of the Private Dns and why it may be in an erroneous state.\n","type":"object","additionalProperties":false,"properties":{"reported_status":{"description":"Reported status of the Private Dns from backing infrastructure.","type":"string","example":"ERROR"},"reason":{"description":"Reason why the Private Dns may be in an erroneous state, reported from backing infrastructure.\n","type":"string","example":"Failed to create Private Dns due to invalid Cloud Provider configuration.\n"}},"title":"PrivateDnsStateMetadata"},"entity_version":{"description":"Monotonically-increasing version count of the Private DNS, to indicate the order of updates to the\nPrivate DNS.\n","type":"integer","example":1,"readOnly":true},"created_at":{"description":"An RFC-3339 timestamp representation of Private DNS 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 Private DNS update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"name":{"$ref":"#/components/schemas/PrivateDnsName"},"private_dns_attachment_config":{"$ref":"#/components/schemas/AzurePrivateDnsResolverAttachmentConfig"}},"required":["id","state","state_metadata","entity_version","created_at","updated_at","name","private_dns_attachment_config"]},"AwsPrivateDnsResolverAttachmentConfig":{"type":"object","properties":{"kind":{"enum":["aws-outbound-resolver"],"title":"AWS Private DNS Resolver Type"},"dns_config":{"$ref":"#/components/schemas/PrivateDnsResolverConfig"}},"additionalProperties":false,"required":["kind","dns_config"],"title":"AWS Private DNS Resolver Attachment Config"},"AzurePrivateDnsResolverAttachmentConfig":{"type":"object","properties":{"kind":{"enum":["azure-outbound-resolver"],"title":"Azure Private DNS Resolver Type"},"dns_config":{"$ref":"#/components/schemas/PrivateDnsResolverConfig"}},"example":{"kind":"azure-outbound-resolver","dns_config":{"global.api.konghq.com":{"remote_dns_server_ip_addresses":["10.0.0.2"]},"us.api.konghq.dev":{"remote_dns_server_ip_addresses":["10.0.0.8"]}}},"additionalProperties":false,"required":["kind","dns_config"],"title":"Azure Private DNS Resolver Attachment Config"},"PrivateDnsResolverConfig":{"description":"Object that contains mappings from proxied internal domains to remote DNS server IP address for a Private DNS Resolver.\n","type":"object","example":{"global.api.konghq.com":{"remote_dns_server_ip_addresses":["10.0.0.2"]},"us.api.konghq.dev":{"remote_dns_server_ip_addresses":["10.0.0.8"]}},"additionalProperties":{"$ref":"#/components/schemas/PrivateDnsResolverConfigObject"},"title":"Private DNS Resolver Config Item"},"PrivateDnsResolverConfigObject":{"type":"object","properties":{"remote_dns_server_ip_addresses":{"description":"IP addresses of remote DNS servers used by the Private DNS Resolver for DNS resolution.","type":"array","items":{"type":"string"},"example":["10.0.0.2"]}},"required":["remote_dns_server_ip_addresses"]},"PrivateDnsName":{"description":"Human-readable name of the Private DNS.","type":"string","example":"us-east-2 private dns","title":"Private DNS Name"},"PrivateDnsState":{"description":"The current state of the Private DNS attachment. Possible values:\n- `created` - The attachment has been created but is not attached to Private DNS.\n- `initializing` - The attachment is in the process of being initialized and is setting up necessary resources.\n- `pending-association` The attachment request is awaiting association to the cloud provider infrastructure in order for provisioning to proceed.\n- `ready` - The attachment is fully operational and can route traffic as configured.\n- `error` - The attachment is in an error state, and is not operational.\n- `terminating` - The attachment is in the process of being deleted.\n- `terminated` - The attachment has been fully deleted and is no longer available.\n","type":"string","enum":["created","initializing","pending-association","ready","error","terminating","terminated"],"title":"Private DNS State"},"PatchAwsPrivateDnsResolver":{"description":"Request schema for updating a Private DNS AWS Resolver.","properties":{"name":{"$ref":"#/components/schemas/PrivateDnsName"},"private_dns_attachment_config":{"$ref":"#/components/schemas/AwsPrivateDnsResolverAttachmentConfig"}}},"PatchAzurePrivateDnsResolver":{"description":"Request schema for updating a Private DNS Azure Resolver.","properties":{"name":{"$ref":"#/components/schemas/PrivateDnsName"},"private_dns_attachment_config":{"$ref":"#/components/schemas/AzurePrivateDnsResolverAttachmentConfig"}}},"CreatePrivateDnsRequest":{"description":"Request schema for creating a Private DNS.","type":"object","properties":{"name":{"$ref":"#/components/schemas/PrivateDnsName"},"private_dns_attachment_config":{"oneOf":[{"$ref":"#/components/schemas/AwsPrivateHostedZoneAttachmentConfig"},{"$ref":"#/components/schemas/AwsPrivateDnsResolverAttachmentConfig"},{"$ref":"#/components/schemas/GcpPrivateHostedZoneAttachmentConfig"},{"$ref":"#/components/schemas/AzurePrivateHostedZoneAttachmentConfig"},{"$ref":"#/components/schemas/AzurePrivateDnsResolverAttachmentConfig"}]}},"title":"CreatePrivateDnsRequest"},"PatchPrivateDnsRequest":{"description":"Request schema for updating a Private DNS.","type":"object","oneOf":[{"$ref":"#/components/schemas/PatchAwsPrivateDnsResolver"},{"$ref":"#/components/schemas/PatchAzurePrivateDnsResolver"}],"title":"PatchPrivateDnsRequest"},"AwsTransitGatewayResponse":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TransitGatewayName"},"dns_config":{"$ref":"#/components/schemas/TransitGatewayDnsConfig"},"cidr_blocks":{"$ref":"#/components/schemas/TransitGatewayCIDRBlocks"},"transit_gateway_attachment_config":{"$ref":"#/components/schemas/AwsTransitGatewayAttachmentConfigForResponse"},"id":{"$ref":"#/components/schemas/TransitGatewayId"},"state":{"$ref":"#/components/schemas/TransitGatewayState"},"state_metadata":{"description":"Metadata describing the backing state of the transit gateway and why it may be in an erroneous state.\n","type":"object","additionalProperties":false,"properties":{"reported_status":{"description":"Reported status of the transit gateway from backing infrastructure.","type":"string","example":"ERROR"},"reason":{"description":"Reason why the transit gateway may be in an erroneous state, reported from backing infrastructure.\n","type":"string","example":"Transit Gateway Attachment configuration could not find a resource with the provided ram share arn.\n"}},"readOnly":true,"title":"TransitGatewayStateMetadata"},"entity_version":{"description":"Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the\ntransit gateway.\n","type":"integer","example":1,"readOnly":true},"created_at":{"description":"An RFC-3339 timestamp representation of transit gateway 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 transit gateway update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"required":["name","cidr_blocks","transit_gateway_attachment_config","dns_config","id","state","entity_version","created_at","updated_at"],"title":"AWS Transit Gateway"},"AwsVpcPeeringGatewayResponse":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TransitGatewayName"},"dns_config":{"$ref":"#/components/schemas/TransitGatewayDnsConfig"},"cidr_blocks":{"$ref":"#/components/schemas/TransitGatewayCIDRBlocks"},"transit_gateway_attachment_config":{"$ref":"#/components/schemas/AwsVpcPeeringGatewayAttachmentConfigForResponse"},"id":{"$ref":"#/components/schemas/TransitGatewayId"},"state":{"$ref":"#/components/schemas/TransitGatewayState"},"state_metadata":{"description":"Metadata describing the backing state of the transit gateway and why it may be in an erroneous state.\n","type":"object","additionalProperties":false,"properties":{"reported_status":{"description":"Reported status of the transit gateway from backing infrastructure.","type":"string","example":"ERROR"},"reason":{"description":"Reason why the transit gateway may be in an erroneous state, reported from backing infrastructure.\n","type":"string","example":"Transit Gateway Attachment configuration could not find a resource with the provided ram share arn.\n"}},"readOnly":true,"title":"TransitGatewayStateMetadata"},"entity_version":{"description":"Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the\ntransit gateway.\n","type":"integer","example":1,"readOnly":true},"created_at":{"description":"An RFC-3339 timestamp representation of transit gateway 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 transit gateway update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"required":["name","cidr_blocks","transit_gateway_attachment_config","dns_config","id","state","entity_version","created_at","updated_at"],"title":"AWS VPC Peering Gateway"},"AwsResourceEndpointGatewayResponse":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TransitGatewayName"},"dns_config":{"$ref":"#/components/schemas/TransitGatewayDnsConfig"},"transit_gateway_attachment_config":{"$ref":"#/components/schemas/AwsResourceEndpointAttachmentConfigResponse"},"id":{"$ref":"#/components/schemas/TransitGatewayId"},"state":{"$ref":"#/components/schemas/TransitGatewayState"},"state_metadata":{"description":"Metadata describing the backing state of the transit gateway and why it may be in an erroneous state.\n","type":"object","additionalProperties":false,"properties":{"reported_status":{"description":"Reported status of the transit gateway from backing infrastructure.","type":"string","example":"ERROR"},"reason":{"description":"Reason why the transit gateway may be in an erroneous state, reported from backing infrastructure.\n","type":"string","example":"Transit Gateway Attachment configuration could not find a resource with the provided ram share arn.\n"}},"readOnly":true,"title":"TransitGatewayStateMetadata"},"entity_version":{"description":"Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the\ntransit gateway.\n","type":"integer","example":1,"readOnly":true},"created_at":{"description":"An RFC-3339 timestamp representation of transit gateway 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 transit gateway update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"required":["name","transit_gateway_attachment_config","id","dns_config","state","entity_version","created_at","updated_at"],"title":"AWS Resource Endpoint Gateway"},"AzureTransitGatewayResponse":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TransitGatewayName"},"dns_config":{"$ref":"#/components/schemas/TransitGatewayDnsConfig"},"transit_gateway_attachment_config":{"$ref":"#/components/schemas/AzureVNETPeeringAttachmentConfig"},"id":{"$ref":"#/components/schemas/TransitGatewayId"},"state":{"$ref":"#/components/schemas/TransitGatewayState"},"state_metadata":{"description":"Metadata describing the backing state of the transit gateway and why it may be in an erroneous state.\n","type":"object","additionalProperties":false,"properties":{"reported_status":{"description":"Reported status of the transit gateway from backing infrastructure.","type":"string","example":"ERROR"},"reason":{"description":"Reason why the transit gateway may be in an erroneous state, reported from backing infrastructure.\n","type":"string","example":"Transit Gateway Attachment configuration could not find a resource with the provided ram share arn.\n"}},"readOnly":true,"title":"TransitGatewayStateMetadata"},"entity_version":{"description":"Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the\ntransit gateway.\n","type":"integer","example":1,"readOnly":true},"created_at":{"description":"An RFC-3339 timestamp representation of transit gateway 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 transit gateway update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"required":["name","transit_gateway_attachment_config","id","dns_config","state","entity_version","created_at","updated_at"],"title":"Azure Transit Gateway"},"AzureVHubPeeringGatewayResponse":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TransitGatewayName"},"dns_config":{"$ref":"#/components/schemas/TransitGatewayDnsConfig"},"transit_gateway_attachment_config":{"$ref":"#/components/schemas/AzureVHubPeeringAttachmentConfig"},"id":{"$ref":"#/components/schemas/TransitGatewayId"},"state":{"$ref":"#/components/schemas/TransitGatewayState"},"state_metadata":{"description":"Metadata describing the backing state of the transit gateway and why it may be in an erroneous state.\n","type":"object","additionalProperties":false,"properties":{"reported_status":{"description":"Reported status of the transit gateway from backing infrastructure.","type":"string","example":"ERROR"},"reason":{"description":"Reason why the transit gateway may be in an erroneous state, reported from backing infrastructure.\n","type":"string","example":"Transit Gateway Attachment configuration could not find a resource with the provided ram share arn.\n"}},"readOnly":true,"title":"TransitGatewayStateMetadata"},"entity_version":{"description":"Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the\ntransit gateway.\n","type":"integer","example":1,"readOnly":true},"created_at":{"description":"An RFC-3339 timestamp representation of transit gateway 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 transit gateway update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"required":["name","transit_gateway_attachment_config","id","dns_config","state","entity_version","created_at","updated_at"],"title":"Azure Virtual Hub Peering Gateway"},"GCPVPCPeeringGatewayResponse":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TransitGatewayName"},"dns_config":{"$ref":"#/components/schemas/TransitGatewayDnsConfig"},"transit_gateway_attachment_config":{"$ref":"#/components/schemas/GCPVPCPeeringAttachmentConfig"},"id":{"$ref":"#/components/schemas/TransitGatewayId"},"state":{"$ref":"#/components/schemas/TransitGatewayState"},"state_metadata":{"description":"Metadata describing the backing state of the transit gateway and why it may be in an erroneous state.\n","type":"object","additionalProperties":false,"properties":{"reported_status":{"description":"Reported status of the transit gateway from backing infrastructure.","type":"string","example":"ERROR"},"reason":{"description":"Reason why the transit gateway may be in an erroneous state, reported from backing infrastructure.\n","type":"string","example":"Transit Gateway Attachment configuration could not find a resource with the provided ram share arn.\n"}},"readOnly":true,"title":"TransitGatewayStateMetadata"},"entity_version":{"description":"Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the\ntransit gateway.\n","type":"integer","example":1,"readOnly":true},"created_at":{"description":"An RFC-3339 timestamp representation of transit gateway 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 transit gateway update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"required":["name","transit_gateway_attachment_config","id","dns_config","state","entity_version","created_at","updated_at"],"title":"GCP VPC Peering Transit Gateway"},"TransitGatewayResponse":{"oneOf":[{"$ref":"#/components/schemas/AwsTransitGatewayResponse"},{"$ref":"#/components/schemas/AwsVpcPeeringGatewayResponse"},{"$ref":"#/components/schemas/AzureTransitGatewayResponse"},{"$ref":"#/components/schemas/AzureVHubPeeringGatewayResponse"},{"$ref":"#/components/schemas/GCPVPCPeeringGatewayResponse"},{"$ref":"#/components/schemas/AwsResourceEndpointGatewayResponse"}]},"CreateAwsTransitGateway":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TransitGatewayName"},"dns_config":{"$ref":"#/components/schemas/TransitGatewayDnsConfig"},"cidr_blocks":{"$ref":"#/components/schemas/TransitGatewayCIDRBlocks"},"transit_gateway_attachment_config":{"$ref":"#/components/schemas/AwsTransitGatewayAttachmentConfig"}},"required":["name","cidr_blocks","transit_gateway_attachment_config"],"title":"AWS Transit Gateway"},"CreateAwsVpcPeeringGateway":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TransitGatewayName"},"dns_config":{"$ref":"#/components/schemas/TransitGatewayDnsConfig"},"cidr_blocks":{"$ref":"#/components/schemas/TransitGatewayCIDRBlocks"},"transit_gateway_attachment_config":{"$ref":"#/components/schemas/AwsVpcPeeringGatewayAttachmentConfig"}},"required":["name","cidr_blocks","transit_gateway_attachment_config"],"title":"AWS VPC Peering Gateway"},"CreateAwsResourceEndpointGateway":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TransitGatewayName"},"dns_config":{"$ref":"#/components/schemas/TransitGatewayDnsConfig"},"transit_gateway_attachment_config":{"$ref":"#/components/schemas/AwsResourceEndpointAttachmentConfig"}},"required":["name","transit_gateway_attachment_config"],"title":"AWS Resource Endpoint Gateway"},"CreateAzureTransitGateway":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TransitGatewayName"},"dns_config":{"$ref":"#/components/schemas/TransitGatewayDnsConfig"},"transit_gateway_attachment_config":{"$ref":"#/components/schemas/AzureVNETPeeringAttachmentConfig"}},"required":["name","transit_gateway_attachment_config"],"title":"Azure Transit Gateway"},"CreateAzureVHubPeeringGateway":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TransitGatewayName"},"dns_config":{"$ref":"#/components/schemas/TransitGatewayDnsConfig"},"transit_gateway_attachment_config":{"$ref":"#/components/schemas/AzureVHubPeeringAttachmentConfig"}},"required":["name","transit_gateway_attachment_config"],"title":"Azure Virtual Hub Peering Gateway"},"CreateGCPVPCPeeringTransitGateway":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TransitGatewayName"},"dns_config":{"$ref":"#/components/schemas/TransitGatewayDnsConfig"},"transit_gateway_attachment_config":{"$ref":"#/components/schemas/GCPVPCPeeringAttachmentConfig"}},"required":["name","transit_gateway_attachment_config"],"title":"GCP VPC Peering Transit Gateway"},"CreateTransitGatewayRequest":{"description":"Request schema for creating a transit gateway.","type":"object","oneOf":[{"$ref":"#/components/schemas/CreateAwsTransitGateway"},{"$ref":"#/components/schemas/CreateAwsVpcPeeringGateway"},{"$ref":"#/components/schemas/CreateAwsResourceEndpointGateway"},{"$ref":"#/components/schemas/CreateAzureTransitGateway"},{"$ref":"#/components/schemas/CreateAzureVHubPeeringGateway"},{"$ref":"#/components/schemas/CreateGCPVPCPeeringTransitGateway"}],"title":"CreateTransitGatewayRequest"},"PatchAwsResourceEndpointGateway":{"description":"Request schema for updating AWS Resource Endpoint.","properties":{"transit_gateway_attachment_config":{"type":"object","additionalProperties":false,"properties":{"kind":{"enum":["aws-resource-endpoint-attachment"],"title":"AWS Resource Endpoint Attachment Type"},"resource_config":{"$ref":"#/components/schemas/AwsResourceEndpointConfig"}},"required":["kind","resource_config"]}},"required":["transit_gateway_attachment_config"]},"PatchAwsTransitGateway":{"description":"Request schema for updating AWS Transit Gateway","properties":{"cidr_blocks":{"$ref":"#/components/schemas/TransitGatewayCIDRBlocks"}},"required":["cidr_blocks"]},"PatchTransitGatewayRequest":{"description":"Request schema for updating a transit gateway.","type":"object","oneOf":[{"$ref":"#/components/schemas/PatchAwsResourceEndpointGateway"},{"$ref":"#/components/schemas/PatchAwsTransitGateway"}],"title":"PatchTransitGatewayRequest"},"CustomDomainState":{"description":"State of the custom domain.","type":"string","enum":["created","initializing","ready","terminating","terminated","error"],"readOnly":true,"title":"Custom Domain State"},"CustomDomainName":{"description":"Domain name of the custom domain.","type":"string","example":"example.com","title":"Custom Domain Name"},"CustomDomain":{"description":"Object containing information about a custom domain for a control-plane.","type":"object","properties":{"id":{"$ref":"#/components/schemas/CustomDomainId"},"control_plane_id":{"$ref":"#/components/schemas/ControlPlaneId"},"control_plane_geo":{"$ref":"#/components/schemas/ControlPlaneGeo"},"domain":{"$ref":"#/components/schemas/CustomDomainName"},"certificate_id":{"description":"Certificate ID for the certificate representing this domain and stored on data-planes for this\ncontrol-plane. Can be retrieved via the control-planes API for this custom domain's control-plane.\n","type":"string","format":"uuid","example":"3b7cbeee-fbec-440e-a5ef-89e7dec3b9d0","nullable":true,"readOnly":true},"sni_id":{"description":"Server Name Indication ID for this domain and stored on data-planes for this control-plane. Can be retrieved\nvia the control-planes API for this custom domain's control-plane.\n","type":"string","format":"uuid","example":"a8f11ea8-af09-4422-9735-5d4f8910aba1","nullable":true,"readOnly":true},"state":{"$ref":"#/components/schemas/CustomDomainState"},"state_metadata":{"description":"Metadata describing the backing state of the custom domain and why it may be in an erroneous state.\n","type":"object","additionalProperties":false,"properties":{"reported_status":{"description":"Reported status of the custom domain from backing infrastructure.","type":"string","example":"INVALID"},"reason":{"description":"Reason why the custom domain may be in an erroneous state, reported from backing infrastructure.\n","type":"string","example":"CNAME points to '_acme-challenge.<prefix>.gateways.konghq.tech.' instead of '_acme-challenge.<prefix>.acme.gateways.konghq.tech.'\n"}},"readOnly":true,"title":"CustomDomainStateMetadata"},"entity_version":{"description":"Monotonically-increasing version count of the custom domain, to indicate the order of updates to the custom\ndomain.\n","type":"integer","example":1,"readOnly":true},"created_at":{"description":"An RFC-3339 timestamp representation of custom domain 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 custom domain update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"kind":{"$ref":"#/components/schemas/CustomDomainKind"}},"required":["id","control_plane_id","control_plane_geo","domain","state","state_metadata","entity_version","created_at","updated_at"],"title":"Custom Domain"},"CustomDomainOnlinePropertyStatus":{"description":"Set of available statuses for the online properties of a custom domain.","type":"string","enum":["verified","unverified"],"readOnly":true,"title":"Custom Domain Online Property Status"},"CustomDomainOnlineStatus":{"type":"object","properties":{"cname":{"$ref":"#/components/schemas/CustomDomainOnlinePropertyStatus"},"ssl":{"$ref":"#/components/schemas/CustomDomainOnlinePropertyStatus"}},"additionalProperties":false,"required":["cname","ssl"],"title":"Custom Domain Online Status"},"CreateConfigurationRequest":{"description":"Request schema for creating a configuration.\n","type":"object","properties":{"control_plane_id":{"$ref":"#/components/schemas/ControlPlaneId"},"control_plane_geo":{"$ref":"#/components/schemas/ControlPlaneGeo"},"version":{"$ref":"#/components/schemas/GatewayVersion"},"dataplane_groups":{"description":"List of data-plane groups that describe where to deploy instances, along with how many instances.","type":"array","items":{"$ref":"#/components/schemas/CreateConfigurationDataPlaneGroup"},"format":"set"},"kind":{"$ref":"#/components/schemas/ConfigurationKind"},"api_access":{"$ref":"#/components/schemas/ApiAccess"}},"additionalProperties":false,"required":["control_plane_id","control_plane_geo","dataplane_groups"],"title":"CreateConfigurationRequest"},"CreateCustomDomainRequest":{"description":"Request schema for creating a custom domain in the global API.","type":"object","properties":{"control_plane_id":{"$ref":"#/components/schemas/ControlPlaneId"},"control_plane_geo":{"$ref":"#/components/schemas/ControlPlaneGeo"},"domain":{"$ref":"#/components/schemas/CustomDomainName"},"kind":{"$ref":"#/components/schemas/CustomDomainKind"}},"additionalProperties":false,"required":["control_plane_id","control_plane_geo","domain"],"title":"CreateCustomDomainRequest"},"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"]},"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"},"ResourceConfigurationQualifier":{"description":"Enumeration of configuration qualifiers available for organization-wide configuration.","type":"string","enum":["data-plane-group-idle-timeout-minutes"]},"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},"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"},"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"],"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"},"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"],"x-terraform-transform-const":true},"capacity_config":{"$ref":"#/components/schemas/ManagedCacheCapacityConfig"}},"additionalProperties":false,"required":["kind","capacity_config"],"title":"CreateManagedCacheAddOnConfig"},"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"},"ConfigurationsFilterParameters":{"type":"object","properties":{"control_plane_id":{"$ref":"#/components/schemas/IDFieldFilter"},"control_plane_geo":{"$ref":"#/components/schemas/ControlPlaneGeoFieldFilter"}},"additionalProperties":false,"title":"ConfigurationsFilterParameters"},"CustomDomainsFilterParameters":{"type":"object","properties":{"control_plane_id":{"$ref":"#/components/schemas/IDFieldFilter"},"control_plane_geo":{"$ref":"#/components/schemas/ControlPlaneGeoFieldFilter"},"domain":{"$ref":"#/components/schemas/CloudGatewaysStringFieldFilterOverride"},"state":{"$ref":"#/components/schemas/CustomDomainStateFieldFilter"}},"additionalProperties":false,"title":"CustomDomainsFilterParameters"},"TransitGatewaysFilterParameters":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/CloudGatewaysStringFieldFilterOverride"},"state":{"$ref":"#/components/schemas/TransitGatewayStateFieldFilter"}},"additionalProperties":false,"title":"TransitGatewaysFilterParameters"},"PrivateDnsFilterParameters":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/CloudGatewaysStringFieldFilterOverride"},"state":{"$ref":"#/components/schemas/PrivateDnsStateFieldFilter"}},"additionalProperties":false,"title":"PrivateDnsFilterParameters"},"NetworksFilterParameters":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/CloudGatewaysStringFieldFilterOverride"},"state":{"$ref":"#/components/schemas/NetworkStateFieldFilter"}},"additionalProperties":false,"title":"NetworksFilterParameters"},"ProviderAccountsFilterParameters":{"type":"object","properties":{"provider":{"$ref":"#/components/schemas/CloudGatewaysStringFieldFilterOverride"}},"additionalProperties":false,"title":"ProviderAccountsFilterParameters"},"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"}}},"CustomDomainStateFieldFilter":{"oneOf":[{"$ref":"#/components/schemas/CustomDomainStateFieldEqualsFilter"},{"$ref":"#/components/schemas/CustomDomainStateFieldNotEqualsFilter"},{"$ref":"#/components/schemas/CustomDomainStateFieldOrEqualityFilter"}],"title":"CustomDomainStateFieldFilter"},"CustomDomainStateFieldEqualsFilter":{"description":"Filter custom domain state by exact match.","oneOf":[{"$ref":"#/components/schemas/CustomDomainState"},{"type":"object","title":"CustomDomainStateFieldEqualsComparison","properties":{"eq":{"$ref":"#/components/schemas/CustomDomainState"}},"required":["eq"]}],"title":"CustomDomainStateFieldEqualsFilter"},"CustomDomainStateFieldNotEqualsFilter":{"description":"Filter custom domain state by inequality match.","type":"object","properties":{"neq":{"$ref":"#/components/schemas/CustomDomainState"}},"required":["neq"],"title":"CustomDomainStateFieldNotEqualsFilter","x-examples":{"example-1":{"neq":"ready"}}},"CustomDomainStateFieldOrEqualityFilter":{"description":"Filter custom domain state 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":"CustomDomainStateFieldOrEqualityFilter","x-examples":{"example-1":{"oeq":"ready,initializing"}}},"TransitGatewayStateFieldFilter":{"oneOf":[{"$ref":"#/components/schemas/TransitGatewayStateFieldEqualsFilter"},{"$ref":"#/components/schemas/TransitGatewayStateFieldNotEqualsFilter"},{"$ref":"#/components/schemas/TransitGatewayStateFieldOrEqualityFilter"}],"title":"TransitGatewayStateFieldFilter"},"TransitGatewayStateFieldEqualsFilter":{"description":"Filter transit-gateway state by exact match.","oneOf":[{"$ref":"#/components/schemas/TransitGatewayState"},{"type":"object","title":"TransitGatewayStateFieldEqualsComparison","properties":{"eq":{"$ref":"#/components/schemas/TransitGatewayState"}},"required":["eq"]}],"title":"TransitGatewayStateFieldEqualsFilter","x-examples":{"example-1":"ready","example-2":{"eq":"ready"}}},"TransitGatewayStateFieldNotEqualsFilter":{"description":"Filter transit-gateway state by inequality match.","type":"object","properties":{"neq":{"$ref":"#/components/schemas/TransitGatewayState"}},"required":["neq"],"title":"TransitGatewayStateFieldNotEqualsFilter","x-examples":{"example-1":{"neq":"ready"}}},"TransitGatewayStateFieldOrEqualityFilter":{"description":"Filter transit-gateway state 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":"TransitGatewayStateFieldOrEqualityFilter","x-examples":{"example-1":{"oeq":"ready,initializing"}}},"PrivateDnsStateFieldFilter":{"oneOf":[{"$ref":"#/components/schemas/PrivateDnsStateFieldEqualsFilter"},{"$ref":"#/components/schemas/PrivateDnsStateFieldNotEqualsFilter"},{"$ref":"#/components/schemas/PrivateDnsStateFieldOrEqualityFilter"}],"title":"PrivateDnsStateFieldFilter"},"PrivateDnsStateFieldEqualsFilter":{"description":"Filter Private DNS state by exact match.","oneOf":[{"$ref":"#/components/schemas/PrivateDnsState"},{"type":"object","title":"PrivateDnsStateFieldEqualsComparison","properties":{"eq":{"$ref":"#/components/schemas/PrivateDnsState"}},"required":["eq"]}],"title":"PrivateDnsStateFieldEqualsFilter","x-examples":{"example-1":"ready","example-2":{"eq":"ready"}}},"PrivateDnsStateFieldNotEqualsFilter":{"description":"Filter private-dns state by inequality match.","type":"object","properties":{"neq":{"$ref":"#/components/schemas/PrivateDnsState"}},"required":["neq"],"title":"PrivateDnsStateFieldNotEqualsFilter","x-examples":{"example-1":{"neq":"ready"}}},"PrivateDnsStateFieldOrEqualityFilter":{"description":"Filter Private DNS state 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":"PrivateDnsStateFieldOrEqualityFilter","x-examples":{"example-1":{"oeq":"ready,initializing"}}},"IDFieldFilter":{"description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`","type":"object","properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=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"}},"additionalProperties":false,"x-examples":{"example-1":{"neq":"not-this-value","oeq":"some-value,some-other-value"},"example-2":{"eq":"some-value"}}},"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"}}},"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"},"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"},"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"}}}]},"UuidFieldFilter":{"description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`","type":"object","properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"}},"additionalProperties":false,"x-examples":{"example-1":{"oeq":"some-value,some-other-value","neq":"not-this-value"},"example-2":{"eq":"some-value"}}}},"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>."}},"ConfigurationConflictExample":{"value":{"status":409,"title":"Conflict","instance":"konnect:trace:2822394689570210664","detail":"Proposed cloud gateway configuration and current cloud gateway configuration are identical."}},"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"}]}},"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."}},"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":{"RetrieveCloudGatewaysAvailabilityDocumentResponse":{"description":"Response format for retrieving the cloud gateways availability JSON document.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityDocument"}}}},"ListNetworkConfigurationReferencesResponse":{"description":"A paginated list for a collection of configurations that reference a network.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/NetworkConfigurationReference"}}},"required":["meta","data"],"title":"ListNetworkConfigurationReferencesResponse"}}}},"ListConfigurationsResponse":{"description":"A paginated list for a collection of configurations.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ConfigurationManifest"}}},"required":["meta","data"],"title":"ListConfigurationsResponse"}}}},"RetrieveConfigurationResponse":{"description":"Response format for retrieving a configuration by ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationManifest"}}}},"CreateConfigurationResponse":{"description":"Response format for creating a configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationManifest"}}}},"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"}}}},"CreatePrivateDnsResponse":{"description":"Response format for creating a Private DNS.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateDnsResponse"}}}},"PatchPrivateDnsResponse":{"description":"Response format for updating a Private DNS.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateDnsResponse"}}}},"ListPrivateDnsResponse":{"description":"A paginated list for a collection of Private DNS for a network.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PrivateDnsResponse"}}},"required":["meta","data"],"title":"ListPrivateDnsResponse"}}}},"RetrievePrivateDnsResponse":{"description":"Response format for retrieving a Private DNS.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateDnsResponse"}}}},"CreateTransitGatewayResponse":{"description":"Response format for creating a transit gateway.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransitGatewayResponse"}}}},"PatchTransitGatewayResponse":{"description":"Response format for updating a transit gateway.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AwsResourceEndpointGatewayResponse"},{"$ref":"#/components/schemas/AwsTransitGatewayResponse"}]}}}},"ListTransitGatewaysResponse":{"description":"A paginated list for a collection of transit gateways for a network.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TransitGatewayResponse"}}},"required":["meta","data"],"title":"ListTransitGatewaysResponse"}}}},"RetrieveTransitGatewayResponse":{"description":"Response format for retrieving a transit gateway.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransitGatewayResponse"}}}},"ListProviderAccountsResponse":{"description":"A paginated list for a collection of provider accounts.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ProviderAccount"}}},"required":["meta","data"],"title":"ListCloudGatewayProviderAccountsResponse"}}}},"RetrieveProviderAccountResponse":{"description":"Response format for retrieving a provider account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderAccount"}}}},"CreateCustomDomainResponse":{"description":"Response format for creating a custom domain for a control-plane in the global API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDomain"}}}},"RetrieveCustomDomainResponse":{"description":"Response format for retrieving a custom domain for a control-plane.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDomain"}}}},"ListCustomDomainsResponse":{"description":"A paginated list for a collection of custom domains.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomDomain"}}},"required":["meta","data"],"title":"ListGlobalCustomDomainsResponse"}}}},"RetrieveCustomDomainOnlineStatusResponse":{"description":"Response format for retrieving the CNAME and SSL status of a custom domain.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDomainOnlineStatus"}}}},"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"}}}},"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"}}}}},"CloudGatewaysConflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"Configuration Conflict":{"$ref":"#/components/examples/ConfigurationConflictExample"}}}}},"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"}}}},"RetrieveResourceConfigurationResponse":{"description":"Response format for retrieving a resource configuration for an organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConfiguration"}}}},"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"}}}},"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":"Data-Plane Group Configurations"},{"name":"Networks"},{"name":"Transit Gateways"},{"name":"Private DNS"},{"name":"Add-Ons"},{"name":"Provider Accounts"},{"name":"Custom Domains"},{"name":"Cloud Gateways Resource Quotas"},{"name":"Resource Configurations"},{"name":"Resource Availability"}],"security":[{"konnectAccessToken":[]},{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
