Konnect Cloud Gateways (3.0.0)

Download OpenAPI specification:Download

Konnect API for managing cloud-gateways infrastructure.

Data-Plane Group Configurations

List Configurations

Returns a paginated collection of dedicated configurations or serverless 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

200
400
401
403

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "f521675a-af6b-4684-be7b-43bc27b20543",
"kind": "dedicated.v0",
"control_plane_id": "b5922611-a763-499e-8d86-5643de122768",
"control_plane_geo": "us",
"version": "3.2",
"api_access": "private",
"dataplane_group_config": [{"provider": "aws",
"region": "us-east-2",
"cloud_gateway_network_id": "aa0b1b44-10eb-483d-8063-661e802782d9",
"autoscale": {"kind": "static",
"instance_type": "small",
"requested_instances": 3
},
"environment": [{"name": "KONG_LOG_LEVEL",
"value": "INFO"
}
]
}
],
"dataplane_groups": [{"id": "14a74117-868a-4859-bf6c-eb2fe301a6ab",
"provider": "aws",
"region": "us-east-2",
"autoscale": {"kind": "static",
"instance_type": "small",
"requested_instances": 3
},
"environment": [{"name": "KONG_LOG_LEVEL",
"value": "INFO"
}
],
"cloud_gateway_network_id": "aa0b1b44-10eb-483d-8063-661e802782d9",
"state": "created",
"private_ip_addresses": ["string"
],
"egress_ip_addresses": ["string"
],
"hostnames": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
],
"entity_version": 1,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}

Create Configuration

Creates a new dedicated or serverless 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

One of

kind required	string Enum: "dedicated.v0" "serverless.v0" Provisioning backend to use for deploying data-plane groups.
control_plane_id required	string <uuid> ID of the control-plane this configuration belongs to.
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^(\d)+(\.(\d)+)?$ Gateway version to configure data-plane groups with.
required	Array of objects (CreateCloudGatewayConfigurationDataplaneGroup) List of data-plane groups that describe where to deploy instances, along with how many instances.
api_access	string (CloudGatewayApiAccess) Default: "private+public" Enum: "private" "private+public" "public" Type of API access dataplane groups will support for a configuration.

Responses

Request samples

Payload

Content type

application/json

{"kind": "serverless.v0",
"control_plane_id": "b5922611-a763-499e-8d86-5643de122768",
"control_plane_geo": "us",
"dataplane_groups": [{"region": "us"
}
]
}

Response samples

Content type

application/json

Example

Dedicated Configuration

{"id": "f521675a-af6b-4684-be7b-43bc27b20543",
"kind": "dedicated.v0",
"control_plane_id": "b5922611-a763-499e-8d86-5643de122768",
"control_plane_geo": "us",
"version": "3.2",
"api_access": "private",
"dataplane_group_config": [{"provider": "aws",
"region": "us-east-2",
"cloud_gateway_network_id": "aa0b1b44-10eb-483d-8063-661e802782d9",
"autoscale": {"kind": "static",
"instance_type": "small",
"requested_instances": 3
},
"environment": [{"name": "KONG_LOG_LEVEL",
"value": "INFO"
}
]
}
],
"dataplane_groups": [{"id": "14a74117-868a-4859-bf6c-eb2fe301a6ab",
"provider": "aws",
"region": "us-east-2",
"autoscale": {"kind": "static",
"instance_type": "small",
"requested_instances": 3
},
"environment": [{"name": "KONG_LOG_LEVEL",
"value": "INFO"
}
],
"cloud_gateway_network_id": "aa0b1b44-10eb-483d-8063-661e802782d9",
"state": "created",
"private_ip_addresses": ["string"
],
"egress_ip_addresses": ["string"
],
"hostnames": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
],
"entity_version": 1,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

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

200
401
403
404

Content type

application/json

Example

Dedicated Configuration

{"id": "f521675a-af6b-4684-be7b-43bc27b20543",
"kind": "dedicated.v0",
"control_plane_id": "b5922611-a763-499e-8d86-5643de122768",
"control_plane_geo": "us",
"version": "3.2",
"api_access": "private",
"dataplane_group_config": [{"provider": "aws",
"region": "us-east-2",
"cloud_gateway_network_id": "aa0b1b44-10eb-483d-8063-661e802782d9",
"autoscale": {"kind": "static",
"instance_type": "small",
"requested_instances": 3
},
"environment": [{"name": "KONG_LOG_LEVEL",
"value": "INFO"
}
]
}
],
"dataplane_groups": [{"id": "14a74117-868a-4859-bf6c-eb2fe301a6ab",
"provider": "aws",
"region": "us-east-2",
"autoscale": {"kind": "static",
"instance_type": "small",
"requested_instances": 3
},
"environment": [{"name": "KONG_LOG_LEVEL",
"value": "INFO"
}
],
"cloud_gateway_network_id": "aa0b1b44-10eb-483d-8063-661e802782d9",
"state": "created",
"private_ip_addresses": ["string"
],
"egress_ip_addresses": ["string"
],
"hostnames": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
],
"entity_version": 1,
"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

200
400
401
403
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "39ed3790-085d-4605-9627-f96d86aaf425",
"kind": "dedicated.v0",
"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": {"reported_status": "INVALID",
"reason": "CNAME points to '_acme-challenge.<prefix>.gateways.konghq.tech.' instead of '_acme-challenge.<prefix>.acme.gateways.konghq.tech.'\n"
},
"entity_version": 1,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}

Create Custom Domain

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

Authorizations:

konnectAccessTokenpersonalAccessTokensystemAccountAccessToken

Request Body schema: application/json

kind required	string Enum: "dedicated.v0" "serverless.v0"
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

Payload

Content type

application/json

{"kind": "dedicated.v0",
"control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
"control_plane_geo": "us",
"domain": "example.com"
}

Response samples

Content type

application/json

Example

Dedicated Custom Domain

{"id": "39ed3790-085d-4605-9627-f96d86aaf425",
"kind": "dedicated.v0",
"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": {"reported_status": "INVALID",
"reason": "CNAME points to '_acme-challenge.<prefix>.gateways.konghq.tech.' instead of '_acme-challenge.<prefix>.acme.gateways.konghq.tech.'\n"
},
"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

200
401
403
404

Content type

application/json

Example

Dedicated Custom Domain

{"id": "39ed3790-085d-4605-9627-f96d86aaf425",
"kind": "dedicated.v0",
"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": {"reported_status": "INVALID",
"reason": "CNAME points to '_acme-challenge.<prefix>.gateways.konghq.tech.' instead of '_acme-challenge.<prefix>.acme.gateways.konghq.tech.'\n"
},
"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

400
401
403
404

Content type

application/problem+json

Example

Network Name Length Exceeded

{"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
}
]
}

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

200
401
403
404

Content type

application/json

{"cname": "verified",
"ssl": "verified"
}