Manage Control Plane Configuration with decK - Kong Konnect

<!DOCTYPE html> <html lang="en-US" itemscope itemtype="http://schema.org/Article"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  <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>   <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>  <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Manage Control Plane Configuration with decK - Kong Konnect | 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="Manage Control Plane Configuration with decK - Kong Konnect | Kong Docs"> <meta property="og:site_name" content="Kong Docs">  <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>  <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/konnect/gateway-manager/declarative-config/"> <link rel="alternate" hreflang="x-default" href="https://docs.konghq.com/konnect/gateway-manager/declarative-config/"> <link rel="alternate" hreflang="ja" href="https://docs.jp.konghq.com/konnect/gateway-manager/declarative-config/"> <meta name="robots" content="follow,index">  <script src="https://kit.fontawesome.com/1332a92967.js" crossorigin="anonymous"> </script> <script src="/vite/assets/application-D8sXFsvE.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-C5Quk452.css" media="screen"> </head> <body id="" data-spy="scroll" data-target="#scroll-sidebar" data-offset="350">  <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NL48VKT" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>  <header class="navbar-v2 closed"> <a class="skip-main" href="#main">Skip to content</a>    <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/" 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="page v2 " data-url="/konnect/gateway-manager/declarative-config/"> <div class="page--header-background page--header-background-doc"></div> <div class="container"> <header class="page-header page-header-doc"> <div class="page-header-product-version"> <div class="edition"> Kong Konnect </div> </div> <div class="page-header--nav"> <i class="sidebar-toggle"></i> <ul class="breadcrumbs"> <li class="breadcrumb-item"> <a href="/"> <img src="/assets/images/icons/hub-layout/icn-breadcrumbs.svg" alt="Home icon"> </a> </li> <li class="breadcrumb-item"> <a href="/konnect/">Kong Konnect</a> </li> <li class="breadcrumb-item"> <a href="/konnect/gateway-manager/">Gateway Manager</a> </li> <li class="breadcrumb-item"> <a href="/konnect/gateway-manager/declarative-config/">Manage Control Plane Configuration with decK</a> </li> </ul> <div class="github-links"> <div class="github-links--edit"> <a href="https://github.com/Kong/docs.konghq.com/edit/main/app/konnect/gateway-manager/declarative-config.md" target="_blank" rel="noopener nofollow noreferrer "> <img src="/assets/images/icons/third-party/logo-github-white.svg" alt="github-edit-page">Edit this page </a> </div> <div class="github-links--issues"> <a href="https://github.com/Kong/docs.konghq.com/issues/" target="_blank" rel="noopener nofollow noreferrer "> <img src="/assets/images/icons/documentation/icn-monitoring-white.svg" alt="report-issue">Report an issue</a> </div> </div> </div> </header> <aside class="docs-sidebar"> <i class="fa fa-times close-sidebar"></i> <div class="sidebar-title-container"> <div class="docsets-dropdown dropdown"> <button class="dropdown-button" id="module-dropdown" type="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false" tabindex="0"> <span> Kong Konnect </span> <span class="caret"></span> </button> <ul class="dropdown-menu dropdown-menu-right with-submenu" id="module-list" role="menu" aria-labelledby="module-dropdown" aria-hidden="true"> <li role="menuitem" tabindex="-1"> <a href="/gateway/latest/">Kong Gateway</a> </li> <li role="menuitem" tabindex="-1" class="active"> <a href="/konnect/" class="active">Kong Konnect</a> </li> <li role="menuitem" tabindex="-1"> <a href="/mesh/latest/">Kong Mesh</a> </li> <li role="menuitem" tabindex="-1"> <a href="/hub/?category=ai">Kong AI Gateway</a> </li> <li role="menuitem" tabindex="-1"> <a href="/hub/">Plugin Hub</a> </li> <li role="menuitem" tabindex="-1"> <a href="/deck/">decK</a> </li> <li role="menuitem" tabindex="-1"> <a href="/kubernetes-ingress-controller/latest/">Kong Ingress Controller</a> </li> <li role="menuitem" tabindex="-1"> <a href="/gateway-operator/latest/">Kong Gateway Operator</a> </li> <li> <a href="https://docs.insomnia.rest/" target="_blank" rel="noopener nofollow noreferrer ">Insomnia</a> </li> <li role="menuitem" tabindex="-1"> <a href="https://kuma.io/docs/" target="_blank" rel="noopener nofollow noreferrer ">Kuma</a> </li> <hr> <li role="menuitem" tabindex="-1"> <a href="/contributing/">Docs contribution guidelines</a> </li> </ul> </div> </div> <ul class="sidebar-container" role="tree" aria-label="Documentation"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-1-introduction-subtree"> <img src="/assets/images/icons/documentation/icn-flag.svg" alt=""> Introduction <button class="sidebar-tree-toggle" aria-label="toggle Introduction subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-1-introduction-subtree" role="group" aria-label="Introduction"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/"> Overview of Konnect </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/architecture/"> Architecture </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/network-resiliency/"> Network Resiliency and Availability </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/network/"> Port and Network Requirements </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-1-5-private-connections-to-other-cloud-providers-subtree"> Private Connections to Other Cloud Providers <button class="sidebar-tree-toggle" aria-label="toggle Private Connections to Other Cloud Providers subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-1-5-private-connections-to-other-cloud-providers-subtree" role="group" aria-label="Private Connections to Other Cloud Providers"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/private-connections/aws-privatelink/"> Create a private connection with AWS PrivateLink </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/geo/"> Geographic Regions </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/compatibility/"> Compatibility </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/availability-stages/"> Stages of Software Availability </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/updates/"> Release Notes </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-1-10-support-subtree"> Support <button class="sidebar-tree-toggle" aria-label="toggle Support subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-1-10-support-subtree" role="group" aria-label="Support"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/upgrade-faq/"> Control Plane Upgrades FAQ </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/support/data-plane-nodes/"> Supported Installation Options </a> </span> </li> </ul> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-2-get-started-subtree"> <img src="/assets/images/icons/documentation/icn-quickstart-color.svg" alt=""> Get Started <button class="sidebar-tree-toggle" aria-label="toggle Get Started subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-2-get-started-subtree" role="group" aria-label="Get Started"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/getting-started/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/getting-started/add-api/"> Add your API </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/getting-started/migration/"> Migrating a Self-Managed Kong Gateway into Konnect </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-3-gateway-manager-subtree"> <img src="/assets/images/icons/konnect/icn-runtimes-nav.svg" alt=""> Gateway Manager <button class="sidebar-tree-toggle" aria-label="toggle Gateway Manager subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-3-gateway-manager-subtree" role="group" aria-label="Gateway Manager"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-3-2-dedicated-cloud-gateways-subtree"> Dedicated Cloud Gateways <button class="sidebar-tree-toggle" aria-label="toggle Dedicated Cloud Gateways subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-3-2-dedicated-cloud-gateways-subtree" role="group" aria-label="Dedicated Cloud Gateways"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/dedicated-cloud-gateways/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/dedicated-cloud-gateways/provision-cloud-gateway/"> Provision a Dedicated Cloud Gateway </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/dedicated-cloud-gateways/securing-backend-traffic/"> Securing Backend Traffic </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/dedicated-cloud-gateways/transit-gateways/"> Transit Gateways </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/dedicated-cloud-gateways/azure-peering/"> Azure VNET Peering </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/dedicated-cloud-gateways/custom-dns/"> Custom Domains </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/dedicated-cloud-gateways/data-plane-logs/"> Data plane logs </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-3-3-serverless-gateways-subtree"> Serverless Gateways <button class="sidebar-tree-toggle" aria-label="toggle Serverless Gateways subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-3-3-serverless-gateways-subtree" role="group" aria-label="Serverless Gateways"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/serverless-gateways/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/serverless-gateways/provision-serverless-gateway/"> Provision a serverless Gateway </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/serverless-gateways/securing-backend-traffic/"> Securing Backend Traffic </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/serverless-gateways/custom-dns/"> Custom Domains </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-3-4-data-plane-nodes-subtree"> Data Plane Nodes <button class="sidebar-tree-toggle" aria-label="toggle Data Plane Nodes subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-3-4-data-plane-nodes-subtree" role="group" aria-label="Data Plane Nodes"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/data-plane-nodes/"> Installation Options </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/data-plane-nodes/upgrade/"> Upgrade a Data Plane Node </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/data-plane-nodes/verify-node/"> Verify a Data Plane Node </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/data-plane-nodes/secure-communications/"> Secure Control Plane/Data Plane Communications </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/data-plane-nodes/renew-certificates/"> Renew Data Plane Certificates </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/data-plane-nodes/parameter-reference/"> Parameter Reference </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/data-plane-nodes/custom-dp-labels/"> Using Custom DP Labels </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-3-5-control-plane-groups-subtree"> Control Plane Groups <button class="sidebar-tree-toggle" aria-label="toggle Control Plane Groups subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-3-5-control-plane-groups-subtree" role="group" aria-label="Control Plane Groups"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/control-plane-groups/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/control-plane-groups/how-to/"> Working with Control Plane Groups </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/control-plane-groups/migrate/"> Migrate Configuration into Control Plane Groups </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/control-plane-groups/conflicts/"> Conflicts in Control Planes </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-3-6-kong-gateway-configuration-in-konnect-subtree"> Kong Gateway Configuration in Konnect <button class="sidebar-tree-toggle" aria-label="toggle Kong Gateway Configuration in Konnect subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-3-6-kong-gateway-configuration-in-konnect-subtree" role="group" aria-label="Kong Gateway Configuration in Konnect"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/configuration/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-3-6-2-manage-plugins-subtree"> Manage Plugins <button class="sidebar-tree-toggle" aria-label="toggle Manage Plugins subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-3-6-2-manage-plugins-subtree" role="group" aria-label="Manage Plugins"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/plugins/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/plugins/add-custom-plugin/"> Adding Custom Plugins </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/plugins/update-custom-plugin/"> Updating Custom Plugins </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/../../gateway/latest/plugin-development/"> How to Create Custom Plugins </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/configuration/consumer-groups/"> Create Consumer Groups </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-3-6-4-secrets-management-subtree"> Secrets Management <button class="sidebar-tree-toggle" aria-label="toggle Secrets Management subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-3-6-4-secrets-management-subtree" role="group" aria-label="Secrets Management"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/configuration/vaults/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/configuration/config-store/"> Konnect Config Store </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/configuration/vaults/how-to/"> Set Up and Use a Vault in Konnect </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/declarative-config/"> Manage Control Plane Configuration with decK </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/kic/"> KIC Association </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/backup-restore/"> Backup and Restore </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/version-compatibility/"> Version Compatibility </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/gateway-manager/troubleshoot/"> Troubleshooting </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-4-mesh-manager-subtree"> <img src="/assets/images/icons/konnect/icn-mesh-manager-nav.svg" alt=""> Mesh Manager <button class="sidebar-tree-toggle" aria-label="toggle Mesh Manager subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-4-mesh-manager-subtree" role="group" aria-label="Mesh Manager"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/mesh-manager/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/mesh-manager/service-mesh/"> Create a mesh with the Kubernetes demo app </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/mesh-manager/federate-zone/"> Federate a zone control plane to Konnect </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/mesh-manager/migrate-zone/"> Migrate a self-managed zone control plane to Konnect </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-5-service-catalog-subtree"> <img src="/assets/images/icons/konnect/icn-servicehub-nav.svg" alt=""> Service Catalog <button class="sidebar-tree-toggle" aria-label="toggle Service Catalog subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-5-service-catalog-subtree" role="group" aria-label="Service Catalog"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/service-catalog/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-5-2-integrations-subtree"> Integrations <button class="sidebar-tree-toggle" aria-label="toggle Integrations subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-5-2-integrations-subtree" role="group" aria-label="Integrations"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/service-catalog/integrations/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/service-catalog/integrations/github/"> GitHub </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/service-catalog/integrations/pagerduty/"> PagerDuty </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/service-catalog/integrations/swaggerhub/"> SwaggerHub </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/service-catalog/integrations/traceable/"> Traceable </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/service-catalog/integrations/datadog/"> Datadog </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/service-catalog/integrations/gitlab/"> GitLab </a> </span> </li> </ul> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-6-api-products-subtree"> <img src="/assets/images/icons/konnect/icn-api-product.svg" alt=""> API Products <button class="sidebar-tree-toggle" aria-label="toggle API Products subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-6-api-products-subtree" role="group" aria-label="API Products"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api-products/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api-products/service-documentation/"> Product Documentation </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api-products/productize-service/"> Productize a Service </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-7-dev-portal-subtree"> <img src="/assets/images/icons/konnect/icn-dev-portal-nav.svg" alt=""> Dev Portal <button class="sidebar-tree-toggle" aria-label="toggle Dev Portal subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-7-dev-portal-subtree" role="group" aria-label="Dev Portal"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/configuration-prep/"> Dev Portal Configuration Preparation </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/create-dev-portal/"> Create a Dev Portal </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/dev-reg/"> Sign Up for a Dev Portal Account </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/publish-service/"> Publish an API to Dev Portal </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-7-6-access-and-approval-subtree"> Access and Approval <button class="sidebar-tree-toggle" aria-label="toggle Access and Approval subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-7-6-access-and-approval-subtree" role="group" aria-label="Access and Approval"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/access-and-approval/manage-devs/"> Manage Developer Access </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/access-and-approval/manage-teams/"> Manage Developer Team Access </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/access-and-approval/add-teams/"> Add Developer Teams from IdPs </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/access-and-approval/manage-app-connections/"> Manage Application Registrations </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/access-and-approval/sso/"> Configure generic SSO for Dev Portal </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/access-and-approval/okta-idp/"> Configure Okta SSO for Dev Portal </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/applications/application-overview/"> Application Lifecycle </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/register-and-create-app/"> Register and create an application as a developer </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/applications/enable-app-reg/"> Enable and Disable App Registration for API Product Versions </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-7-10-dynamic-client-registration-subtree"> Dynamic Client Registration <button class="sidebar-tree-toggle" aria-label="toggle Dynamic Client Registration subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-7-10-dynamic-client-registration-subtree" role="group" aria-label="Dynamic Client Registration"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/applications/dynamic-client-registration/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/applications/dynamic-client-registration/okta/"> Okta </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/applications/dynamic-client-registration/curity/"> Curity </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/applications/dynamic-client-registration/auth0/"> Auth0 </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/applications/dynamic-client-registration/azure/"> Azure </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/applications/dynamic-client-registration/custom/"> Custom IdP </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/konnect-portal-management-automation/"> Portal Management API Automation Guide </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-7-12-audit-logging-subtree"> Audit Logging <button class="sidebar-tree-toggle" aria-label="toggle Audit Logging subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-7-12-audit-logging-subtree" role="group" aria-label="Audit Logging"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/audit-logging/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/audit-logging/webhook/"> Set up an Audit Log Webhook </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/audit-logging/replay-job/"> Set up an Audit Log Replay Job </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-7-13-portal-customization-subtree"> Portal Customization <button class="sidebar-tree-toggle" aria-label="toggle Portal Customization subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-7-13-portal-customization-subtree" role="group" aria-label="Portal Customization"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/customization/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/customization/self-hosted-portal/"> About Self-Hosted Dev Portal </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/customization/netlify/"> Host your Dev Portal with Netlify </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/customization/custom-dns/"> Custom Domains </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="https://www.npmjs.com/package/@kong/sdk-portal-js/" target="_blank" rel="noopener nofollow noreferrer "> Dev Portal SDK </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/dev-portal/troubleshoot/"> Troubleshoot </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-8-advanced-analytics-subtree"> <img src="/assets/images/icons/konnect/icn-analytics-nav.svg" alt=""> Advanced Analytics <button class="sidebar-tree-toggle" aria-label="toggle Advanced Analytics subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-8-advanced-analytics-subtree" role="group" aria-label="Advanced Analytics"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/analytics/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/analytics/dashboard/"> Dashboard </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/analytics/explorer/"> Explorer </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/analytics/use-cases/"> Analyze API Usage and Performance with Reports </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/analytics/api-requests/"> Requests </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-9-org-management-subtree"> <img src="/assets/images/icons/konnect/icn-organizations-nav.svg" alt=""> Org Management <button class="sidebar-tree-toggle" aria-label="toggle Org Management subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-9-org-management-subtree" role="group" aria-label="Org Management"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/account-management/"> Plans and Billing </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-9-2-authentication-and-authorization-subtree"> Authentication and Authorization <button class="sidebar-tree-toggle" aria-label="toggle Authentication and Authorization subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-9-2-authentication-and-authorization-subtree" role="group" aria-label="Authentication and Authorization"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/auth/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-9-2-2-teams-subtree"> Teams <button class="sidebar-tree-toggle" aria-label="toggle Teams subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-9-2-2-teams-subtree" role="group" aria-label="Teams"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/teams-and-roles/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/teams-and-roles/manage/"> Manage Teams </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/teams-and-roles/teams-reference/"> Teams Reference </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/teams-and-roles/roles-reference/"> Roles Reference </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/users/"> Manage Users </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/system-accounts/"> Manage System Accounts </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/access-tokens/"> Personal Access Tokens </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/social-identity-login/"> Social Identity Login </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/org-switcher/"> Org Switcher </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/sso/"> Configure Generic SSO </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/okta-idp/"> Configure Okta SSO </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/sessions-reference/"> Login Sessions Reference </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/troubleshoot/"> Troubleshoot </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-9-3-audit-logging-subtree"> Audit Logging <button class="sidebar-tree-toggle" aria-label="toggle Audit Logging subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-9-3-audit-logging-subtree" role="group" aria-label="Audit Logging"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/audit-logging/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/audit-logging/webhook/"> Set up an Audit Log Webhook </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/audit-logging/replay-job/"> Set up an Audit Log Replay Job </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/org-management/deactivation/"> Account and Org Deactivation </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-10-api-subtree"> <img src="/assets/images/icons/documentation/icn-admin-api-color.svg" alt=""> API <button class="sidebar-tree-toggle" aria-label="toggle API subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-10-api-subtree" role="group" aria-label="API"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/"> Overview </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-10-2-api-request-api-beta-subtree"> API Request API (Beta) <button class="sidebar-tree-toggle" aria-label="toggle API Request API (Beta) subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-10-2-api-request-api-beta-subtree" role="group" aria-label="API Request API (Beta)"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/api-requests/latest/" target="_blank"> API Spec </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-10-3-api-products-api-subtree"> API Products API <button class="sidebar-tree-toggle" aria-label="toggle API Products API subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-10-3-api-products-api-subtree" role="group" aria-label="API Products API"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/api-products/latest/" target="_blank"> API Spec </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-10-4-audit-logs-api-subtree"> Audit Logs API <button class="sidebar-tree-toggle" aria-label="toggle Audit Logs API subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-10-4-audit-logs-api-subtree" role="group" aria-label="Audit Logs API"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/audit-logs/latest/" target="_blank"> API Spec </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/audit-logs/webhook/"> Audit Log Webhooks </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-10-5-control-plane-api-subtree"> Control Plane API <button class="sidebar-tree-toggle" aria-label="toggle Control Plane API subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-10-5-control-plane-api-subtree" role="group" aria-label="Control Plane API"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/control-planes/latest/" target="_blank"> API Spec </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-10-6-control-plane-configuration-api-subtree"> Control Plane Configuration API <button class="sidebar-tree-toggle" aria-label="toggle Control Plane Configuration API subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-10-6-control-plane-configuration-api-subtree" role="group" aria-label="Control Plane Configuration API"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/control-plane-configuration/latest/" target="_blank"> API Spec </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-10-7-cloud-gateways-api-subtree"> Cloud Gateways API <button class="sidebar-tree-toggle" aria-label="toggle Cloud Gateways API subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-10-7-cloud-gateways-api-subtree" role="group" aria-label="Cloud Gateways API"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/cloud-gateways/latest/" target="_blank"> API Spec </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-10-8-identity-api-subtree"> Identity API <button class="sidebar-tree-toggle" aria-label="toggle Identity API subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-10-8-identity-api-subtree" role="group" aria-label="Identity API"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/identity-management/latest/" target="_blank"> API Spec </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/identity-management/identity-integration/"> Identity Integration Guide </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/identity-management/sso/"> SSO Customization </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-10-9-konnect-search-api-beta-subtree"> Konnect Search API (Beta) <button class="sidebar-tree-toggle" aria-label="toggle Konnect Search API (Beta) subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-10-9-konnect-search-api-beta-subtree" role="group" aria-label="Konnect Search API (Beta)"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/search/latest/" target="_blank"> API Spec </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-10-10-mesh-manager-api-subtree"> Mesh Manager API <button class="sidebar-tree-toggle" aria-label="toggle Mesh Manager API subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-10-10-mesh-manager-api-subtree" role="group" aria-label="Mesh Manager API"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/mesh-manager/latest/" target="_blank"> API Spec </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/mesh/latest/reference/http-api/" target="_blank"> Kong Mesh API Reference </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-10-11-portal-client-api-subtree"> Portal Client API <button class="sidebar-tree-toggle" aria-label="toggle Portal Client API subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-10-11-portal-client-api-subtree" role="group" aria-label="Portal Client API"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect-portal/api/latest/" target="_blank"> API Spec </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-10-12-portal-management-api-subtree"> Portal Management API <button class="sidebar-tree-toggle" aria-label="toggle Portal Management API subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-10-12-portal-management-api-subtree" role="group" aria-label="Portal Management API"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/portal-management/latest/" target="_blank"> API Spec </a> </span> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-10-13-reference-subtree"> Reference <button class="sidebar-tree-toggle" aria-label="toggle Reference subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-10-13-reference-subtree" role="group" aria-label="Reference"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/filtering/"> Filtering </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/api/errors/"> API Errors </a> </span> </li> </ul> </li> </ul> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label" aria-expanded="false" aria-owns="id-11-reference-subtree"> <img src="/assets/images/icons/documentation/icn-references-color.svg" alt=""> Reference <button class="sidebar-tree-toggle" aria-label="toggle Reference subtree" tabindex="-1"> <i class="fa fa-chevron-down"></i> </button> </span> <ul class="items" id="id-11-reference-subtree" role="group" aria-label="Reference"> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/reference/labels/"> Labels </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/reference/plugins/"> Plugin Ordering Reference </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/reference/search/"> Konnect Search </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/reference/terraform/"> Terraform Provider </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/reference/audit-logs/"> Audit Logs </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/reference/verify-signatures/"> Verify audit log signatures </a> </span> </li> <li class="sidebar-item" role="none"> <span role="treeitem" class="sidebar-label"> <a class="sidebar-link" tabindex="-1" href="/konnect/reference/saml-idp-mappings/"> IdP SAML attribute mapping </a> </span> </li> </ul> </li> </ul> </aside> <aside class="docs-toc"> <i class="fa fa-times close-sidebar"></i> <i class="fa fa-chevron-right collapse-toc"></i> <i class="far fa-list-alt expand-toc"></i> <div id="oss-ee-toggle" data-current="Enterprise" style="display: none"> <span class="oss-ee-toggle-inner"> <img src="/assets/images/icons/icn-enterprise-black.svg" alt="enterprise-switcher-icon"> <span>Switch to <span id="switch-to-version">OSS</span></span> </span> </div> <div class="docs-toc-title"> <img src="/assets/images/icons/hub-layout/icn-on-this-page.svg" alt="On this page"><a href="#">On this page</a> </div> <ul> <li><a href="#prerequisites" class="active scroll-to">Prerequisites</a></li> <li><a href="#test-your-connection" class="scroll-to">Test your connection</a></li> <li><a href="#create-a-configuration-file" class="scroll-to">Create a configuration file</a></li> <li><a href="#make-changes-to-configuration" class="scroll-to">Make changes to configuration</a></li> <li><a href="#manage-consumers-and-global-plugins" class="scroll-to">Manage consumers and global plugins</a></li> <li><a href="#test-the-service" class="scroll-to">Test the service</a></li> <li><a href="#migrate-configuration-between-control-planes" class="scroll-to">Migrate configuration between control planes</a></li> <li><a href="#more-information" class="scroll-to">More information</a></li> </ul> </aside> <div class="page-content-container page-content-container-doc v2 " id="documentation"> <div class="toggles "> <i class="far fa-list-alt toc-sidebar-toggle"></i> </div> <div class="page-content"> <div class="content show-anchor-links"> <h1 tabindex="-1" id="main" class="page-content-title">Manage Control Plane Configuration with decK </h1> <p>You can manage control planes in your Kong Konnect org using configuration files instead of the GUI or admin API commands. With decK, Kong’s declarative configuration management tool, you can create, update, compare, and synchronize configuration as part of an automation pipeline.</p> <p>In Kong Konnect, decK can manage <a href="/konnect/gateway-manager/#control-planes">control planes</a> and all of their configurations:</p> <ul> <li>Create state files for different control planes and manage each one separately.</li> <li>Manage <a href="/konnect/api/">Gateway entities</a> for each control plane.</li> <li>Migrate configuration from one control plane to another.</li> </ul> <p>One way to learn decK or write a decK file is to view the YAML generated files in Konnect. Konnect autogenerates a YAML configuration file that reflects the current Gateway Manager configuration. You can view and copy the current configuration on the <strong>Configuration</strong> tab of each entity in Gateway Manager.</p> <p>Use a <code class="language-plaintext highlighter-rouge">--konnect</code>-prefixed CLI flag or pass Konnect parameters using a decK configuration file (<code class="language-plaintext highlighter-rouge">~/.deck.yaml</code> by default) to target <code class="language-plaintext highlighter-rouge">https://cloud.konghq.com</code>. If you don’t pass any Konnect parameters to decK, decK looks for a local Kong Gateway instance instead.</p> <p>Run <code class="language-plaintext highlighter-rouge">deck help</code> to see all available flags, or see the <a href="/deck/latest/reference/deck/">decK CLI reference</a>.</p> <p>You <em>cannot</em> use decK to publish content to the Dev Portal, manage application registration, or configure custom plugins.</p> <h2 id="prerequisites">Prerequisites</h2> <ul> <li>decK v1.40.0 or later <a href="/deck/latest/installation/">installed</a>.</li> <li>Optional: To test your configuration, <a href="/konnect/getting-started/configure-data-plane-node/">set up a simple data plane node</a>.</li> <li>A <a href="/konnect/org-management/access-tokens/">personal access token (PAT)</a>.</li> </ul> <h2 id="test-your-connection">Test your connection</h2> <p>Check that you can log in to Konnect and that decK recognizes your account credentials:</p> <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>deck gateway ping <span class="se">\</span> <span class="nt">--konnect-control-plane-name</span> default <span class="se">\</span> <span class="nt">--konnect-token</span> <span class="o">{</span>YOUR_PERSONAL_ACCESS_TOKEN<span class="o">}</span> </code></pre></div></div> <p>If the connection is successful, the terminal displays the full name of the user associated with the account:</p> <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Successfully Konnected to the Example-Name organization! </code></pre></div></div> <p>You can also use decK with Konnect more securely by storing your personal access token in a file, then either calling it with <code class="language-plaintext highlighter-rouge">--konnect-token-file /path/{FILENAME}.txt</code>, or adding it to your decK configuration file under the <code class="language-plaintext highlighter-rouge">konnect-token</code> option:</p> <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">konnect-token</span><span class="pi">:</span> <span class="pi">{</span><span class="nv">YOUR_PERSONAL_ACCESS_TOKEN</span><span class="pi">}</span> </code></pre></div></div> <p>The default location for this file is <code class="language-plaintext highlighter-rouge">$HOME/.deck.yaml</code>. You can target a different configuration file with the <code class="language-plaintext highlighter-rouge">--config /path/{FILENAME}.yaml</code> flag, if needed.</p> <p>The following steps all use a <code class="language-plaintext highlighter-rouge">.deck.yaml</code> file to store the Konnect credentials instead of flags.</p> <h2 id="create-a-configuration-file">Create a configuration file</h2> <p>Capture a snapshot of the current configuration in a file:</p> <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>deck gateway dump <span class="nt">--konnect-control-plane-name</span> default <span class="nt">-o</span> konnect.yaml </code></pre></div></div> <p>If you don’t specify the <code class="language-plaintext highlighter-rouge">--konnect-control-plane-name</code> flag, decK will target the <code class="language-plaintext highlighter-rouge">default</code> control plane. If you have more than one control plane in your organization, we recommend always setting this flag to avoid accidentally pushing configuration to the wrong group.</p> <p>The command creates a file named <code class="language-plaintext highlighter-rouge">konnect.yaml</code>. If you have nothing configured, decK creates the file with only the format version and control plane name:</p> <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">_format_version</span><span class="pi">:</span> <span class="s2">"</span><span class="s">3.0"</span> <span class="na">_konnect</span><span class="pi">:</span> <span class="na">control_plane_name</span><span class="pi">:</span> <span class="s">default</span> </code></pre></div></div> <p>You can specify a different filename or location, or export the configuration in JSON format:</p> <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>deck gateway dump <span class="nt">--konnect-control-plane-name</span> default <span class="se">\</span> <span class="nt">--format</span> json <span class="se">\</span> <span class="nt">--output-file</span> examples/konnect.json </code></pre></div></div> <h2 id="make-changes-to-configuration">Make changes to configuration</h2> <p>Make any changes you like using YAML or JSON format. For this example, let’s add a new service.</p> <ol> <li> <p>Add the following snippet to your <code class="language-plaintext highlighter-rouge">konnect.yaml</code> file:</p> <div class="language-yaml highlighter-rouge"> <div class="highlight"><pre class="highlight"><code> <span class="na">_format_version</span><span class="pi">:</span> <span class="s2">"</span><span class="s">3.0"</span> <span class="na">_konnect</span><span class="pi">:</span> <span class="na">control_plane_name</span><span class="pi">:</span> <span class="s">default</span> <span class="na">services</span><span class="pi">:</span> <span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">MyService</span> <span class="na">host</span><span class="pi">:</span> <span class="s">httpbin.konghq.com</span> <span class="na">port</span><span class="pi">:</span> <span class="m">80</span> <span class="na">protocol</span><span class="pi">:</span> <span class="s">http</span> <span class="na">routes</span><span class="pi">:</span> <span class="pi">-</span> <span class="na">methods</span><span class="pi">:</span> <span class="pi">-</span> <span class="s">GET</span> <span class="pi">-</span> <span class="s">POST</span> <span class="na">name</span><span class="pi">:</span> <span class="s">mockpath</span> <span class="na">paths</span><span class="pi">:</span> <span class="pi">-</span> <span class="s">/mock</span> <span class="na">plugins</span><span class="pi">:</span> <span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">key-auth</span> <span class="na">config</span><span class="pi">:</span> <span class="na">key_names</span><span class="pi">:</span> <span class="pi">-</span> <span class="s">apikey</span> </code></pre></div> </div> <p>This snippet defines a service named <code class="language-plaintext highlighter-rouge">MyService</code> pointing to <code class="language-plaintext highlighter-rouge">httpbin.konghq.com</code>. The service has one version, and the version gets implemented with the route <code class="language-plaintext highlighter-rouge">/mock</code>, which means that you can access the service by appending this route to your proxy URL.</p> <p>Because you’re also enabling the <code class="language-plaintext highlighter-rouge">key-auth</code> plugin on the route, you need a consumer key to access it, so you can’t test the route yet.</p> </li> <li> <p>Compare your local file with the configuration currently in Kong Konnect:</p> <div class="language-sh highlighter-rouge"> <div class="highlight"><pre class="highlight"><code> deck gateway diff konnect.yaml <span class="nt">--konnect-control-plane-name</span> default </code></pre></div> </div> <p>If the format and schema is correct, decK gives you a preview of what would be added to the Kong Konnect configuration:</p> <div class="language-sh highlighter-rouge"> <div class="highlight"><pre class="highlight"><code> creating service MyService creating route mockpath creating plugin key-auth <span class="k">for </span>route mockpath Summary: Created: 3 Updated: 0 Deleted: 0 </code></pre></div> </div> </li> <li> <p>If you’re satisfied with the preview, sync the changes to Kong Konnect:</p> <div class="language-sh highlighter-rouge"> <div class="highlight"><pre class="highlight"><code> deck gateway <span class="nb">sync </span>konnect.yaml <span class="nt">--konnect-control-plane-name</span> default </code></pre></div> </div> <p>You should see the same output again:</p> <div class="language-sh highlighter-rouge"> <div class="highlight"><pre class="highlight"><code> creating service MyService creating route mockpath creating plugin key-auth <span class="k">for </span>route mockpath Summary: Created: 3 Updated: 0 Deleted: 0 </code></pre></div> </div> </li> <li> <p>Check Kong Konnect to make sure the sync worked. Open <strong>Gateway Manager</strong>, select your control plane, and select <strong>Gateway Services</strong>.</p> <p>You should see a new service named <code class="language-plaintext highlighter-rouge">MyService</code> in the control plane.</p> </li> </ol> <h2 id="manage-consumers-and-global-plugins">Manage consumers and global plugins</h2> <p>You can also use decK to manage objects not tied to a specific service or route. For this example, create a consumer and a global proxy caching plugin:</p> <ul> <li> <p>Consumers represent users of a service, and are most often used for authentication. They provide a way to divide access to your services, and make it easy to revoke that access without disturbing a service’s function.</p> </li> <li> <p>Global plugins are plugins that apply to all services, routes, and consumers in the control plane, as applicable. For example, you can configure proxy caching on all your services at once with one <code class="language-plaintext highlighter-rouge">proxy-cache</code> plugin entry.</p> </li> </ul> <ol> <li> <p>In the previous section, you created a route with key authentication. To access this route, add a consumer to the <code class="language-plaintext highlighter-rouge">konnect.yaml</code> file and configure a key:</p> <div class="language-yaml highlighter-rouge"> <div class="highlight"><pre class="highlight"><code> <span class="na">consumers</span><span class="pi">:</span> <span class="pi">-</span> <span class="na">custom_id</span><span class="pi">:</span> <span class="s">consumer</span> <span class="na">username</span><span class="pi">:</span> <span class="s">consumer</span> <span class="na">keyauth_credentials</span><span class="pi">:</span> <span class="pi">-</span> <span class="na">key</span><span class="pi">:</span> <span class="s">apikey</span> </code></pre></div> </div> </li> <li> <p>Enable proxy caching so that your upstream service is not bogged down with repeated requests. Add a global proxy cache plugin:</p> <div class="language-yaml highlighter-rouge"> <div class="highlight"><pre class="highlight"><code> <span class="na">plugins</span><span class="pi">:</span> <span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">proxy-cache</span> <span class="na">config</span><span class="pi">:</span> <span class="na">content_type</span><span class="pi">:</span> <span class="pi">-</span> <span class="s2">"</span><span class="s">application/json;</span><span class="nv"> </span><span class="s">charset=utf-8"</span> <span class="na">cache_ttl</span><span class="pi">:</span> <span class="m">30</span> <span class="na">strategy</span><span class="pi">:</span> <span class="s">memory</span> </code></pre></div> </div> </li> <li> <p>Run a diff to test your changes:</p> <div class="language-sh highlighter-rouge"> <div class="highlight"><pre class="highlight"><code> deck gateway diff konnect.yaml <span class="nt">--konnect-control-plane-name</span> default </code></pre></div> </div> </li> <li> <p>If everything looks good, run another sync, then check Kong Konnect to see your changes:</p> <div class="language-sh highlighter-rouge"> <div class="highlight"><pre class="highlight"><code> deck gateway <span class="nb">sync </span>konnect.yaml <span class="nt">--konnect-control-plane-name</span> default </code></pre></div> </div> </li> </ol> <h2 id="test-the-service">Test the service</h2> <p>If you have already have a data plane node deployed, you can test this configuration now. Or, you can start a new data plane node using the <a href="/konnect/getting-started/configure-data-plane-node/">Docker quick setup</a> script.</p> <p>The default proxy URL is <code class="language-plaintext highlighter-rouge">localhost:8000</code>.</p> <p>Make a call to the proxy URL and append the route path <code class="language-plaintext highlighter-rouge">/mock</code> with an <code class="language-plaintext highlighter-rouge">apikey</code> header:</p> <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code> curl <span class="nt">-i</span> <span class="nt">-X</span> GET http://localhost:8000/mock <span class="se">\</span> <span class="nt">-H</span> <span class="s1">'apikey: {API_KEY}'</span> </code></pre></div></div> <p>If successful, you should see the homepage for <code class="language-plaintext highlighter-rouge">httpbin.konghq.com</code>. On the Service Version overview page, you’ll see a record for status code <code class="language-plaintext highlighter-rouge">200</code>.</p> <p>If you try to access the route without a key, you’ll get an authorization error:</p> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Kong Error No API key found in request. </code></pre></div></div> <h2 id="migrate-configuration-between-control-planes">Migrate configuration between control planes</h2> <p>You can also use decK to migrate or duplicate configuration between control planes.</p> <ol> <li> <p>Export configuration from the original control plane with <a href="/deck/latest/reference/deck_gateway_dump"><code class="language-plaintext highlighter-rouge">deck gateway dump</code></a> into a state file:</p> <div class="language-bash highlighter-rouge"> <div class="highlight"><pre class="highlight"><code> deck gateway dump <span class="se">\</span> <span class="nt">--konnect-control-plane-name</span> default <span class="se">\</span> <span class="nt">--output-file</span> default.yaml </code></pre></div> </div> </li> <li> <p>In the file, change the control plane name to the new group:</p> <div class="language-yaml highlighter-rouge"> <div class="highlight"><pre class="highlight"><code> <span class="na">_format_version</span><span class="pi">:</span> <span class="s">3.0"</span> <span class="na">_konnect</span><span class="pi">:</span> <span class="na">control_plane_name</span><span class="pi">:</span> <span class="s">staging</span> </code></pre></div> </div> </li> <li> <p>Using the state file you just edited, preview the import with the <a href="/deck/latest/reference/deck_gateway_diff/"><code class="language-plaintext highlighter-rouge">deck gateway diff</code></a> command, pointing to the control plane that you want to target:</p> <div class="language-sh highlighter-rouge"> <div class="highlight"><pre class="highlight"><code> deck gateway diff default.yaml <span class="se">\</span> <span class="nt">--konnect-control-plane-name</span> staging </code></pre></div> </div> </li> <li> <p>If everything looks good, <a href="/deck/latest/reference/deck_gateway_sync/"><code class="language-plaintext highlighter-rouge">deck gateway sync</code></a> the configuration to the new control plane:</p> <div class="language-sh highlighter-rouge"> <div class="highlight"><pre class="highlight"><code> deck gateway <span class="nb">sync </span>default.yaml <span class="se">\</span> <span class="nt">--konnect-control-plane-name</span> staging </code></pre></div> </div> </li> </ol> <p>You should now have two control planes in Konnect with the same configuration.</p> <h2 id="more-information">More information</h2> <ul> <li><a href="/deck/latest/reference/deck/">decK CLI reference</a></li> <li><a href="/konnect/getting-started/migration/">Import Kong Gateway configuration into Konnect</a></li> </ul> </div> </div> </div> <div id="scroll-to-top-button"> <i class="fas fa-chevron-up"></i> </div> <div class="feedback-widget-container"> <input id="feedback-widget-checkbox" type="checkbox"> <label for="feedback-widget-checkbox"> <img src="/assets/images/icons/feedback-widget.svg" alt="Feedback widget"> </label> <div class="feedback-container"> <div class="feedback-thankyou"> Thank you for your feedback. </div> <div class="feedback-comment"> <textarea id="feedback-comment-text" rows="3" placeholder="Please let us know what we can improve on this page..."></textarea> <div class="feedback-comment-buttons"> <button id="feedback-comment-button-back">Back</button> <button id="feedback-comment-button-submit" class="button-primary">Submit</button> </div> </div> <div class="feedback-options"> <div class="feedback-options-title">Was this page useful?</div> <div class="feedback-options-buttons"> <i data-feedback-result="yes" class="feedback-options-button far fa-thumbs-up"></i> <i data-feedback-result="no" class="feedback-options-button far fa-thumbs-down"></i> </div> </div> </div> </div> </div> <div id="image-modal" data-image-expand-disabled=""> <div class="image-modal-backdrop"></div> <div class="image-container"> <img src="" alt=""> <i class="fa fa-times"></i> </div> </div> <div class="modal closed" id="modal" role="dialog" aria-hidden="true" aria-labelledby="title" aria-describedby="description"> <div class="konnect-cta-card"> <div class="title"> Too much on your plate? <a href="#" class="cta-card-close modal-close" id="modal-close"> <img src="/assets/images/icons/documentation/close.svg" alt="close cta icon"> </a> </div> <div class="description"> More features, less infrastructure with Kong Konnect. 1M requests per month for free. </div> <a href="https://konghq.com/products/kong-konnect/register?utm_medium=referral&utm_source=docs&utm_campaign=gateway-konnect&utm_campaign=right-nav-card&utm_content=konnect" class="button" target="_blank" rel="noopener nofollow noreferrer "> Try it for Free </a> </div> </div> <div id="modal-open" class="modal-open"></div> <div class="modal-overlay closed" id="modal-overlay"></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. 2025 </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 = {}; facetParameters = {"version[0]":"latest","product[0]":"Kong Konnect"}; 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, }; }, searchParameters: { optionalFilters: ['product:deck<score=1>', 'product:Plugin Hub<score=2>', 'product:Kong Konnect<score=3>'], facetFilters: [ 'version:latest'] } }); </script> <script> (function() { if (typeof window === 'undefined') return; if (typeof window.signals !== 'undefined') return; var script = document.createElement('script'); script.src = 'https://cdn.cr-relay.com/v1/site/993c7a0d-caec-465c-be46-2d3a78ab60c5/signals.js'; script.async = true; window.signals = Object.assign( [], ['page', 'identify', 'form'].reduce(function (acc, method){ acc[method] = function () { signals.push([method, arguments]); return signals; }; return acc; }, {}) ); document.head.appendChild(script); })(); </script> </div> </body> </html>

CINXE.COM

Manage Control Plane Configuration with decK - Kong Konnect | Kong Docs