1.0.0OAS 3.0
API Base URL
  • Server 1:https://us.api.konghq.com/v1

    United-States Production region

  • Server 2:https://eu.api.konghq.com/v1

    Europe Production region

  • Server 3:https://au.api.konghq.com/v1

    Australia Production region

  • Server 4:https://me.api.konghq.com/v1

    Middle-East Production region

  • Server 5:https://in.api.konghq.com/v1

    India Production region

  • Server 6:https://sg.api.konghq.com/v1

    Singapore Production region

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

konnectAccessToken (http)

The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.

CMEK

Customer Managed Encryption Keys (CMEK) are used to encrypt and decrypt sensitive data in Konnect. They allow you to manage your own encryption keys using AWS Key Management Service (KMS). CMEKs provide an additional layer of security and compliance for your Konnect deployments, ensuring that your data is encrypted with keys that you control. Avoid revoking or deleting a KMS key and CMEK that is actively used by Konnect, as this can lead to data loss or service disruptions.

List CMEKs

List customer managed encryption keys.

get

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[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[before]string

Request the next page of data, starting with the item before this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filter CMEKs returned in the response.

Show Child Parameters

Response

200 application/json

List of CMEKs

CMEKList

dataarray[object]required
Show Child Parameters
metaobjectrequired

Pagination metadata.

Show Child Parameters
get/cmeks
 
200 application/json