Konnect APIs

Base URLs

There are two types of base URLs that are used in Konnect APIs:

• Global: https://global.api.konghq.com

• Region specific: https://{REGION_CODE}.api.konghq.com

The global endpoint is used to manage region-agnostic Konnect entities that live in a global database. These APIs interact with entities that are not region specific and therefore do not have any regional boundaries. For example, identity management and IdP settings are all region-agnostic configurations applied to the organization as a whole.

The region-specific endpoints are used to manage Konnect entities that live in a specific Konnect region. These APIs interact with entities specific to a region and do not have the ability to cross regional boundaries. For example, runtime groups, service listings are all region-specific entities and therefore must use the region-specific endpoint.

Authentication

The recommended method of authentication for Konnect is Personal Access Token (PAT), which can be obtained from the personal access token page in Konnect. The PAT must be passed in the Authorization header of all requests, for example:

curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT'

API reference documentation

• Identity Management API - Interface for management of users, teams, team memberships and role assignments.

• Runtime Groups API - Interface for managing runtime groups.

• Runtime Configuration API - Interface for creating and managing control plane certificates, data plane certificates, and Konnect entities.

More information

• The Konnect API supports filtering, read the Filtering reference to learn more.