Delete Transit Gateway

Deletes a transit gateway by ID for a given network.

delete
https://global.api.konghq.com/v2/cloud-gateways/networks/{networkId}/transit-gateways/{transitGatewayId}

Path Parameters

networkIdstring(uuid)required

The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695

transitGatewayIdstring(uuid)requiredread-only

The ID of the transit gateway to operate on.

Example:0850820b-d153-4a2a-b9be-7d2204779139

Response

No Content

delete/cloud-gateways/networks/{networkId}/transit-gateways/{transitGatewayId}
 

Private DNS

List Private DNS

Returns a paginated collection of Private DNS for a given network.

get
https://global.api.konghq.com/v2/cloud-gateways/networks/{networkId}/private-dns

Query Parameters

filterobject

Filters supported for Private DNS.

* Additional properties are NOT allowed.
Show Child Parameters
page[size]integer

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

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Path Parameters

networkIdstring(uuid)required

The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695

Response

application/json

A paginated list for a collection of Private DNS for a network.

ListPrivateDnsResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataOne Of
arrayrequired
AwsPrivateHostedZoneResponseobject
Show Child Parameters
get/cloud-gateways/networks/{networkId}/private-dns
 
application/json

Create Private DNS

Creates a new Private DNS for a given network.

post
https://global.api.konghq.com/v2/cloud-gateways/networks/{networkId}/private-dns

Path Parameters

networkIdstring(uuid)required

The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695

Body

application/json

CreatePrivateDnsRequest

Request schema for creating a Private DNS.

namestring

Human-readable name of the Private DNS.

Example:us-east-2 private dns

private_dns_attachment_configOne Of
AWS Private Hosted Zone Attachment Configobject
* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Response format for creating a Private DNS.

PrivateDnsResponse

PrivateDnsResponse
One Of
idstring(uuid)requiredread-only

Example:1850820b-c69f-4a2a-b9be-bbcdbc5cd618

statestringrequired

The current state of the Private DNS attachment. Possible values:

  • created - The attachment has been created but is not attached to Private DNS.
  • initializing - The attachment is in the process of being initialized and is setting up necessary resources.
  • pending-association The attachment request is awaiting association to the cloud provider infrastructure in order for provisioning to proceed.
  • ready - The attachment is fully operational and can route traffic as configured.
  • error - The attachment is in an error state, and is not operational.
  • terminating - The attachment is in the process of being deleted.
  • terminated - The attachment has been fully deleted and is no longer available.

Allowed values:createdinitializingpending-associationreadyerrorterminatingterminated

state_metadataobjectrequired

Metadata describing the backing state of the Private Dns and why it may be in an erroneous state.

* Additional properties are NOT allowed.
Show Child Parameters
entity_versionintegerrequiredread-only

Monotonically-increasing version count of the Private DNS, to indicate the order of updates to the
Private DNS.

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of Private DNS creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of Private DNS update date.

Example:2022-11-04T20:10:06.927Z

namestringrequired

Human-readable name of the Private DNS.

Example:us-east-2 private dns

private_dns_attachment_configobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
post/cloud-gateways/networks/{networkId}/private-dns

Body

{}
 
application/json

Get Private DNS

Retrieves a Private DNS by ID for a given network.

get
https://global.api.konghq.com/v2/cloud-gateways/networks/{networkId}/private-dns/{privateDnsId}

Path Parameters

networkIdstring(uuid)required

The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695

privateDnsIdstring(uuid)requiredread-only

The ID of the Private DNS to operate on.

Example:1850820b-c69f-4a2a-b9be-bbcdbc5cd618

Response

application/json

Response format for retrieving a Private DNS.

PrivateDnsResponse

PrivateDnsResponse
One Of
idstring(uuid)requiredread-only

Example:1850820b-c69f-4a2a-b9be-bbcdbc5cd618

statestringrequired

The current state of the Private DNS attachment. Possible values:

  • created - The attachment has been created but is not attached to Private DNS.
  • initializing - The attachment is in the process of being initialized and is setting up necessary resources.
  • pending-association The attachment request is awaiting association to the cloud provider infrastructure in order for provisioning to proceed.
  • ready - The attachment is fully operational and can route traffic as configured.
  • error - The attachment is in an error state, and is not operational.
  • terminating - The attachment is in the process of being deleted.
  • terminated - The attachment has been fully deleted and is no longer available.

Allowed values:createdinitializingpending-associationreadyerrorterminatingterminated

state_metadataobjectrequired

Metadata describing the backing state of the Private Dns and why it may be in an erroneous state.

* Additional properties are NOT allowed.
Show Child Parameters
entity_versionintegerrequiredread-only

Monotonically-increasing version count of the Private DNS, to indicate the order of updates to the
Private DNS.

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of Private DNS creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of Private DNS update date.

Example:2022-11-04T20:10:06.927Z

namestringrequired

Human-readable name of the Private DNS.

Example:us-east-2 private dns

private_dns_attachment_configobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
get/cloud-gateways/networks/{networkId}/private-dns/{privateDnsId}
 
application/json