API docs by Redocly

Konnect Serverless Cloud Gateways Manager (0.0.1)

Download OpenAPI specification:Download

URL: https://konghq.com

Serverless Cloud Gateways Manager API

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.

Authorizations:
personalAccessTokensystemAccountAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

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

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

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

Filter serverless cloud gateways in the response by associated labels.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

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

Authorizations:
personalAccessTokensystemAccountAccessToken
Request Body schema: application/json
required
object (Control plane)
cluster_cert
required
string

The cluster certificate (public key).

cluster_cert_key
required
string

The cluster certificate key (private key).

object (Labels)

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 '_'.

Responses

Request samples

Content type
application/json
{
  • "control_plane": {
    },
  • "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": {
    }
}

Response samples

Content type
application/json
{
  • "control_plane": {
    },
  • "gateway_endpoint": "kong-518da50bf7euab123.kongcloud.dev",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Get the serverless cloud gateway

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

Get the serverless cloud gateway

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: bf138ba2-c9b1-4229-b268-04d9d8a6410b

Id of the Serverless Cloud Gateway control plane

Responses

Response samples

Content type
application/json
{
  • "control_plane": {
    },
  • "gateway_endpoint": "kong-518da50bf7euab123.kongcloud.dev",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Update the serverless cloud gateway

Update an individual serverless cloud gateway.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: bf138ba2-c9b1-4229-b268-04d9d8a6410b

Id of the Serverless Cloud Gateway control plane

Request Body schema: application/json
cp_prefix
string

The prefix of the serverless cloud gateway CP.

cp_region
string (Control plane region)
Enum: "us" "eu" "au"

The control plane region.

object (Labels)

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 '_'.

Responses

Request samples

Content type
application/json
{
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "control_plane": {
    },
  • "gateway_endpoint": "kong-518da50bf7euab123.kongcloud.dev",
  • "created_at": "2023-01-11T02:30:42.227Z",
  • "updated_at": "2023-01-11T02:30:42.227Z",
  • "labels": {
    }
}

Delete the serverless cloud gateway

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

Delete the serverless cloud gateway

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: bf138ba2-c9b1-4229-b268-04d9d8a6410b

Id of the Serverless Cloud Gateway control plane

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "Unauthorized"
}