CINXE.COM
OpenAPI Specifications | Kong Docs
<!DOCTYPE html> <html lang="en-US" itemscope itemtype="http://schema.org/Article"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <!-- OneTrust Cookies Consent Notice start for konghq.com --> <script src="https://cdn.cookielaw.org/scripttemplates/otSDKStub.js" type="text/javascript" charset="UTF-8" data-domain-script="2c4de954-6bec-4e93-8086-64cb113f151a"> </script> <script type="text/javascript"> function OptanonWrapper() { } </script> <!-- OneTrust Cookies Consent Notice end for konghq.com --> <!-- Google Tag Manager --> <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer', 'GTM-NL48VKT');</script> <!-- End Google Tag Manager --> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>OpenAPI Specifications | Kong Docs</title> <meta name="description" content="Documentation for Kong, the Cloud Connectivity Company for APIs and Microservices."> <meta name="author" content="KongHQ"> <meta property="og:title" content="OpenAPI Specifications | Kong Docs"> <meta property="og:site_name" content="Kong Docs"> <!-- use share link for facebook --> <meta property="og:url" content="https://docs.konghq.com"> <meta property="og:description" content="Documentation for Kong, the Cloud Connectivity Company for APIs and Microservices."> <meta property="og:type" content="website"> <meta property="og:locale" content="en_US"> <meta property="og:image" content="https://docs.konghq.com/assets/images/share.png"> <meta name="twitter:card" content="summary_large_image"> <meta name="twitter:site" content="@thekonginc"> <meta name="twitter:creator" content="@thekonginc"> <meta name="twitter:url" content="https://docs.konghq.com"> <meta name="twitter:description" content="Documentation for Kong, the Cloud Connectivity Company for APIs and Microservices."> <meta name="twitter:image" content="https://docs.konghq.com/assets/images/share.png"> <meta property="fb:admins" content="227304446"> <meta property="fb:admins" content="576641408"> <meta name="google-site-verification" content="CrU3zp02dNKTe8NSAipL4NCPkrIjDXG8fViTZ-MIzP4"> <script type="application/ld+json"> { "@context": "http://schema.org", "@type": "Organization", "name": "KongHQ", "url": "https://docs.konghq.com", "logo": "https://docs.konghq.com/assets/images/logo.png", "sameAs": [ "https://www.facebook.com/konginc", "https://twitter.com/thekonginc", "https://plus.google.com/+mashape" ] } </script> <!-- Preload assets --> <link rel="dns-prefetch" href="https://cloud.typography.com"> <link rel="dns-prefetch" href="https://dev.visualwebsiteoptimizer.com"> <link rel="dns-prefetch" href="https://cdn.segment.com"> <link rel="icon" type="image/x-icon" href="/assets/images/favicon.ico"> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3"> <link rel="canonical" href="https://docs.konghq.com/api/"> <link rel="alternate" hreflang="x-default" href="https://docs.konghq.com/api/"> <link rel="alternate" hreflang="ja" href="https://docs.jp.konghq.com/api/"> <meta name="robots" content="follow,index"> <!-- FontAwesome icon font --> <script src="https://kit.fontawesome.com/1332a92967.js" crossorigin="anonymous"> </script> <script src="/vite/assets/application-BwnN4xAL.js" crossorigin="anonymous" type="module"></script> <link href="/vite/assets/_commonjsHelpers-Cpj98o6Y.js" rel="modulepreload" as="script" crossorigin="anonymous"> <link rel="stylesheet" href="/vite/assets/application-9w6VHfwH.css" media="screen"> </head> <body id="" data-spy="scroll" data-target="#scroll-sidebar" data-offset="350"> <!-- Google Tag Manager (noscript) --> <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NL48VKT" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> <!-- End Google Tag Manager (noscript) --> <header class="navbar-v2 closed"> <a class="skip-main" href="#main">Skip to content</a> <!-- uncomment the promo-banner div when adding a new promo banner--> <!--also uncomment the promo banner sections in app/assets/stylesheets/header.less and application.js--> <!-- <div id="promo-banner"> <div class="container"> <div class="closebanner"></div> <strong>2024 API Summit Hackathon: Experiment with API Innovation & AI. Submit by Sept 11 —<a href="https://konghq.com/conferences/kong-summit/hackathon?utm_medium=website&utm_source=docs-konghq-com&utm_campaign=docs-banner">Enter Now →</a> </strong> </div> </div> --> <div class="navbar-content"> <a href="https://konghq.com" class="navbar-brand col col-xl-auto" target="_blank" rel="noopener noreferrer"> <img src="/assets/images/logos/konglogo-dark-theme.svg" alt="Kong Logo" id="kong-logo"> </a> <span class="logo-divider">|</span> <a href="/" class="navbar-brand col col-xl-auto"> <img src="/assets/images/logos/docslogo-dark-theme.svg" alt="Kong Docs Logo" id="kong-docs-logo"> </a> <div class="separator mobile"></div> <div class="search-input-wrapper" id="getkong-algolia-search-input"> </div> <div class="search-results-wrapper"></div> <div class="navbar-items" role="navigation" aria-label="Main menu"> <ul class="navbar-items" role="menubar"> <li id="top-module-list" aria-haspopup="true" role="menuitem" aria-expanded="false" class="navbar-item main-menu-item with-submenu active"> <span tabindex="0" id="docs-link" class="main-menu-item-title">Docs</span> <span class="caret"></span> <ul class="navbar-item-submenu" role="menu"> <div class="submenu-section"> <li role="menuitem" class="docs-dropdown-li"> <a href="/api/" class="docs-dropdown-li__link" tabindex="-1"> <div class="docs-dropdown-li__card"> <span class="heading">Explore the API Specs</span> <div class="docs-dropdown-li__card-link"> <img src="/assets/images/landing-page/view-all-api-specs.png" alt="View all API Specs"> <span class="docs-dropdown-li__card-image"> View all API Specs <img src="/assets/images/landing-page/arrow-right.svg" alt="View all API Specs arrow image"> </span> </div> </div> </a> </li> <li role="menuitem" class="docs-dropdown-li" tabindex="-1"> <div class="docs-dropdown-li__section"> <div class="docs-dropdown-li__section-title"> <span class="heading">Documentation</span> </div> <div class="docs-dropdown-li__section-items"> <a class="item item-all" href="/api/" tabindex="-1"> <div class="item__description"> <div class="item__description-title">API Specs</div> </div> </a> <a class="item" href="/gateway/latest/" tabindex="-1"> <div class="item__description"> <div class="item__description-title">Kong Gateway</div> <div class="item__description-desc">Lightweight, fast, and flexible cloud-native API gateway</div> </div> </a> <a class="item" href="/konnect/" tabindex="-1"> <div class="item__description"> <div class="item__description-title">Kong Konnect</div> <div class="item__description-desc">Single platform for SaaS end-to-end connectivity</div> </div> </a> <a class="item" href="/gateway/latest/ai-gateway/" tabindex="-1"> <div class="item__description"> <div class="item__description-title">Kong AI Gateway</div> <div class="item__description-desc">Multi-LLM AI Gateway for GenAI infrastructure</div> </div> </a> <a class="item" href="/mesh/latest/" tabindex="-1"> <div class="item__description"> <div class="item__description-title">Kong Mesh</div> <div class="item__description-desc">Enterprise service mesh based on Kuma and Envoy</div> </div> </a> <a class="item" href="/deck/latest/" tabindex="-1"> <div class="item__description"> <div class="item__description-title">decK</div> <div class="item__description-desc">Helps manage Kong’s configuration in a declarative fashion</div> </div> </a> <a class="item" href="/kubernetes-ingress-controller/latest/" tabindex="-1"> <div class="item__description"> <div class="item__description-title">Kong Ingress Controller</div> <div class="item__description-desc">Works inside a Kubernetes cluster and configures Kong to proxy traffic</div> </div> </a> <a class="item" href="/gateway-operator/latest/" tabindex="-1"> <div class="item__description"> <div class="item__description-title">Kong Gateway Operator</div> <div class="item__description-desc">Manage your Kong deployments on Kubernetes using YAML Manifests</div> </div> </a> <a class="item" href="https://docs.insomnia.rest/" tabindex="-1" target="_blank" rel="noopener nofollow noreferrer "> <div class="item__description"> <div class="item__description-title">Insomnia</div> <div class="item__description-desc">Collaborative API development platform</div> </div> </a> </div> </div> </li> </div> </ul> </li> <li role="menuitem" aria-haspopup="true" aria-expanded="false" class="navbar-item main-menu-item with-submenu navbar-item-hub"> <span id="plugin-link" class="main-menu-item-title" tabindex="0">Plugin Hub</span> <span class="caret"></span> <ul class="navbar-item-submenu" role="menu"> <div class="submenu-section"> <li role="menuitem" class="docs-dropdown-li"> <a href="/hub/" class="docs-dropdown-li__link" tabindex="-1"> <div class="docs-dropdown-li__card"> <span class="heading">Explore the Plugin Hub</span> <div class="docs-dropdown-li__card-link"> <img src="/assets/images/landing-page/view-all-plugins.svg" alt="View all plugins"> <span class="docs-dropdown-li__card-image"> View all plugins <img src="/assets/images/landing-page/arrow-right.svg" alt="View all plugins arrow image"> </span> </div> </div> </a> </li> <li role="menuitem" class="docs-dropdown-li"> <div class="docs-dropdown-li__section"> <div class="docs-dropdown-li__section-title"> <span class="heading">Functionality</span> <a href="/hub/" class="view-all" tabindex="-1"> View all <img src="/assets/images/landing-page/arrow-right.svg" alt="View all arrow image"> </a> </div> <div class="docs-dropdown-li__section-items"> <a class="item item-all" href="/hub/" tabindex="-1"> <div class="item__description"> <div class="item__description-title">View all plugins</div> </div> </a> <a class="item" href="/hub/?category=ai" tabindex="-1"> <div> <img src="/assets/images/nav/hub/ai.svg" alt="AI's icon"> </div> <div class="item__description"> <div class="item__description-title">AI</div> <div class="item__description-desc">Govern, secure, and control AI traffic with multi-LLM AI Gateway plugins</div> </div> </a> <a class="item" href="/hub/?category=authentication" tabindex="-1"> <div> <img src="/assets/images/nav/hub/lock_person.svg" alt="Authentication's icon"> </div> <div class="item__description"> <div class="item__description-title">Authentication</div> <div class="item__description-desc">Protect your services with an authentication layer</div> </div> </a> <a class="item" href="/hub/?category=security" tabindex="-1"> <div> <img src="/assets/images/nav/hub/shield.svg" alt="Security's icon"> </div> <div class="item__description"> <div class="item__description-title">Security</div> <div class="item__description-desc">Protect your services with additional security layer</div> </div> </a> <a class="item" href="/hub/?category=traffic-control" tabindex="-1"> <div> <img src="/assets/images/nav/hub/route.svg" alt="Traffic Control's icon"> </div> <div class="item__description"> <div class="item__description-title">Traffic Control</div> <div class="item__description-desc">Manage, throttle and restrict inbound and outbound API traffic</div> </div> </a> <a class="item" href="/hub/?category=serverless" tabindex="-1"> <div> <img src="/assets/images/nav/hub/serverless.svg" alt="Serverless's icon"> </div> <div class="item__description"> <div class="item__description-title">Serverless</div> <div class="item__description-desc">Invoke serverless functions in combination with other plugins</div> </div> </a> <a class="item" href="/hub/?category=analytics-monitoring" tabindex="-1"> <div> <img src="/assets/images/nav/hub/bar_chart.svg" alt="Analytics & Monitoring's icon"> </div> <div class="item__description"> <div class="item__description-title">Analytics & Monitoring</div> <div class="item__description-desc">Visualize, inspect and monitor APIs and microservices traffic</div> </div> </a> <a class="item" href="/hub/?category=transformations" tabindex="-1"> <div> <img src="/assets/images/nav/hub/swap_horiz.svg" alt="Transformations's icon"> </div> <div class="item__description"> <div class="item__description-title">Transformations</div> <div class="item__description-desc">Transform request and responses on the fly on Kong</div> </div> </a> <a class="item" href="/hub/?category=logging" tabindex="-1"> <div> <img src="/assets/images/nav/hub/list_alt.svg" alt="Logging's icon"> </div> <div class="item__description"> <div class="item__description-title">Logging</div> <div class="item__description-desc">Log request and response data using the best transport for your infrastructure</div> </div> </a> </div> </div> </li> </div> </ul> </li> <li role="menuitem" class="main-menu-item"> <a href="https://support.konghq.com/" class="navbar-item" target="_blank" rel="noopener nofollow noreferrer ">Support</a> </li> <li role="menuitem" class="main-menu-item"> <a href="https://konghq.com/community/" class="navbar-item" target="_blank" rel="noopener noreferrer">Community</a> </li> <li role="menuitem" class="main-menu-item"> <a href="https://education.konghq.com" class="navbar-item" target="_blank" rel="noopener nofollow noreferrer ">Kong Academy</a> </li> </ul> <a id="top-cta" href="https://konghq.com/contact-sales?utm_source=docs.konghq.com" class="navbar-button" target="_blank" rel="noopener nofollow noreferrer "> Get a Demo </a> <a id="konnect-cta" href="https://konghq.com/products/kong-konnect/register?utm_medium=referral&utm_source=docs&utm_campaign=gateway-konnect&utm_content=top-nav" class="navbar-button" target="_blank" rel="noopener nofollow noreferrer "> Start Free Trial </a> </div> <div id="navbar-menu-toggle-button" class="small-screen-button" aria-label="Toggle navigation"> <div></div> <div></div> <div></div> </div> </div> </header> <div class="search-selector">Open API Specifications</div> <div class="page page-hub oas-landing"> <div class="page-hub--header-background"></div> <div class="page-hub--header"> <h1>Welcome to Kong API Specs</h1> <h3>This section of our docs site is Powered by Konnect, using <a href="/konnect/dev-portal/customization/">customizations available for the DevPortal</a>.</h3> </div> <div class="landing-page"> <h3 class="feature-title feature-title-oas">Definitions</h3> <section class="features"> <div class="cards-container"> <div class="card default"> <div class="title"> <a href="/dev-portal/api/latest/"> Gateway Dev Portal </a> </div> <hr> <div class="description"> <span>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.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v1</span> <a href="/dev-portal/api/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Gateway Dev Portal specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Gateway%20Dev%20Portal&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FGateway-EE%2Fportal-api.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/gateway/api/admin-ee/latest/"> Gateway Admin - EE </a> </div> <hr> <div class="description"> <span>Kong Gateway (EE) comes with an internal RESTful API for administration purposes.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: 3.8.0.0</span> <a href="/gateway/api/admin-ee/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Gateway Admin - EE specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Gateway%20Admin%20Enterprise%20API&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FGateway-EE%2Flatest%2Fkong-ee.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/gateway/api/admin-oss/latest/"> Gateway Admin - OSS </a> </div> <hr> <div class="description"> <span>Kong Gateway (OSS) comes with an internal RESTful API for administration purposes.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: 3.8.0</span> <a href="/gateway/api/admin-oss/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Gateway Admin - OSS specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Gateway%20Admin%20OSS%20API&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FGateway-OSS%2Flatest%2Fkong-oss.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/gateway/api/status/latest/"> Gateway Status </a> </div> <hr> <div class="description"> <span>Gateway Status is a read-only endpoint allowing monitoring tools to retrieve metrics, healthiness, and other non-sensitive information of the node.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v1</span> <a href="/gateway/api/status/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Gateway Status specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Gateway%20Status&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FGateway-OSS%2Fgateway-status.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/konnect/api/api-products/latest/"> Konnect API Products </a> </div> <hr> <div class="description"> <span>API Products can be used to manage API versions, documentation, and analytics.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v2</span> <a href="/konnect/api/api-products/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Konnect API Products specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Konnect%20API%20Products&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FKonnect%2Fv2%2Fyaml%2Fapi-products.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/konnect/api/api-requests/latest/"> Konnect API Request </a> </div> <hr> <div class="description"> <span>API Requests provides access to detailed records for requests made to your API, in near real-time.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v2</span> <a href="/konnect/api/api-requests/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Konnect API Request specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Konnect%20API%20Requests&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FKonnect%2Fv2%2Fyaml%2Fanalytics-requests.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/konnect/api/application-auth-strategies/latest/"> Application Auth Strategies </a> </div> <hr> <div class="description"> <span>Application Auth Strategies are used to manage authentication to your APIs.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v2</span> <a href="/konnect/api/application-auth-strategies/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Application Auth Strategies specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Konnect%20Portal%20Management&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FKonnect%2Fv2%2Fyaml%2Fapplication-auth-strategies.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/konnect/api/audit-logs/latest/"> Konnect Audit Logging </a> </div> <hr> <div class="description"> <span>Audit logging enables administrators to better spot security risks and maintain compliance of their core infrastructure.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v2</span> <a href="/konnect/api/audit-logs/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Konnect Audit Logging specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Konnect%20Audit%20Logs&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FKonnect%2Fv2%2Fyaml%2Faudit-logs.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/konnect/api/cloud-gateways/latest/"> Dedicated Cloud Gateways </a> </div> <hr> <div class="description"> <span>Konnect API for managing Dedicated Cloud Gateways infrastructure configuration.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v2</span> <a href="/konnect/api/cloud-gateways/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Dedicated Cloud Gateways specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Konnect%20Cloud%20Gateways&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FKonnect%2Fv2%2Fyaml%2Fcloud-gateways.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/konnect/api/control-plane-configuration/latest/"> Konnect Control Planes Config </a> </div> <hr> <div class="description"> <span>Manage Kong Gateway services, routes, certificates, consumer, and global configuration within Konnect.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v2</span> <a href="/konnect/api/control-plane-configuration/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Konnect Control Planes Config specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Konnect%20Control%20Plane%20Config&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FKonnect%2Fcontrol-planes-config%2Fcontrol-planes-config.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/konnect/api/control-planes/latest/"> Konnect Control Planes </a> </div> <hr> <div class="description"> <span>Manage the control plane entity in Konnect.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v2</span> <a href="/konnect/api/control-planes/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Konnect Control Planes specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Konnect%20Control%20Planes&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FKonnect%2Fv2%2Fyaml%2Fcontrol-planes.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/konnect/api/identity-management/latest/"> Konnect Identity Management </a> </div> <hr> <div class="description"> <span>Identity Management is responsible for Konnect users, teams, organization, roles, permissions, and IdP settings.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v3</span> <a href="/konnect/api/identity-management/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Konnect Identity Management specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Konnect%20Identity%20Management&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FKonnect%2Fv3%2Fyaml%2Fidentity.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/konnect/api/mesh-manager/latest/"> Konnect Mesh Manager </a> </div> <hr> <div class="description"> <span>The Mesh Manager API can be used to create and manage your global mesh control planes.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v0</span> <a href="/konnect/api/mesh-manager/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Konnect Mesh Manager specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Konnect%20Mesh%20Manager&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FKonnect%2Fv0%2Fyaml%2Fmesh-control-planes.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/konnect/api/portal/latest/"> Konnect Customizable Portal </a> </div> <hr> <div class="description"> <span>Customize your self-hosted developer portal experience.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v2</span> <a href="/konnect/api/portal/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Konnect Customizable Portal specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Konnect%20Customizable%20Portal&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FKonnect%2Fv2%2Fyaml%2Fportal-api.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/konnect/api/portal-management/latest/"> Konnect Portal Management </a> </div> <hr> <div class="description"> <span>Integrate portal management operations with automation systems (such as CI/CD pipelines) utilizing this AIP-compliant API.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v2</span> <a href="/konnect/api/portal-management/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Konnect Portal Management specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Konnect%20Portal%20Management&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FKonnect%2Fv2%2Fyaml%2Fportal-management.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/konnect/api/search/latest/"> Konnect Search </a> </div> <hr> <div class="description"> <span>The search API for Kong Konnect.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: Konnect Search v1</span> <a href="/konnect/api/search/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Konnect Search specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Konnect%20Search&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2FKonnect%2Fv1%2Fyaml%2Fksearch.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/konnect-portal/api/latest/"> Konnect Developer Portal </a> </div> <hr> <div class="description"> <span>The API that powers the Konnect Developer Portal. Access portal data from the perspective of a Portal user, rather than a Portal administrator.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v2</span> <a href="/konnect-portal/api/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Konnect Developer Portal specification"> </a> </div> <div class="insomnia-link"> <a href="https://insomnia.rest/run/?label=Konnect%20Portal&uri=https%3A%2F%2Fraw.githubusercontent.com%2FKong%2Fdocs.konghq.com%2Fmain%2Fapi-specs%2Fportal.yaml" target="_blank" rel="noopener nofollow noreferrer "><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"></a> </div> </div> </div> </div> </section> <h4 class="feature-title feature-title-oas feature-title-oas-deprecated">Deprecated</h4> <section class="features"> <div class="cards-container"> <div class="card default"> <div class="title"> <a href="/konnect/api/runtime-groups/latest/"> Konnect Runtime Groups (Deprecated) </a> </div> <hr> <div class="description"> <span>(Deprecated) Manage the runtime group entity in Konnect.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v2</span> <a href="/konnect/api/runtime-groups/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Konnect Runtime Groups (Deprecated) specification"> </a> </div> </div> </div> <div class="card default"> <div class="title"> <a href="/konnect/api/runtime-groups-configuration/latest/"> Konnect Runtime Group Config (Deprecated) </a> </div> <hr> <div class="description"> <span>(Deprecated) Manage Kong Gateway services, routes, certificates, consumer and global configuration within Konnect.</span> </div> <hr> <div class="links-container"> <div class="spec-links"> <span>Latest Version: v2</span> <a href="/konnect/api/runtime-groups-configuration/latest/" class="link-text"> Specification <img src="/assets/images/icons/icn-arrow-right.svg" alt="link to Konnect Runtime Group Config (Deprecated) specification"> </a> </div> </div> </div> </div> </section> </div> </div> <footer class="marketing-footer--light-gray"> <section> <ul class="newsletter"> <li class="logo-wrapper"> <div class="logo"> <img src="/assets/images/logos/konglogo-light-theme-primary.svg" alt="Kong"> </div> <div class="footer-title">Powering the API world</div> <p> Increase developer productivity, security, and performance at scale with the unified platform for API management, service mesh, and ingress controller. </p> <div class="footer-form-container"> <form id="subscribe-form" method="POST" action="/assets/javascripts/subscribe.js"> <input required id="subscribe-input" type="email" name="email" placeholder="Email" aria-required="true" aria-invalid="false"> <input id="footer-form-button" type="submit" form="subscribe-form" value="Subscribe"> </form> <div id="form-response"></div> </div> </li> <li class="footer-columns"> <ul class="footer-columns-product-list"> <li> <nav> <div class="footer-category">Products</div> <ul> <li> <a href="https://konghq.com/products/kong-konnect" target="_blank" rel="noopener nofollow noreferrer ">Kong Konnect</a> </li> <li> <a href="https://konghq.com/products/kong-enterprise" target="_blank" rel="noopener nofollow noreferrer ">Kong Gateway Enterprise</a> </li> <li> <a href="https://konghq.com/products/kong-gateway" target="_blank" rel="noopener nofollow noreferrer ">Kong Gateway</a> </li> <li> <a href="https://konghq.com/products/kong-mesh" target="_blank" rel="noopener nofollow noreferrer ">Kong Mesh</a> </li> <li> <a href="https://konghq.com/products/kong-ingress-controller" target="_blank" rel="noopener nofollow noreferrer ">Kong Ingress Controller</a> </li> <li> <a href="https://insomnia.rest/" target="_blank" rel="noopener nofollow noreferrer noopener nofollow noreferrer">Kong Insomnia</a> </li> <li> <a href="https://konghq.com/product-updates" target="_blank" rel="noopener nofollow noreferrer ">Product Updates</a> </li> <li> <a href="https://konghq.com/contact-sales" target="_blank" rel="noopener nofollow noreferrer ">Get Started</a> </li> </ul> </nav> </li> <li> <nav> <div class="footer-category">Documentation</div> <ul> <li> <a href="/konnect/">Kong Konnect Docs</a> </li> <li> <a href="/gateway/latest/">Kong Gateway Docs</a> </li> <li> <a href="/gateway/latest/kong-enterprise/">Kong Gateway Enterprise Docs</a> </li> <li> <a href="/mesh/latest/">Kong Mesh Docs</a> </li> <li> <a href="https://docs.insomnia.rest/" target="_blank" rel="noopener nofollow noreferrer noopener nofollow noreferrer">Kong Insomnia Docs</a> </li> <li> <a href="/hub/">Kong Konnect Plugin Hub</a> </li> </ul> </nav> </li> <li> <nav> <div class="footer-category">Open Source</div> <ul> <li> <a href="https://konghq.com/install/#kong-community" target="_blank" rel="noopener nofollow noreferrer ">Kong Gateway</a> </li> <li> <a href="https://kuma.io/" target="_blank" rel="noopener nofollow noreferrer noopener nofollow noreferrer">Kuma</a> </li> <li> <a href="https://insomnia.rest/" target="_blank" rel="noopener nofollow noreferrer noopener nofollow noreferrer">Insomnia</a> </li> <li> <a href="https://konghq.com/community" target="_blank" rel="noopener nofollow noreferrer ">Kong Community</a> </li> </ul> </nav> </li> <li> <nav> <div class="footer-category">Company</div> <ul> <li> <a href="https://konghq.com/company/about-us" target="_blank" rel="noopener nofollow noreferrer ">About Kong</a> </li> <li> <a href="https://konghq.com/customers" target="_blank" rel="noopener nofollow noreferrer ">Customers</a> </li> <li> <a href="https://konghq.com/company/careers" target="_blank" rel="noopener nofollow noreferrer ">Careers</a> </li> <li> <a href="https://konghq.com/press-room" target="_blank" rel="noopener nofollow noreferrer ">Press</a> </li> <li> <a href="https://konghq.com/events" target="_blank" rel="noopener nofollow noreferrer ">Events</a> </li> <li> <a href="https://konghq.com/company/contact-us" target="_blank" rel="noopener nofollow noreferrer ">Contact</a> </li> </ul> </nav> </li> </ul> </li> </ul> </section> <section class="legal"> <div class="container d-flex"> <div class="social"> <div class="social-link"> <a href="https://www.facebook.com/konghq/" title="Facebook" target="_blank" rel="noopener nofollow noreferrer "><i aria-label="Facebook" class="fa fa-facebook-official" aria-hidden="true"></i></a> </div> <div class="social-link"> <a href="https://twitter.com/thekonginc" title="Twitter" target="_blank" rel="noopener nofollow noreferrer "><i aria-label="Twitter" class="fa fa-twitter" aria-hidden="true"></i></a> </div> <div class="social-link"> <a href="https://www.meetup.com/topics/kong/all/" title="Meetup" target="_blank" rel="noopener nofollow noreferrer "><i aria-label="Meetup" class="fa fa-meetup" aria-hidden="true"></i></a> </div> <div class="social-link"> <a href="https://linkedin.com/company/278819" title="LinkedIn" target="_blank" rel="noopener nofollow noreferrer "><i aria-label="GitHub" class="fa fa-linkedin" aria-hidden="true"></i></a> </div> <div class="social-link"> <a href="https://github.com/kong/kong" target="_blank" class="btn-gh" title="GitHub" rel="noopener nofollow noreferrer "> <i class="fa fa-github" aria-hidden="true" aria-label="GitHub"></i> </a> </div> </div> <ul> <li> <span class="mashape-footer-content"> <a href="https://konghq.com/legal/terms-of-use" target="_blank" rel="noopener nofollow noreferrer ">Terms</a><b>•</b> <a href="https://konghq.com/legal/privacy-policy" target="_blank" rel="noopener nofollow noreferrer ">Privacy</a><b>•</b> <a href="https://konghq.com/compliance" target="_blank" rel="noopener nofollow noreferrer ">Trust and Compliance</a> </span> </li> </ul> <div> <span>© Kong Inc. 2024 </span> </div> </div> </section> </footer> <script> var anchorForId = function (id) { var anchor = document.createElement("a"); anchor.className = "header-link"; anchor.href = "#" + id; anchor.innerHTML = "<i class=\"fa fa-link\"></i>"; anchor.title = `${id} Permalink`; return anchor; }; document.onreadystatechange = function () { if (this.readyState === "complete") { var className = ".show-anchor-links h1, .show-anchor-links h2, .show-anchor-links h3, " + ".show-anchor-links h4, .show-anchor-links h5, .show-anchor-links h6"; var headers = document.querySelectorAll(className); for (var i = 0; i < headers.length; i++) { var header = headers[i]; if (typeof header.id !== "undefined" && header.id !== "") { header.prepend(anchorForId(header.id)); } } } }; </script> <script> !function(){var i="analytics",analytics=window[i]=window[i]||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","screen","once","off","on","addSourceMiddleware","addIntegrationMiddleware","setAnonymousId","addDestinationMiddleware","register"];analytics.factory=function(e){return function(){if(window[i].initialized)return window[i][e].apply(window[i],arguments);var n=Array.prototype.slice.call(arguments);if(["track","screen","alias","group","page","identify"].indexOf(e)>-1){var c=document.querySelector("link[rel='canonical']");n.push({__t:"bpc",c:c&&c.getAttribute("href")||void 0,p:location.pathname,u:location.href,s:location.search,t:document.title,r:document.referrer})}n.unshift(e);analytics.push(n);return analytics}};for(var n=0;n<analytics.methods.length;n++){var key=analytics.methods[n];analytics[key]=analytics.factory(key)}analytics.load=function(key,n){var t=document.createElement("script");t.type="text/javascript";t.async=!0;t.setAttribute("data-global-segment-analytics-key",i);t.src="https://cdn.segment.com/analytics.js/v1/" + key + "/analytics.min.js";var r=document.getElementsByTagName("script")[0];r.parentNode.insertBefore(t,r);analytics._loadOptions=n};analytics._writeKey="X7EZTdbdUKQ8M6x42SHHPWiEhjsfs1EQ";;analytics.SNIPPET_VERSION="5.2.0"; analytics.load("X7EZTdbdUKQ8M6x42SHHPWiEhjsfs1EQ"); analytics.page(); }}(); </script> <div id="fb-root"></div> <script id="github-bjs" src="https://buttons.github.io/buttons.js" async defer></script> <script type="text/javascript"> var _vwo_code = (function() { var account_id = 125292, settings_tolerance = 2000, library_tolerance = 2500, use_existing_jquery = true, // DO NOT EDIT BELOW THIS LINE f = false, d = document; return { use_existing_jquery: function() { return use_existing_jquery; }, library_tolerance: function() { return library_tolerance; }, finish: function() { if (!f) { f = true; var a = d.getElementById('_vis_opt_path_hides'); if (a) a.parentNode.removeChild(a); } }, finished: function() { return f; }, load: function(a) { var b = d.createElement('script'); b.src = a; b.type = 'text/javascript'; b.innerText; b.onerror = function() { _vwo_code.finish(); }; d.getElementsByTagName('head')[0].appendChild(b); }, init: function() { settings_timer = setTimeout( '_vwo_code.finish()', settings_tolerance ); this.load( '//dev.visualwebsiteoptimizer.com/j.php?a=' + account_id + '&u=' + encodeURIComponent(d.URL) + '&r=' + Math.random() ); var a = d.createElement('style'), b = '', h = d.getElementsByTagName('head')[0]; a.setAttribute('id', '_vis_opt_path_hides'); a.setAttribute('type', 'text/css'); if (a.styleSheet) a.styleSheet.cssText = b; else a.appendChild(d.createTextNode(b)); h.appendChild(a); return settings_timer; } }; })(); _vwo_settings_timer = _vwo_code.init(); </script> <script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3"></script> <script type="text/javascript"> docsearch({ appId: '05Y6TLHNFZ', apiKey: '80483bfe28d9fd036a11a6f6a06454f8', indexName: 'konghq', container: '#getkong-algolia-search-input', disableUserPersonalization: true, placeholder: 'Search the docs...', // Override selected event to allow for local environment navigation transformItems(items) { return items.map((item) => { var modifiedUrl = window.location.protocol + '//' + window.location.host + item.url.split('docs.konghq.com')[1]; return { ...item, url: modifiedUrl }; }); }, translations: { button: { buttonText: 'Search the docs..', buttonAriaLabel: 'Search the docs...' } }, resultsFooterComponent({ state }) { var facetParameters = {}; var queryParams = new URLSearchParams(facetParameters); queryParams.set('query', state.query); return { // The HTML `tag` type: 'a', ref: undefined, constructor: undefined, key: state.query, // Its props props: { href: `/search/?${queryParams.toString()}`, target: '_blank', // Raw text rendered in the HTML element children: 'See more >' }, __v: null, }; }, }); </script> </body> </html>