API docs by Redocly

Konnect Cloud Gateways (2.0.0)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

Konnect API for managing cloud-gateways infrastructure.

Data-Plane Group Configurations

List Configurations

Returns a paginated collection of configurations across control-planes for an organization (restricted by permitted control-plane reads).

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (ConfigurationsFilterParameters)

Filters supported for configurations.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create Configuration

Creates a new configuration for a control-plane (restricted by permitted control-plane permissions for configurations). This request will replace any existing configuration for the requested control_plane_id and control_plane_geo by performing a diff. From this diff, new resources detected in the requested configuration will be added, resources not found in the request configuration but in the previous will be deleted, and resources found in both will be updated to the requested configuration. Networks referenced in this request that are in an offline state will automatically initialize (i.e. move to an initializing state).

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
Request Body schema: application/json
control_plane_id
required
string <uuid> (ControlPlaneId)
control_plane_geo
required
string (Control-Plane Geo)
Enum: "us" "eu" "au" "me" "in"

Set of control-plane geos supported for deploying cloud-gateways configurations.

version
required
string (Gateway Version)

Supported gateway version.

required
Array of objects (CreateConfigurationDataPlaneGroup)

List of data-plane groups that describe where to deploy instances, along with how many instances.

api_access
string (ApiAccess)
Default: "private+public"
Enum: "private" "public" "private+public"

Type of API access data-plane groups will support for a configuration.

Responses

Request samples

Content type
application/json
{
  • "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  • "control_plane_geo": "us",
  • "version": "3.2",
  • "dataplane_groups": [
    ],
  • "api_access": "private"
}

Response samples

Content type
application/json
{
  • "id": "edaf40f9-9fb0-4ffe-bb74-4e763a6bd471",
  • "version": "3.2",
  • "api_access": "private",
  • "dataplane_group_config": [
    ],
  • "dataplane_groups": [
    ],
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  • "control_plane_geo": "us"
}

Get Configuration

Retrieves a configuration by ID (restricted by permitted control-plane read).

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
configurationId
required
string <uuid> (ConfigurationId)
Example: edaf40f9-9fb0-4ffe-bb74-4e763a6bd471

The ID of the configuration to operate on.

Responses

Response samples

Content type
application/json
{
  • "id": "edaf40f9-9fb0-4ffe-bb74-4e763a6bd471",
  • "version": "3.2",
  • "api_access": "private",
  • "dataplane_group_config": [
    ],
  • "dataplane_groups": [
    ],
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  • "control_plane_geo": "us"
}

Networks

List Networks

Returns a paginated list of networks.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
query Parameters
object (NetworksFilterParameters)

Filters supported for networks.

page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create Network

Creates a new network for a given provider account.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
Request Body schema: application/json
name
required
string (Network Name)

Human-readable name of the network.

cloud_gateway_provider_account_id
required
string <uuid> (ProviderAccountId)
region
required
string (Provider Region ID)

Region ID for cloud provider region.

availability_zones
required
Array of strings (NetworkAvailabilityZones)

List of availability zones that the network is attached to.

cidr_block
required
string (Network CIDR Block)

CIDR block configuration for the network.

state
string (Network Create State)
Default: "initializing"
Enum: "initializing" "offline"

Initial state for creating a network.

Responses

Request samples

Content type
application/json
{
  • "name": "us-east-2 network",
  • "cloud_gateway_provider_account_id": "929b2449-c69f-44c4-b6ad-9ecec6f811ae",
  • "region": "us-east-2",
  • "availability_zones": [
    ],
  • "cidr_block": "10.0.0.0/8",
  • "state": "initializing"
}

Response samples

Content type
application/json
{
  • "id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
  • "name": "us-east-2 network",
  • "default": false,
  • "cloud_gateway_provider_account_id": "929b2449-c69f-44c4-b6ad-9ecec6f811ae",
  • "region": "us-east-2",
  • "availability_zones": [
    ],
  • "cidr_block": "10.0.0.0/8",
  • "state": "created",
  • "provider_metadata": {
    },
  • "transit_gateway_count": 0,
  • "configuration_reference_count": 0,
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Get Network

Retrieves a network by ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

Responses

Response samples

Content type
application/json
{
  • "id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
  • "name": "us-east-2 network",
  • "default": false,
  • "cloud_gateway_provider_account_id": "929b2449-c69f-44c4-b6ad-9ecec6f811ae",
  • "region": "us-east-2",
  • "availability_zones": [
    ],
  • "cidr_block": "10.0.0.0/8",
  • "state": "created",
  • "provider_metadata": {
    },
  • "transit_gateway_count": 0,
  • "configuration_reference_count": 0,
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Update Network

Updates a network by ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

Request Body schema: application/json
name
string (Network Name)

Human-readable name of the network.

Responses

Request samples

Content type
application/json
{
  • "name": "us-east-2 network"
}

Response samples

Content type
application/json
{
  • "id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
  • "name": "us-east-2 network",
  • "default": false,
  • "cloud_gateway_provider_account_id": "929b2449-c69f-44c4-b6ad-9ecec6f811ae",
  • "region": "us-east-2",
  • "availability_zones": [
    ],
  • "cidr_block": "10.0.0.0/8",
  • "state": "created",
  • "provider_metadata": {
    },
  • "transit_gateway_count": 0,
  • "configuration_reference_count": 0,
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete Network

Deletes a network by ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

Responses

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Invalid Request",
  • "instance": "konnect:trace:2822394689570210664",
  • "detail": "Invalid Parameters",
  • "invalid_parameters": [
    ]
}

Returns a paginated collection of configurations that reference a network.

List Network Configuration References

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Transit Gateways

List Transit Gateways

Returns a paginated collection of transit gateways for a given network.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

query Parameters
object (TransitGatewaysFilterParameters)

Filters supported for transit gateways.

page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create Transit Gateway

Creates a new transit gateway for a given network.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

Request Body schema: application/json
One of
name
required
string (Transit Gateway Name)

Human-readable name of the transit gateway.

Array of objects (Transit Gateway DNS Config)

List of mappings from remote DNS server IP address sets to proxied internal domains, for a transit gateway attachment.

cidr_blocks
required
Array of strings (Transit Gateway CIDR Blocks)

CIDR blocks for constructing a route table for the transit gateway, when attaching to the owning network.

required
object (AWS Transit Gateway Attachment Config)

Responses

Request samples

Content type
application/json
Example
{
  • "name": "us-east-2 transit gateway",
  • "dns_config": [
    ],
  • "cidr_blocks": [
    ],
  • "transit_gateway_attachment_config": {
    }
}

Response samples

Content type
application/json
Example
{
  • "name": "us-east-2 transit gateway",
  • "dns_config": [
    ],
  • "cidr_blocks": [
    ],
  • "transit_gateway_attachment_config": {
    },
  • "id": "0850820b-d153-4a2a-b9be-7d2204779139",
  • "state": "created",
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Get Transit Gateway

Retrieves a transit gateway by ID for a given network.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

transitGatewayId
required
string <uuid> (TransitGatewayId)
Example: 0850820b-d153-4a2a-b9be-7d2204779139

The ID of the transit gateway to operate on.

Responses

Response samples

Content type
application/json
Example
{
  • "name": "us-east-2 transit gateway",
  • "dns_config": [
    ],
  • "cidr_blocks": [
    ],
  • "transit_gateway_attachment_config": {
    },
  • "id": "0850820b-d153-4a2a-b9be-7d2204779139",
  • "state": "created",
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete Transit Gateway

Deletes a transit gateway by ID for a given network.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

transitGatewayId
required
string <uuid> (TransitGatewayId)
Example: 0850820b-d153-4a2a-b9be-7d2204779139

The ID of the transit gateway to operate on.

Responses

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Invalid Request",
  • "instance": "konnect:trace:2822394689570210664",
  • "detail": "Invalid Parameters",
  • "invalid_parameters": [
    ]
}

Provider Accounts

List Provider Accounts

Returns a a paginated collection of provider accounts for an organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
query Parameters
object (ProviderAccountsFilterParameters)

Filters supported for provider accounts.

page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Get Provider Account

Retrieves a provider account by ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
providerAccountId
required
string <uuid> (ProviderAccountId)
Example: 929b2449-c69f-44c4-b6ad-9ecec6f811ae

The ID of the provider account to operate on.

Responses

Response samples

Content type
application/json
{
  • "id": "929b2449-c69f-44c4-b6ad-9ecec6f811ae",
  • "provider": "aws",
  • "provider_account_id": "string",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Custom Domains

List Custom Domains

Returns a paginated collection of custom domains across control-planes for an organization (restricted by permitted control-plane reads).

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
query Parameters
object (CustomDomainsFilterParameters)

Filters supported for custom domains on the global API.

page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create Custom Domain

Creates a new custom domain for a control-plane (restricted by permitted control-plane associate-custom-domain action).

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
Request Body schema: application/json
control_plane_id
required
string <uuid> (ControlPlaneId)
control_plane_geo
required
string (Control-Plane Geo)
Enum: "us" "eu" "au" "me" "in"

Set of control-plane geos supported for deploying cloud-gateways configurations.

domain
required
string (Custom Domain Name)

Domain name of the custom domain.

Responses

Request samples

Content type
application/json
{
  • "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  • "control_plane_geo": "us",
  • "domain": "example.com"
}

Response samples

Content type
application/json
{
  • "id": "39ed3790-085d-4605-9627-f96d86aaf425",
  • "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  • "control_plane_geo": "us",
  • "domain": "example.com",
  • "certificate_id": "3b7cbeee-fbec-440e-a5ef-89e7dec3b9d0",
  • "sni_id": "a8f11ea8-af09-4422-9735-5d4f8910aba1",
  • "state": "created",
  • "state_metadata": {
    },
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Get Custom Domain

Retrieves a custom domain by ID (restricted by permitted control-plane reads).

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
customDomainId
required
string <uuid> (CustomDomainId)
Example: 39ed3790-085d-4605-9627-f96d86aaf425

ID of the custom domain to operate on.

Responses

Response samples

Content type
application/json
{
  • "id": "39ed3790-085d-4605-9627-f96d86aaf425",
  • "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  • "control_plane_geo": "us",
  • "domain": "example.com",
  • "certificate_id": "3b7cbeee-fbec-440e-a5ef-89e7dec3b9d0",
  • "sni_id": "a8f11ea8-af09-4422-9735-5d4f8910aba1",
  • "state": "created",
  • "state_metadata": {
    },
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete Custom Domain

Deletes a custom domain by ID (restricted by permitted control-plane reads).

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
customDomainId
required
string <uuid> (CustomDomainId)
Example: 39ed3790-085d-4605-9627-f96d86aaf425

ID of the custom domain to operate on.

Responses

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Invalid Request",
  • "instance": "konnect:trace:2822394689570210664",
  • "detail": "Invalid Parameters",
  • "invalid_parameters": [
    ]
}

Get Custom Domain Online Status

Retrieves the CNAME and SSL status of a custom domain.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
customDomainId
required
string <uuid> (CustomDomainId)
Example: 39ed3790-085d-4605-9627-f96d86aaf425

ID of the custom domain to operate on.

Responses

Response samples

Content type
application/json
{
  • "cname": "verified",
  • "ssl": "verified"
}

Cloud Gateways Resource Quotas

List Default Resource Quotas

Returns a paginated collection of default resource quotas for cloud-gateways, along with organizationally-defined overrides for those resource quotas.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

List Resource Quotas

Returns a paginated collection of resource quotas for an organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Get Resource Quota

Retrieves a resource quota by ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
resourceQuotaId
required
string <uuid> (ResourceQuotaId)
Example: 9678f205-49a1-47bb-82d9-d01cafa42a0d

The ID of the resource quota to operate on.

Responses

Response samples

Content type
application/json
{
  • "id": "9678f205-49a1-47bb-82d9-d01cafa42a0d",
  • "resource": "count/provider-accounts.per-provider",
  • "name": "Active Networks",
  • "description": "Across the organization, the aggregate number of active networks cannot exceed this value.",
  • "value": 2,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Resource Configurations

List Default Resource Configurations

Returns a paginated collection of default resource configurations for cloud-gateways, along with organizationally-defined overrides for those resource configurations. Resource configurations are settings that are applied to all cloud gateway resources in an organization. For example, the "data-plane-group-idle-timeout-minutes" resource configuration sets the idle timeout for all data plane groups in an organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

List Resource Configurations

Returns a paginated collection of resource configurations for an organization. Resource configurations are settings that are applied to all cloud gateway resources in an organization. For example, the "data-plane-group-idle-timeout-minutes" resource configuration sets the idle timeout for all data plane groups in an organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Get Resource Configuration

Retrieves a resource configuration by ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
resourceConfigurationId
required
string <uuid> (ResourceConfigurationId)
Example: 9678f205-49a1-47bb-82d9-d01cafa42a0d

The ID of the resource configuration to operate on.

Responses

Response samples

Content type
application/json
{
  • "id": "9678f205-49a1-47bb-82d9-d01cafa42a0d",
  • "qualifier": "data-plane-group-idle-timeout-minutes",
  • "value": 45
}

Resource Availability

Get Resource Availability JSON

Get Cloud Gateways Availability JSON document for describing cloud provider and region availability, pricing, gateway version availability, and instance type information.

Responses

Response samples

Content type
application/json
{
  • "versions": [
    ],
  • "instance_types": [
    ],
  • "providers": [
    ]
}