Serverless Configuration

object
idstring(uuid)requiredread-only

ID of the configuration.

Example:f521675a-af6b-4684-be7b-43bc27b20543

kindstringrequired

Allowed values:serverless.v0

control_plane_idstring(uuid)requiredread-only

ID of the control-plane a configuration belongs to.

Example:b5922611-a763-499e-8d86-5643de122768

control_plane_geostringrequired

Set of control-plane geos supported for deploying cloud-gateways configurations.

Allowed values:useuaumeinsg

dataplane_group_configarray[object]required

Object that describes where a serverless data-plane group will be deployed to.

* Additional properties are NOT allowed.
Show Child Parameters
dataplane_groupsarray[object]required

Object that describes a serverless data-plane group, deployed for a control-plane.

Show Child Parameters
entity_versionnumberrequiredread-only

Positive, monotonically increasing version integer, to serialize configuration changes.

Example:1

created_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of configuration creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of configuration update date.

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

Example

Serverless V1 Configuration

object
idstring(uuid)requiredread-only

ID of the configuration.

Example:f521675a-af6b-4684-be7b-43bc27b20543

kindstringrequired

Allowed values:serverless.v1

control_plane_idstring(uuid)requiredread-only

ID of the control-plane a configuration belongs to.

Example:b5922611-a763-499e-8d86-5643de122768

control_plane_geostringrequired

Set of control-plane geos supported for deploying cloud-gateways configurations.

Allowed values:useuaumeinsg

dataplane_group_configarray[object]required

Object that describes where a serverless v1 data-plane group will be deployed to, along with how many instances.

* Additional properties are NOT allowed.
Show Child Parameters
dataplane_groupsarray[object]required

Object that describes a serverless v1 data-plane group, deployed for a control-plane.

Show Child Parameters
entity_versionnumberrequiredread-only

Positive, monotonically increasing version integer, to serialize configuration changes.

Example:1

created_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of configuration creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of configuration update date.

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

Example

Configuration

object

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

One Of
idstring(uuid)requiredread-only

ID of the configuration.

Example:f521675a-af6b-4684-be7b-43bc27b20543

kindstringrequired

Allowed values:dedicated.v0

control_plane_idstring(uuid)requiredread-only

ID of the control-plane a configuration belongs to.

Example:b5922611-a763-499e-8d86-5643de122768

control_plane_geostringrequired

Set of control-plane geos supported for deploying cloud-gateways configurations.

Allowed values:useuaumeinsg

versionstringrequired

Gateway version the gateway configuration targets.

Match pattern:^(\d)+(\.(\d)+)?$

Example:3.2

api_accessstring

Type of API access dataplane groups will support for a configuration.

Allowed values:privateprivate+publicpublic

Default:private+public

dataplane_group_configarray[object]required

Object that describes where a data-plane group will be deployed to, along with how many instances.

* Additional properties are NOT allowed.
Show Child Parameters
dataplane_groupsarray[object]required

Object that describes the set of dedicated data-plane groups currently pointed to a configuration.

Show Child Parameters
entity_versionnumberrequiredread-only

Positive, monotonically increasing version integer, to serialize configuration changes.

Example:1

created_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of configuration creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of configuration update date.

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

Example

CreateCloudGatewayConfigurationDataplaneGroup

object

Object that describes where to deploy a dedicated gateway, along with how many instances.

* Additional properties are NOT allowed.
providerstringrequired

Name of cloud provider.

Allowed values:awsazuregcp

Example:aws

regionstringrequired

Region of cloud provider to deploy dedicated gateways to.

Example:us-east-2

cloud_gateway_network_idstring(uuid)required

Network ID data-plane group will be attached to.

autoscaleOne Of
required
Data-Plane Group Autoscale StaticobjectDEPRECATED

Object that describes the static autoscaling strategy. Deprecated in favor of the autopilot autoscaling strategy. Static autoscaling will be removed in a future version.

* Additional properties are NOT allowed.
Show Child Parameters
environmentarray[object]

Object that describes the environment configurations for a data-plane group. Env names must be prefixed by KONG_.

* Additional properties are NOT allowed.
Show Child Parameters
Example

ServerlessCreateDataPlaneGroup

object
* Additional properties are NOT allowed.
regionstringrequired

Region to deploy serverless gateways to.

Example:us

Example