0.0.1OAS 3.0

Serverless Cloud Gateways Manager API

API Base URL
  • Server 1:https://global.api.konghq.com/v0

    US Public API

Security
personalAccessToken (http)

The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.
You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.
The PAT token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'

systemAccountAccessToken (http)

The system account access token is meant for automations and integrations that are not directly associated with a human identity.
You can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.
The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'

Additional Information
Contact Kong

Serverless Cloud Gateways

Update the serverless cloud gateway

Update an individual serverless cloud gateway.

patch
https://global.api.konghq.com/v0/serverless-cloud-gateways/{controlPlaneId}

Path Parameters

controlPlaneIdstring(uuid)required

Id of the Serverless Cloud Gateway control plane

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

Body

application/json

UpdateServerlessCloudGatewayRequest

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"}

Response

application/json

A response to updating a serverless cloud gateway.

ServerlessCloudGateway

A serverless cloud gateway

control_planeobjectrequired
Show Child Parameters
gateway_endpointstring(hostname)requiredread-only

Endpoint for the serverless cloud gateway.

Example:us-kong-4594857kpl.kongcloud.dev

created_atstring(date-time)requiredread-only

Example:2023-01-11T02:30:42.227Z

updated_atstring(date-time)requiredread-only

Example:2023-01-11T02:30:42.227Z

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"}

patch/serverless-cloud-gateways/{controlPlaneId}

Body

{ "labels": { "test": "true" } }
 
application/json