DOCSEARCHbyAlgolia
Submit Docs

Kong API Specifications

website·Indexed 30 days ago

https://kongdeveloper.netlify.app/

OpenAPI specifications for Kong Gateway and Kong Konnect. Includes technical documentation for Gateway Admin (EE), Dev Portal, and Konnect services such as AI Gateway, AI Catalog, Control Planes, Identity Management, and Analytics.

Tokens
950.4K
Snippets
3.9K
Records
7.1K
Agent score
73%

What's inside Kong

  1. Overview of the Dual-Cluster Upgrade strategy for Kong Gateway

    The dual-cluster upgrade strategy involves deploying a new Kong Gateway cluster (Version Y) with its own database alongside the existing cluster (Version X). Traffic is gradually shifted from X to Y using a load balancer. This is the safest upgrade method as it ensures no planned business downtime and allows for immediate rollback by redirecting traffic back to Cluster X.

    Applicability:

    • Traditional mode deployments.
    • Control planes in hybrid mode deployments.

    Key Limitations:

    • Runtime Metrics: Metrics relying on the database (e.g., request counters in the Rate Limiting Advanced plugin or Vitals buffered metrics) will not be synchronized between the two databases during the transition, leading to inaccurate metrics until the upgrade is complete.

  2. Overview of Custom AI Policies

    Custom AI Policies allow developers to deploy their own plugin schema and handler in the AI Gateway. A custom policy consists of two parts: a Lua schema (for validation) and a plugin handler (implementing the logic). These plugins are developed using the Kong Plugin Development Kit (PDK). Once a custom policy is created, its name becomes the type used when creating an AI Policy entity.

  3. Overview of the Environment Variable Vault

    The environment variable vault is a built-in Kong Gateway feature that stores secrets as environment variables on the data plane. These secrets can be referenced in any field that supports Vault references. It can be configured via the Vault entity (after database initialization), environment variables set at startup, or parameters in kong.conf.

  4. Overview of Kong Gateway backup methods

    Kong Gateway supports two primary backup methods for entities. It is recommended to use both for maximum recovery flexibility.

    1. Database-native backup: Backs up the entire database. This is the most robust method and allows for instant restoration. It is the recommended primary method for database-backed deployments.
    2. Declarative backup: Manages configuration via files. This serves as a safeguard if the database is corrupted or when using DB-less mode.

    Important Constraints:

    • Konnect: Only declarative backup is available as Kong manages the database.
    • DB-less: Only manual backup of declarative files is required.
    • Exclusions: Keyring materials and general configuration files must be backed up separately. Declarative tools (decK) do not back up Enterprise-only entities (RBAC roles, credentials, licenses) or Konnect-specific data (Dev Portal, Catalog, Observability).

  5. Overview of Insomnia Mock Server options

    Insomnia provides three primary ways to simulate API endpoints using mock servers:

    1. Cloud-hosted mocks: Quick setup by providing an endpoint and sample response. Hosted by Insomnia Cloud with usage limits based on the user's plan.
    2. Self-hosted mocks: Deployed using Insomnia Mockbin for greater control over usage.
    3. Auto-generated mocks: Created from a natural language prompt using a URL, OpenAPI specification, or JSON as input.

  7. Overview of Dedicated Cloud Gateways

    Dedicated Cloud Gateways are Data Plane nodes fully managed by Kong within Konnect. They run on isolated, single-tenant infrastructure in AWS, Azure, or GCP, providing the security and performance of dedicated hardware with the operational ease of a SaaS model. The Konnect Control Plane remains multi-tenant, while the Data Plane nodes are isolated per tenant.

    Key benefits include:

    • Managed Gateway upgrades by Kong.
    • Support for both public and private networking modes.
    • Automatic scaling via Autopilot mode.
    • Availability across multiple regions in AWS, Azure, and GCP.

  8. Overview of Konnect Dev Portal

    The Konnect Dev Portal is a customizable website that allows API consumers to locate, access, and consume API services. It supports publishing APIs using OpenAPI or AsyncAPI specifications and Markdown documentation. Key capabilities include browsing/searching API documentation, testing API operations, and managing developer credentials.

  9. Overview of Kong Context Mesh

    Kong Context Mesh is a mediation layer deployed behind Kong Gateway that turns enterprise APIs (via OpenAPI specs) and existing MCP servers into a single 'Code Mode' MCP server. It acts as a single source of truth for AI agents, allowing them to access multiple data sources and APIs without the token overhead associated with standard MCP tool calling. Because the MCP server runs on a Konnect control plane, all agent calls pass through Kong and can be governed using standard Kong plugins.

  10. Overview of Dev Portal MCP server

    The Dev Portal MCP server allows AI agents to browse and use APIs, pages, and documentation published to a Dev Portal on behalf of a developer. It respects the same authentication, RBAC, and visibility settings as the developer. This is distinct from AI Gateway's MCP capabilities, which convert a Gateway API directly into an MCP server. The MCP server automatically stays up-to-date as new content is published to the portal.

  11. Overview of API Packages in Dev Portal

    API packages allow you to compose distinct APIs for specific use cases or partners by grouping operations from existing API services. This enables you to:

    • Create customized API sets (e.g., a 'Flight Billing API' containing specific endpoints from both a Billing and Flights service).
    • Link multiple Gateway Services and Routes for developer self-service.
    • Apply rate limiting at both the package level and the individual operation level.
    • Manage role-based access control (RBAC) for specific developers and teams.

  12. Overview of Insomnia Enterprise features

    The Insomnia Enterprise plan provides advanced security and user management capabilities, including end-to-end encryption (E2EE), storage control, and strong access governance rules.