このページは、まだ日本語ではご利用いただけません。翻訳中です。
Konnect APIs
Base URLs
Konnect API base URLs differ based on the geo they are hosted in or if they are global. For a list of the API base URLs by geo, see Ports and Network Requirements.
The global endpoint is used to manage geo-agnostic Konnect entities that live in a global database. These APIs interact with entities that are not geo-specific and therefore do not have any regional boundaries. For example, identity management and IdP settings are all geo-agnostic configurations applied to the organization as a whole.
The geo-specific endpoints are used to manage Konnect entities that live in a specific Konnect geo. These APIs interact with entities specific to a geo and do not have the ability to cross regional boundaries. For example, control planes, data plane nodes, and API product listings are all geo-specific entities and therefore must use the geo-specific endpoint. See Geographic Regions for more information.
Spec | Insomnia link |
---|---|
Konnect control plane configuration API |
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'
Filtering
The Konnect API supports filtering, read the Filtering reference to learn more.
Supported Content Types
The Konnect APIs accept three content types, depending on the API specification and the specific endpoint:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
Refer to the individual API specifications for detailed information on the content types supported by each endpoint.
Specifications
For a full list of the API specifications supported for use in production environments, visit API Specs.