Get Configuration
Retrieves a configuration by ID (restricted by permitted control-plane read).
Path Parameters
The ID of the configuration to operate on.
Example:edaf40f9-9fb0-4ffe-bb74-4e763a6bd471
Response
application/json
Response
Response format for retrieving a configuration by ID.
Configuration
Object containing information about a control-plane’s cloud-gateways configuration.
Example:edaf40f9-9fb0-4ffe-bb74-4e763a6bd471
Supported gateway version. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:3.2
Type of API access data-plane groups will support for a configuration.
Allowed values:privatepublicprivate+public
Default:private+public
Example:private+public
Object that describes where a data-plane group will be deployed to, along with how many instances.
Show Child Parameters
Object that describes the set of data-plane groups currently pointed to this configuration.
Show Child Parameters
Pre-release Feature
This feature is currently in beta and is subject to change.
Kind of the Cloud Gateway deployment. If serverless.v1 is specified, the following fields
should be omitted (will be ignored if provided): autoscale, cloud_gateway_network_id, version.
Allowed values:dedicated.v0serverless.v1
Default:dedicated.v0
Positive, monotonically increasing version integer, to serialize configuration changes.
Example:1
An RFC-3339 timestamp representation of configuration creation date.
Example:2022-11-04T20:10:06.927Z
An RFC-3339 timestamp representation of configuration update date.
Example:2022-11-04T20:10:06.927Z
Example:0949471e-b759-45ba-87ab-ee63fb781388
Set of control-plane geos supported for deploying cloud-gateways configurations.
Allowed values:useuaumeinsg
Authentication
Path Parameters
Networks
List Networks
Returns a paginated list of networks.
Query Parameters
Filters supported for networks.
Show Child 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
Response
application/json
Response
A paginated list for a collection of networks.
ListNetworksResponse
returns the pagination information
Show Child Parameters
Object containing information about a network to be used in configurations.
Show Child Parameters
Authentication
Query Parameters
Create Network
Creates a new network for a given provider account.
Body
application/json
Body
CreateNetworkRequest
Request schema for creating a network.
Human-readable name of the network.
Example:us-east-2 network
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
Initial state for creating a network.
Allowed values:initializingoffline
Default:initializing
Response
application/json
Response
Response format for creating 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
Body
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