Data-Plane Group Configurations
List Configurations
Returns a paginated collection of configurations across control-planes for an organization (restricted by
permitted control-plane reads).
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
Filters supported for configurations.
Show Child Parameters
Response
application/json
Response
A paginated list for a collection of configurations.
ListConfigurationsResponse
returns the pagination information
Show Child Parameters
Object containing information about a control-plane’s cloud-gateways configuration.
Show Child Parameters
Authentication
Query Parameters
Create Configuration
Creates a new 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).
Body
application/json
Body
CreateConfigurationRequest
Request schema for creating a configuration.
Example:0949471e-b759-45ba-87ab-ee63fb781388
Set of control-plane geos supported for deploying cloud-gateways configurations.
Allowed values:useuaumeinsg
Supported gateway version. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:3.2
Object that describes where to deploy a data-plane group, along with how many instances.
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
Type of API access data-plane groups will support for a configuration.
Allowed values:privatepublicprivate+public
Default:private+public
Example:private+public
Response
application/json
Response
Response format for creating a configuration.
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
Body
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