Open API Specifications

Welcome to Kong API Specs

This section of our docs site is Powered by Konnect, using customizations available for the DevPortal.

Definitions


Dev Portal provides a single source of truth for all developers to locate, access, and consume services for Kong Gateway EE. This spec is a Beta version.


Kong Gateway (EE) comes with an internal RESTful API for administration purposes. This spec is a Beta version.


Kong Gateway (OSS) comes with an internal RESTful API for administration purposes. This spec is a Beta version.


Gateway Status is a read-only endpoint allowing monitoring tools to retrieve metrics, healthiness, and other non-sensitive information of the node.


API Products can be used to manage API versions, documentation, and analytics.


API Requests provides access to detailed records for requests made to your API, in near real-time. This API is released as beta.


Application Auth Strategies are used to manage authentication to your APIs.


Audit logging enables administrators to better spot security risks and maintain compliance of their core infrastructure.


Manage Kong Gateway services, routes, certificates, consumer, and global configuration within Konnect.


Manage the control plane entity in Konnect.


Identity Management is responsible for Konnect users, teams, organization, roles, permissions, and IdP settings.


The Mesh Manager API can be used to create and manage your global mesh control planes.


Customize your self-hosted developer portal experience.


Integrate portal management operations with automation systems (such as CI/CD pipelines) utilizing this AIP-compliant API.

Deprecated


(Deprecated) Manage the runtime group entity in Konnect.


(Deprecated) Manage Kong Gateway services, routes, certificates, consumer and global configuration within Konnect.