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

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

konnectAccessToken (http)

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

Realms

Use a realm to group consumers around an identity, defined by organizational boundaries, such as a production realm or a development realm. Realms are connected to a geographic region in Konnect. Centrally managed consumers defined in realms can be used across multiple control planes.

List realms

List all available realms. The full configuration of each Realm is returned under the data key

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

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

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[after]string

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

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Response

200 application/json

success

ListRealms

dataarray[object]required
Show Child Parameters
metaobjectrequired

Pagination metadata.

Show Child Parameters
get/realms
 
200 application/json