Serverless Cloud Gateways

List Serverless cloud gateways

Pre-release Endpoint
This endpoint is currently in beta and is subject to change.

Returns an array of serverless cloud gateways objects.

get
https://global.api.konghq.com/v0/serverless-cloud-gateways

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

labelsstring

Filter serverless cloud gateways in the response by associated labels.

Example:filter[labels][eq]=env:prod

Response

application/json

A paginated list response for a collection of serverless cloud gateways.

ListServerlessCloudGatewaysResponse

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

A serverless cloud gateway

Show Child Parameters
get/serverless-cloud-gateways
 
application/json

Create a new serverless cloud gateway

Pre-release Endpoint
This endpoint is currently in beta and is subject to change.

Create a new serverless cloud gateway

post
https://global.api.konghq.com/v0/serverless-cloud-gateways

Body

application/json

CreateServerlessCloudGatewayRequest

Schema to create a serverless cloud gateway.

* Additional properties are NOT allowed.
control_planeobjectrequired
Show Child Parameters
cluster_certstringrequired

The cluster certificate (public key).

Example:-----BEGIN CERTIFICATE----- MIICRDCCAa2gAwIBAgIBADANBgkqhkiG9w0BAQ0FADA/MQswCQYDVQQGEwJ1czEL MAkGA1UECAwCVFgxDTALBgNVBAoMBFRlc3QxFDASBgNVBAMMC2V4YW1wbGUuY29t MB4XDTI0MDQyNjA5NTA1OVoXDTI1MDQyNjA5NTA1OVowPzELMAkGA1UEBhMCdXMx CzAJBgNVBAgMAlRYMQ0wCwYDVQQKDARUZXN0MRQwEgYDVQQDDAtleGFtcGxlLmNv bTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA8FaJZmPsthBT1XkTyqUJiuQV 4p4KaLpNMioNQtIdeGKFXelmZlVfW0bfLGBgFmkwo19KIzFtOlITUjb0Qqlub2Dn TIPoDs7rXA8aw6umJu73Z6647U3+alxNCpwTuYOY2CJQ+HWEIuOuwAdtQkndEp9r 7ZWA2xLatQKBYEvEmykCAwEAAaNQME4wHQYDVR0OBBYEFGUznNeZK74vlA4bqKHb 706tyMwcMB8GA1UdIwQYMBaAFGUznNeZK74vlA4bqKHb706tyMwcMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQENBQADgYEARmnu/2vUcmJYLlg86MN0prXGC3CGXsem fDtPF4SBPxfchdG7HJKywTloIiCBKGEQALkCHiJcQJNcSHmzH3/Qk+SrOJNH01gt HsKA4SNFJZR5fCRpT6USCukyE2Wlr+PWPscrFCWbLXhK4Ql/t0oog1255B10HqKk 1qDkNrzCd/o= -----END CERTIFICATE-----

cluster_cert_keystringrequired

The cluster certificate key (private key).

Example:-----BEGIN PRIVATE KEY----- MIICeAIBADANBgkqhkiG9w0BAQEFAASCAmIwggJeAgEAAoGBAPBWiWZj7LYQU9V5 E8qlCYrkFeKeCmi6TTIqDULSHXhihV3pZmZVX1tG3yxgYBZpMKNfSiMxbTpSE1I2 9EKpbm9g50yD6A7O61wPGsOrpibu92euuO1N/mpcTQqcE7mDmNgiUPh1hCLjrsAH bUJJ3RKfa+2VgNsS2rUCgWBLxJspAgMBAAECgYEAvA7qqozL/1ZdUu/P1cQ36E86 9L03ZeVJXFRdVgj2eGqW8vob3z00RUb6gE3VQhQDNALvDwSw9G6eoblQfgz31Hju sb+j6bGOm2BqzYrx6rpcgme7k9ScV0tEbtiBNX0E/ToHvNywHtdOBvDocN2wh42Z 6bS9um51H+SXR036mgUCQQD4T7WrJHL97Hj8TtHnTw895xWKaGn94H7ZQa2lo1nk 7CQ4Oi8rFX5tDdyV7UU6fekBWuhpmIhSGJhyHD7UThBjAkEA98ef9ey2Qx+j+R8S tgpgJAF3LVNJJicEHCS/Vltgc84X/vidVAMa2+TYPxPrrUjxBr0STCeB5wZhvvsB D8cOAwJBAJ5JqaQPUx1dDe7Ai/vooO20Dj4xu0c0QYha3sfU7qwIgDo7lO/g/ruj 93a3TscvlkXf3oHZ0ySKOzual86ciMMCQQDGOLgaWHVy+4QFTzt70I8bHuUFqKRT VlEuZqN/ZXijDFQcES5jwFwjYE8zHy+ioEDaIDXcIJsGhA98Zndx9M+bAkA4IFdx 4YIDhuk1MJAYPqVQs5szEF/0BGymLNVYlIox48bZg+TH3uXwTVRVySxvpRa8dd3O 0gHs3EIV6GFUl7ev -----END PRIVATE KEY-----

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

post/serverless-cloud-gateways

Body

{ "control_plane": { "id": "d32d905a-ed33-46a3-a093-d8f536af9a8a", "prefix": "518da50bf7", "region": "eu" }, "cluster_cert": "-----BEGIN CERTIFICATE----- MIICRDCCAa2gAwIBAgIBADANBgkqhkiG9w0BAQ0FADA/MQswCQYDVQQGEwJ1czEL MAkGA1UECAwCVFgxDTALBgNVBAoMBFRlc3QxFDASBgNVBAMMC2V4YW1wbGUuY29t MB4XDTI0MDQyNjA5NTA1OVoXDTI1MDQyNjA5NTA1OVowPzELMAkGA1UEBhMCdXMx CzAJBgNVBAgMAlRYMQ0wCwYDVQQKDARUZXN0MRQwEgYDVQQDDAtleGFtcGxlLmNv bTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA8FaJZmPsthBT1XkTyqUJiuQV 4p4KaLpNMioNQtIdeGKFXelmZlVfW0bfLGBgFmkwo19KIzFtOlITUjb0Qqlub2Dn TIPoDs7rXA8aw6umJu73Z6647U3+alxNCpwTuYOY2CJQ+HWEIuOuwAdtQkndEp9r 7ZWA2xLatQKBYEvEmykCAwEAAaNQME4wHQYDVR0OBBYEFGUznNeZK74vlA4bqKHb 706tyMwcMB8GA1UdIwQYMBaAFGUznNeZK74vlA4bqKHb706tyMwcMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQENBQADgYEARmnu/2vUcmJYLlg86MN0prXGC3CGXsem fDtPF4SBPxfchdG7HJKywTloIiCBKGEQALkCHiJcQJNcSHmzH3/Qk+SrOJNH01gt HsKA4SNFJZR5fCRpT6USCukyE2Wlr+PWPscrFCWbLXhK4Ql/t0oog1255B10HqKk 1qDkNrzCd/o= -----END CERTIFICATE-----\n", "cluster_cert_key": "-----BEGIN PRIVATE KEY----- MIICeAIBADANBgkqhkiG9w0BAQEFAASCAmIwggJeAgEAAoGBAPBWiWZj7LYQU9V5 E8qlCYrkFeKeCmi6TTIqDULSHXhihV3pZmZVX1tG3yxgYBZpMKNfSiMxbTpSE1I2 9EKpbm9g50yD6A7O61wPGsOrpibu92euuO1N/mpcTQqcE7mDmNgiUPh1hCLjrsAH bUJJ3RKfa+2VgNsS2rUCgWBLxJspAgMBAAECgYEAvA7qqozL/1ZdUu/P1cQ36E86 9L03ZeVJXFRdVgj2eGqW8vob3z00RUb6gE3VQhQDNALvDwSw9G6eoblQfgz31Hju sb+j6bGOm2BqzYrx6rpcgme7k9ScV0tEbtiBNX0E/ToHvNywHtdOBvDocN2wh42Z 6bS9um51H+SXR036mgUCQQD4T7WrJHL97Hj8TtHnTw895xWKaGn94H7ZQa2lo1nk 7CQ4Oi8rFX5tDdyV7UU6fekBWuhpmIhSGJhyHD7UThBjAkEA98ef9ey2Qx+j+R8S tgpgJAF3LVNJJicEHCS/Vltgc84X/vidVAMa2+TYPxPrrUjxBr0STCeB5wZhvvsB D8cOAwJBAJ5JqaQPUx1dDe7Ai/vooO20Dj4xu0c0QYha3sfU7qwIgDo7lO/g/ruj 93a3TscvlkXf3oHZ0ySKOzual86ciMMCQQDGOLgaWHVy+4QFTzt70I8bHuUFqKRT VlEuZqN/ZXijDFQcES5jwFwjYE8zHy+ioEDaIDXcIJsGhA98Zndx9M+bAkA4IFdx 4YIDhuk1MJAYPqVQs5szEF/0BGymLNVYlIox48bZg+TH3uXwTVRVySxvpRa8dd3O 0gHs3EIV6GFUl7ev -----END PRIVATE KEY-----\n", "labels": { "test": "true" } }
 
application/json

Get the serverless cloud gateway

Pre-release Endpoint
This endpoint is currently in beta and is subject to change.

Get the serverless cloud gateway

get
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

Response

application/json

A response to retrieving 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"}

get/serverless-cloud-gateways/{controlPlaneId}
 
application/json

Delete the serverless cloud gateway

Pre-release Endpoint
This endpoint is currently in beta and is subject to change.

Delete the serverless cloud gateway

delete
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

Response

No Content

delete/serverless-cloud-gateways/{controlPlaneId}