Create Network

Creates a new network for a given provider account.

post
https://global.api.konghq.com/v2/cloud-gateways/networks

Body

application/json

CreateNetworkRequest

Request schema for creating a network.

* Additional properties are NOT allowed.
namestringrequired

Human-readable name of the network.

Example:us-east-2 network

cloud_gateway_provider_account_idstring(uuid)required

Example:929b2449-c69f-44c4-b6ad-9ecec6f811ae

regionstringrequired

Region ID for cloud provider region.

Example:us-east-2

availability_zonesarray[string]required

List of availability zones that the network is attached to.

Example:["use2-az1","use2-az2","use2-az3"]

cidr_blockstringrequired

CIDR block configuration for the network.

Example:10.0.0.0/8

statestring

Initial state for creating a network.

Allowed values:initializingoffline

Default:initializing

Response

application/json

Response format for creating a network.

Network

Object containing information about a network to be used in configurations.

idstring(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

namestringrequired

Human-readable name of the network.

Example:us-east-2 network

defaultbooleanrequired

Whether the network is a default network or not. Default networks are Networks that are created
automatically by Konnect when an organization is linked to a provider account.

Example:false

cloud_gateway_provider_account_idstring(uuid)required

Example:929b2449-c69f-44c4-b6ad-9ecec6f811ae

regionstringrequired

Region ID for cloud provider region.

Example:us-east-2

availability_zonesarray[string]required

List of availability zones that the network is attached to.

Example:["use2-az1","use2-az2","use2-az3"]

cidr_blockstringrequired

CIDR block configuration for the network.

Example:10.0.0.0/8

staterequiredread-only

State of the network.

Allowed values:createdinitializingofflinereadyterminatingterminated

state_metadataobjectread-only

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

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

Metadata describing attributes returned by cloud-provider for the network.

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

The number of transit gateways attached to this network.

Example:0

configuration_reference_countintegerrequiredread-only

The number of configurations that reference this network.

Example:0

entity_versionintegerrequiredread-only

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

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of network creation date.

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

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of network update date.

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

post/cloud-gateways/networks

Body

{ "name": "us-east-2 network", "cloud_gateway_provider_account_id": "929b2449-c69f-44c4-b6ad-9ecec6f811ae", "region": "us-east-2", "availability_zones": [ "use2-az1", "use2-az2", "use2-az3" ], "cidr_block": "10.0.0.0/8" }
 
application/json

Get Network

Retrieves a network by ID.

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

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

Response format for retrieving a network.

Network

Object containing information about a network to be used in configurations.

idstring(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

namestringrequired

Human-readable name of the network.

Example:us-east-2 network

defaultbooleanrequired

Whether the network is a default network or not. Default networks are Networks that are created
automatically by Konnect when an organization is linked to a provider account.

Example:false

cloud_gateway_provider_account_idstring(uuid)required

Example:929b2449-c69f-44c4-b6ad-9ecec6f811ae

regionstringrequired

Region ID for cloud provider region.

Example:us-east-2

availability_zonesarray[string]required

List of availability zones that the network is attached to.

Example:["use2-az1","use2-az2","use2-az3"]

cidr_blockstringrequired

CIDR block configuration for the network.

Example:10.0.0.0/8

staterequiredread-only

State of the network.

Allowed values:createdinitializingofflinereadyterminatingterminated

state_metadataobjectread-only

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

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

Metadata describing attributes returned by cloud-provider for the network.

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

The number of transit gateways attached to this network.

Example:0

configuration_reference_countintegerrequiredread-only

The number of configurations that reference this network.

Example:0

entity_versionintegerrequiredread-only

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

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of network creation date.

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

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of network update date.

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

get/cloud-gateways/networks/{networkId}
 
application/json

Update Network

Updates a network by ID.

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

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

PatchNetworkRequest

Request schema for updating a network.

* Additional properties are NOT allowed.
namestring

Human-readable name of the network.

Example:us-east-2 network

Response

application/json

Response format for patching a network.

Network

Object containing information about a network to be used in configurations.

idstring(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

namestringrequired

Human-readable name of the network.

Example:us-east-2 network

defaultbooleanrequired

Whether the network is a default network or not. Default networks are Networks that are created
automatically by Konnect when an organization is linked to a provider account.

Example:false

cloud_gateway_provider_account_idstring(uuid)required

Example:929b2449-c69f-44c4-b6ad-9ecec6f811ae

regionstringrequired

Region ID for cloud provider region.

Example:us-east-2

availability_zonesarray[string]required

List of availability zones that the network is attached to.

Example:["use2-az1","use2-az2","use2-az3"]

cidr_blockstringrequired

CIDR block configuration for the network.

Example:10.0.0.0/8

staterequiredread-only

State of the network.

Allowed values:createdinitializingofflinereadyterminatingterminated

state_metadataobjectread-only

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

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

Metadata describing attributes returned by cloud-provider for the network.

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

The number of transit gateways attached to this network.

Example:0

configuration_reference_countintegerrequiredread-only

The number of configurations that reference this network.

Example:0

entity_versionintegerrequiredread-only

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

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of network creation date.

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

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of network update date.

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

patch/cloud-gateways/networks/{networkId}

Body

{}
 
application/json

Delete Network

Deletes a network by ID.

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

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

No Content

delete/cloud-gateways/networks/{networkId}
 

List Network Configuration References

Returns a paginated collection of configurations that reference a network.

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

Query 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 configurations that reference a network.

ListNetworkConfigurationReferencesResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Object containing information about a control-plane’s cloud-gateways configuration.

Show Child Parameters
get/cloud-gateways/networks/{networkId}/configuration-references
 
application/json