Get Network
Retrieves a network by ID.
Path Parameters
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
Response format for retrieving a network.
Network
Object containing information about a network to be used in configurations.
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695
Human-readable name of the network.
Example:us-east-2 network
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
Example:929b2449-c69f-44c4-b6ad-9ecec6f811ae
Region ID for cloud provider region.
Example:us-east-2
List of availability zones that the network is attached to.
Example:["use2-az1","use2-az2","use2-az3"]
CIDR block configuration for the network.
Example:10.0.0.0/8
State of the network.
Allowed values:createdinitializingofflinereadyterminatingterminated
Metadata describing the backing state of the network and why it may be in an erroneous state.
Show Child Parameters
Metadata describing attributes returned by cloud-provider for the network.
Show Child Parameters
The number of transit gateways attached to this network.
Example:0
The number of configurations that reference this network.
Example:0
Monotonically-increasing version count of the network, to indicate the order of updates to the network.
Example:1
An RFC-3339 timestamp representation of network creation date.
Example:2022-11-04T20:10:06.927Z
An RFC-3339 timestamp representation of network update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update Network
Updates a network by ID.
Path Parameters
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
Body
PatchNetworkRequest
Request schema for updating a network.
Human-readable name of the network.
Example:us-east-2 network
Response
application/json
Response
Response format for patching a network.
Network
Object containing information about a network to be used in configurations.
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695
Human-readable name of the network.
Example:us-east-2 network
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
Example:929b2449-c69f-44c4-b6ad-9ecec6f811ae
Region ID for cloud provider region.
Example:us-east-2
List of availability zones that the network is attached to.
Example:["use2-az1","use2-az2","use2-az3"]
CIDR block configuration for the network.
Example:10.0.0.0/8
State of the network.
Allowed values:createdinitializingofflinereadyterminatingterminated
Metadata describing the backing state of the network and why it may be in an erroneous state.
Show Child Parameters
Metadata describing attributes returned by cloud-provider for the network.
Show Child Parameters
The number of transit gateways attached to this network.
Example:0
The number of configurations that reference this network.
Example:0
Monotonically-increasing version count of the network, to indicate the order of updates to the network.
Example:1
An RFC-3339 timestamp representation of network creation date.
Example:2022-11-04T20:10:06.927Z
An RFC-3339 timestamp representation of network update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete Network
Deletes a network by ID.
Path Parameters
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
Response
No Content
Authentication
Path Parameters
List Network Configuration References
Returns a paginated collection of configurations that reference a network.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Path Parameters
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
A paginated list for a collection of configurations that reference a network.
ListNetworkConfigurationReferencesResponse
returns the pagination information
Show Child Parameters
Object containing information about a control-plane’s cloud-gateways configuration.