Data-Plane Group Configurations
List Configurations
Returns a paginated collection of dedicated configurations or serverless 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
One OfObject containing information about a control-plane’s cloud-gateways configuration.
Show Child Parameters
Authentication
Query Parameters
Create Configuration
Creates a new dedicated or serverless 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.
One OfProvisioning backend to use for deploying data-plane groups.
Allowed values:dedicated.v0
ID of the control-plane this configuration belongs to.
Example:b5922611-a763-499e-8d86-5643de122768
Set of control-plane geos supported for deploying cloud-gateways configurations.
Allowed values:useuaumeinsg
Gateway version to configure data-plane groups with.
Match pattern:^(\d)+(\.(\d)+)?$
Example:3.2
Object that describes where to deploy a dedicated gateway, along with how many instances.
Show Child Parameters
Type of API access dataplane groups will support for a configuration.
Allowed values:privateprivate+publicpublic
Default:private+public
Response
application/json
Response
Response format for creating a configuration.
Configuration
Object containing information about a control-plane’s cloud-gateways configuration.
One OfID of the configuration.
Example:f521675a-af6b-4684-be7b-43bc27b20543
Allowed values:dedicated.v0
ID of the control-plane a configuration belongs to.
Example:b5922611-a763-499e-8d86-5643de122768
Set of control-plane geos supported for deploying cloud-gateways configurations.
Allowed values:useuaumeinsg
Gateway version the gateway configuration targets.
Match pattern:^(\d)+(\.(\d)+)?$
Example:3.2
Type of API access dataplane groups will support for a configuration.
Allowed values:privateprivate+publicpublic
Default: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 dedicated data-plane groups currently pointed to a configuration.
Show Child Parameters
Positive, monotonically increasing version integer, to serialize configuration changes.
Example:1
An ISO-8604 timestamp representation of configuration creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8604 timestamp representation of configuration update date.
Example:2022-11-04T20:10:06.927Z
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.
One OfID of the configuration.
Example:f521675a-af6b-4684-be7b-43bc27b20543
Allowed values:dedicated.v0
ID of the control-plane a configuration belongs to.
Example:b5922611-a763-499e-8d86-5643de122768
Set of control-plane geos supported for deploying cloud-gateways configurations.
Allowed values:useuaumeinsg
Gateway version the gateway configuration targets.
Match pattern:^(\d)+(\.(\d)+)?$
Example:3.2
Type of API access dataplane groups will support for a configuration.
Allowed values:privateprivate+publicpublic
Default: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 dedicated data-plane groups currently pointed to a configuration.
Show Child Parameters
Positive, monotonically increasing version integer, to serialize configuration changes.
Example:1
An ISO-8604 timestamp representation of configuration creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8604 timestamp representation of configuration update date.
Example:2022-11-04T20:10:06.927Z