---
title: "Konnect Cloud Gateways"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-internal-2/versions/632c6593-7bb3-4379-86d5-b125ee68731b"
---

# 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/provider-accounts":{"post":{"operationId":"create-provider-account","summary":"Create Provider Account","description":"Creates a new provider account for an organization.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProviderAccountRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateProviderAccountResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/CloudGatewaysForbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Provider Accounts"]}},"/cloud-gateways/provider-accounts/{providerAccountId}":{"delete":{"operationId":"delete-provider-account","summary":"Delete Provider Account","description":"Deletes a provider account by ID.","parameters":[{"$ref":"#/components/parameters/ProviderAccountId"}],"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":["Provider Accounts"]}},"/cloud-gateways/resource-quotas":{"post":{"operationId":"create-resource-quota","summary":"Create Resource Quota","description":"Creates a new resource quota, scoped to a given resource, for an organization.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResourceQuotaRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateResourceQuotaResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Cloud Gateways Resource Quotas"]}},"/cloud-gateways/resource-quotas/{resourceQuotaId}":{"patch":{"operationId":"update-resource-quota","summary":"Update Resource Quota","description":"Updates a resource quota by ID.","parameters":[{"$ref":"#/components/parameters/ResourceQuotaId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchResourceQuotaRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/PatchResourceQuotasResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Cloud Gateways Resource Quotas"]}},"/cloud-gateways/resource-configurations":{"post":{"operationId":"create-resource-configuration","summary":"Create Resource Configuration","description":"Creates a new resource configuration for an organization.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResourceConfigurationRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateResourceConfigurationResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Resource Configurations"]}},"/cloud-gateways/resource-configurations/{resourceConfigurationId}":{"patch":{"operationId":"update-resource-configuration","summary":"Update Resource Configuration","description":"Updates a resource configuration by ID.","parameters":[{"$ref":"#/components/parameters/ResourceConfigurationId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchResourceConfigurationRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/PatchResourceConfigurationsResponse"},"400":{"$ref":"#/components/responses/CloudGatewaysBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Resource Configurations"]}}},"components":{"parameters":{"ProviderAccountId":{"name":"providerAccountId","in":"path","description":"The ID of the provider account to operate on.","required":true,"schema":{"$ref":"#/components/schemas/ProviderAccountId"}},"ResourceConfigurationId":{"name":"resourceConfigurationId","in":"path","description":"The ID of the resource configuration to operate on.","required":true,"schema":{"$ref":"#/components/schemas/ResourceConfigurationId"}},"ResourceQuotaId":{"name":"resourceQuotaId","in":"path","description":"The ID of the resource quota to operate on.","required":true,"schema":{"$ref":"#/components/schemas/ResourceQuotaId"}}},"schemas":{"ProviderAccountId":{"type":"string","format":"uuid","example":"929b2449-c69f-44c4-b6ad-9ecec6f811ae"},"ResourceQuotaId":{"type":"string","format":"uuid","example":"9678f205-49a1-47bb-82d9-d01cafa42a0d","readOnly":true},"ResourceConfigurationId":{"type":"string","format":"uuid","example":"9678f205-49a1-47bb-82d9-d01cafa42a0d","readOnly":true},"ProviderName":{"description":"Name of cloud provider.","type":"string","example":"aws","enum":["aws","azure","gcp"],"title":"Provider Name"},"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"},"CreateProviderAccountRequest":{"description":"Request schema for creating a provider account via automatic account vending.","type":"object","properties":{"provider":{"$ref":"#/components/schemas/ProviderName"}},"additionalProperties":false,"required":["provider"],"title":"CreateProviderAccountRequest"},"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"},"CreateResourceQuotaRequest":{"description":"Request schema for creating a resource quota for an organization.","type":"object","properties":{"resource":{"$ref":"#/components/schemas/ResourceQuotaQualifier"},"value":{"$ref":"#/components/schemas/ResourceQuotaValue"}},"additionalProperties":false,"required":["resource","value"],"title":"CreateResourceQuotaRequest"},"PatchResourceQuotaRequest":{"description":"Request schema for patching a resource quota for an organization.","type":"object","properties":{"value":{"$ref":"#/components/schemas/ResourceQuotaValue"}},"additionalProperties":false,"required":["value"],"title":"PatchResourceQuotaRequest"},"ResourceConfigurationQualifier":{"description":"Enumeration of configuration qualifiers available for organization-wide configuration.","type":"string","enum":["data-plane-group-idle-timeout-minutes"]},"ResourceConfigurationValue":{"description":"The value of this resource configuration.","type":"integer","example":45},"CreateResourceConfigurationRequest":{"description":"Request schema for creating a resource configuration for an organization.","type":"object","properties":{"qualifier":{"$ref":"#/components/schemas/ResourceConfigurationQualifier"},"value":{"$ref":"#/components/schemas/ResourceConfigurationValue"}},"additionalProperties":false,"required":["qualifier","value"],"title":"CreateResourceConfigurationRequest"},"PatchResourceConfigurationRequest":{"description":"Request schema for patching a resource configuration for an organization.","type":"object","properties":{"qualifier":{"$ref":"#/components/schemas/ResourceConfigurationQualifier"},"value":{"$ref":"#/components/schemas/ResourceConfigurationValue"}},"additionalProperties":false,"required":["qualifier","value"],"title":"PatchResourceConfigurationRequest"},"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"},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"ConflictError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":409},"title":{"example":"Conflict"},"type":{"example":"https://httpstatuses.com/409"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Conflict"}}}]}},"examples":{"PermissionDeniedExample":{"value":{"status":403,"title":"Forbidden","instance":"konnect:trace:2822394689570210664","detail":"You do not have permission to perform this action."}},"QuotaExceededExample":{"value":{"status":403,"title":"Quota Exceeded","instance":"konnect:trace:2822394689570210664","detail":"Maximum number of <quota name> exceeded. Max allowed: <quota value>."}},"NetworkNameLengthCheckBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"konnect:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"name","rule":"max_length","reason":"name must be shorter than or equal to 120 characters","maximum":120}]}},"TransitGatewayNameLengthCheckBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"konnect:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"name","rule":"max_length","reason":"name must be shorter than or equal to 120 characters","maximum":120}]}},"CustomDomainLengthCheckBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"konnect:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"domain","rule":"min_length","minimum":1,"reason":"domain must be longer than or equal to 1 characters"}]}},"ConfigurationApiAccessBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"konnect:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"api_access","rule":"enum","choices":["private","public","private+public"],"reason":"api_access must be one of the following values: private, public, private+public"}]}},"ConfigurationDataPlaneGroupStaticRequestedInstancesBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"konnect:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"dataplane_groups.0.autoscale.requested_instances","rule":"is_integer","reason":"dataplane_groups.0.autoscale.requested_instances must be an integer number"}]}},"ConfigurationDataPlaneGroupAutopilotBaseRpsBadRequestExample":{"value":{"status":400,"title":"Invalid Request","instance":"konnect:trace:2822394689570210664","detail":"Invalid Parameters","invalid_parameters":[{"field":"dataplane_groups.0.autoscale.base_rps","rule":"is_integer","reason":"dataplane_groups.0.autoscale.base_rps must be an integer number"}]}},"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":{"CreateProviderAccountResponse":{"description":"Response format for creating a provider account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderAccount"}}}},"CreateResourceQuotaResponse":{"description":"Response format for creating a resource quota for an organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceQuota"}}}},"PatchResourceQuotasResponse":{"description":"Response format for patching a resource quota for an organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceQuota"}}}},"CloudGatewaysBadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"Network Name Length Exceeded":{"$ref":"#/components/examples/NetworkNameLengthCheckBadRequestExample"},"Transit Gateway Name Length Exceeded":{"$ref":"#/components/examples/TransitGatewayNameLengthCheckBadRequestExample"},"Custom Domain Domain Length Too Short":{"$ref":"#/components/examples/CustomDomainLengthCheckBadRequestExample"},"Configuration Api Access Enum Validation":{"$ref":"#/components/examples/ConfigurationApiAccessBadRequestExample"},"Configuration Data-Plane Group Static Request Instances Minimum":{"$ref":"#/components/examples/ConfigurationDataPlaneGroupStaticRequestedInstancesBadRequestExample"},"Configuration Data-Plane Group Autopilot Base RPS Minimum":{"$ref":"#/components/examples/ConfigurationDataPlaneGroupAutopilotBaseRpsBadRequestExample"}}}}},"CloudGatewaysForbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"Permission Denied":{"$ref":"#/components/examples/PermissionDeniedExample"},"Quota Exceeded":{"$ref":"#/components/examples/QuotaExceededExample"}}}}},"CreateResourceConfigurationResponse":{"description":"Response format for creating a resource configuration for an organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConfiguration"}}}},"PatchResourceConfigurationsResponse":{"description":"Response format for patching a resource configuration for an organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConfiguration"}}}},"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":"Provider Accounts"},{"name":"Cloud Gateways Resource Quotas"},{"name":"Resource Configurations"}],"security":[{"konnectAccessToken":[]},{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
