UpdateServerlessCloudGatewayRequest

object

Schema to update a serverless cloud gateway.

* Additional properties are NOT allowed.
cp_prefixstring

The prefix of the serverless cloud gateway CP.

Example:518da50bf7

cp_regionstring

The control plane region.

Allowed values:useuau

Example:us

labelsobject

Labels to facilitate tagged search on serverless cloud gateways. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.

Example:{"env":"test"}

Example

Labels

object

Labels to facilitate tagged search on serverless cloud gateways. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.

Example

Control plane region

string

The control plane region.

Allowed values:useuau

Example

Control plane

object
idstring(uuid)required

ID of the serverless cloud gateway CP.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

prefixstringrequired

The prefix of the serverless cloud gateway CP.

Example:518da50bf7

regionstringrequired

The control plane region.

Allowed values:useuau

Example:us

Example

Error

object

standard error

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

typestringread-only

The error type.

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example