Requires an Account API key with the account:environments:api_keys:create scope. Create one from Account API keys in the dashboard.
Creates an Environment API key with custom scopes. Not specifying any scopes defaults to full environment access.environmentUuid is the UUID returned when the environment was created.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Nango Docs","colors":{"primary":"#29abe2","light":"#71c0e2","dark":"#217ea6"},"logo":{"light":"https://mintcdn.com/nango/h2zzveDlAs05T6zr/images/Nango-Light-Mode.svg?fit=max\u0026auto=format\u0026n=h2zzveDlAs05T6zr\u0026q=85\u0026s=0c2845b2219705011e11ef4985aa9d91","dark":"https://mintcdn.com/nango/h2zzveDlAs05T6zr/images/Nango-Dark-Mode.svg?fit=max\u0026auto=format\u0026n=h2zzveDlAs05T6zr\u0026q=85\u0026s=850ee557541d6e0b523aa22a086f45c5","href":"https://nango.dev"},"favicon":{"light":"https://mintcdn.com/nango/J3bBfZ1D3NjDI-Wu/favicon-black.svg?fit=max\u0026auto=format\u0026n=J3bBfZ1D3NjDI-Wu\u0026q=85\u0026s=6759e69f959345295eaa1a3b61eff463","dark":"https://mintcdn.com/nango/J3bBfZ1D3NjDI-Wu/favicon-white.svg?fit=max\u0026auto=format\u0026n=J3bBfZ1D3NjDI-Wu\u0026q=85\u0026s=f9b0cb2c74ef91143ca48dea01bb16e0"},"api":{"mdx":{"auth":{"method":"bearer"},"server":["https://api.nango.dev","http://localhost:3003"]}},"appearance":{"default":"system"},"background":{"decoration":"grid","color":{"light":"#ffffff","dark":"#0b0b0c"}},"navbar":{"links":[{"href":"https://github.com/NangoHQ/nango","label":"GitHub","type":"github"},{"href":"https://app.nango.dev","label":"Log In"}],"primary":{"type":"button","label":"Sign Up","href":"https://app.nango.dev/signup"}},"footer":{"socials":{"twitter":"https://twitter.com/NangoHQ","linkedin":"https://www.linkedin.com/company/nangohq","github":"https://github.com/NangoHQ/nango","slack":"https://nango.dev/slack","website":"https://nango.dev/"}},"seo":{"metatags":{"og:type":"website","og:site_name":"Nango Docs"},"indexing":"all"},"fonts":{"family":"Albert Sans"},"integrations":{"gtm":{"tagId":"GTM-N4KVPWR"}},"contextual":{"options":["copy","mcp","cursor","vscode","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nango","hasAudioNarration":false,"actualSubdomain":"nango","customDomains":["nango.dev"],"gitSource":{"type":"github","owner":"nangohq","repo":"nango","deployBranch":"master","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae2384e062c116bf4115d7c","collectionId":"2228dead-1fde-4e8c-b6e5-5091eee155cb","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae2384e062c116bf4115d7c"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae2384e062c116bf4115d7c","clientVersion":"0.0.4005","searchFilterCounts":[{"language":"default","tag":"APIs \u0026 Integrations","count":1076},{"language":"default","tag":"1,000+ APIs \u0026 Integrations","count":1073},{"language":"default","tag":"Documentation","count":123},{"language":"default","tag":"Reference","count":69},{"language":"default","tag":"Backend","count":66},{"language":"default","tag":"HTTP API","count":58},{"language":"default","tag":"Guides","count":43},{"language":"default","tag":"Functions","count":30},{"language":"default","tag":"Platform","count":18},{"language":"default","tag":"Getting started","count":11}]},"assistantConfig":{"enableStarterQuestions":false},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","content":".agent-quickstart-actions{display:grid;grid-template-columns:repeat(2,minmax(0,1fr));gap:12px;margin:16px 0 24px}.agent-quickstart-actions--single{grid-template-columns:minmax(0,1fr);max-width:720px}.agent-quickstart-action{display:flex;flex-direction:column;gap:6px;width:100%;padding:16px;border:1px solid rgba(0,0,0,.12);background:rgba(255,255,255,.72);color:inherit;font:inherit;text-align:left;cursor:pointer;transition:border-color 140ms ease,background-color 140ms ease,transform 140ms ease}.agent-quickstart-action:focus-visible,.agent-quickstart-action:hover{border-color:rgba(41,171,226,.7);background:rgba(41,171,226,.06);transform:translateY(-1px)}.agent-quickstart-action--primary{border-color:rgba(41,171,226,.4);background:rgba(41,171,226,.08)}.agent-quickstart-action[aria-busy=true]{opacity:.7;cursor:wait}.agent-quickstart-action-title{font-size:15px;font-weight:600;line-height:1.4}.agent-quickstart-action-description{color:#515556;font-size:14px;line-height:1.5}.dark .agent-quickstart-action{border-color:rgba(255,255,255,.14);background:rgba(255,255,255,.04)}.dark .agent-quickstart-action:focus-visible,.dark .agent-quickstart-action:hover{border-color:rgba(41,171,226,.8);background:rgba(41,171,226,.12)}.dark .agent-quickstart-action-description{color:rgba(255,255,255,.68)}.agent-copy-toast{position:fixed;right:24px;bottom:24px;z-index:250;max-width:min(320px,calc(100vw - 48px));padding:10px 12px;border:1px solid rgba(0,0,0,.1);background:#111827;color:#fff;font-size:14px;line-height:1.4;opacity:0;pointer-events:none;transform:translateY(8px);transition:opacity 140ms ease,transform 140ms ease}.agent-copy-toast[data-visible=true]{opacity:1;transform:translateY(0)}.agent-copy-toast[data-kind=error]{background:#7f1d1d}@media (max-width:640px){.agent-quickstart-actions{grid-template-columns:1fr}.agent-copy-toast{right:16px;bottom:16px;max-width:calc(100vw - 32px)}}.rounded,.rounded-2xl,.rounded-3xl,.rounded-full,.rounded-lg,.rounded-md,.rounded-sm,.rounded-xl,[class~=rounded-2xl],[class~=rounded-3xl],[class~=rounded-lg],[class~=rounded-md],[class~=rounded-sm],[class~=rounded-xl],button,code,input,kbd,pre,select,textarea{border-radius:4px!important}[class*=background-decoration]{opacity:.02!important;z-index:0!important;pointer-events:none}#navbar a[href=\"https://github.com/NangoHQ/nango\"] span.truncate,#sidebar-content .pointer-events-none.sticky{display:none!important}@media (max-width:767px){a[href=\"https://github.com/NangoHQ/nango\"]{display:none!important}}[id^=headlessui-dialog-]:not([id*=panel]){z-index:200!important}[id^=headlessui-dialog-panel],[id^=headlessui-dialog-panel] [class*=bg-background],[id^=headlessui-dialog-panel] [class*=bg-white],[id^=headlessui-dialog-panel]>div,details,summary{border-radius:4px!important}details[open]>summary{border-bottom-left-radius:0!important;border-bottom-right-radius:0!important}@media (min-width:768px){#navbar{position:fixed!important;top:0!important;left:0!important;right:0!important;width:100%!important;z-index:30!important}}.dark #navbar{background-color:#0b0b0c!important;border-bottom:1px solid rgba(255,255,255,.08)!important}html:not(.dark) #navbar{background-color:#fff!important;border-bottom:1px solid rgba(0,0,0,.08)!important}#navbar [class*=border-b]{border-bottom:none!important}.dark #sidebar-content{background-color:#0b0b0c!important}.dark :has(>#sidebar-content){border-right:1px solid rgba(255,255,255,.08)!important}html:not(.dark) :has(>#sidebar-content){border-right:1px solid rgba(0,0,0,.08)!important}#navigation-items{padding-top:20px!important}#navigation-items img[src$=\"/images/mcp.svg\"]{opacity:.38}.dark #navigation-items img[src$=\"/images/mcp.svg\"]{filter:invert(1);opacity:.58}#table-of-contents{scrollbar-width:none}#table-of-contents::-webkit-scrollbar{width:0;background:0 0}#table-of-contents:hover{scrollbar-width:thin}#table-of-contents:hover::-webkit-scrollbar{width:6px}#table-of-contents:hover::-webkit-scrollbar-thumb{background-color:rgba(128,128,128,.4);border-radius:4px}#table-of-contents:hover::-webkit-scrollbar-thumb:hover{background-color:rgba(128,128,128,.6)}#table-of-contents a{padding:4px 8px!important;border-radius:4px!important;display:block!important}html:not(.dark) #table-of-contents a{color:#515556!important}html:not(.dark) #table-of-contents a:hover{color:#000!important}.dark #table-of-contents a{color:rgba(255,255,255,.6)!important}.dark #table-of-contents a:hover{color:#fff!important}#table-of-contents .toc-item[data-depth=\"1\"]>a{padding-left:24px!important}#table-of-contents .toc-item[data-depth=\"2\"]>a{padding-left:40px!important}.dark #table-of-contents:not(:has(.toc-item[data-active=true])) .toc-item[data-scroll-active=true]>a{background-color:rgba(255,255,255,.07);color:rgba(255,255,255,.9);font-weight:500}html:not(.dark) #table-of-contents:not(:has(.toc-item[data-active=true])) .toc-item[data-scroll-active=true]>a{background-color:rgba(0,0,0,.06);color:#000;font-weight:500}@media (min-width:1024px){body:has([data-page-href*=\"updates/changelog\"]) :has(>#sidebar-content){width:184px!important;border-right:0!important;pointer-events:none!important}body:has([data-page-href*=\"updates/changelog\"]) #sidebar-content{display:none!important}body:has([data-page-href*=\"updates/changelog\"]) .update-container{margin-left:-184px!important;width:calc(100% + 184px)!important;max-width:none!important}}[data-page-href*=\"updates/changelog\"] .update-container+hr{margin-top:1rem!important;margin-bottom:1rem!important}.nav-logo,img.nav-logo,svg.nav-logo{height:36px!important;width:auto!important;max-width:none!important}#content-area{position:relative;z-index:1}@media (min-width:768px){#content-area{padding-top:6rem!important}#content-area>div:first-child{margin-top:1.5rem!important}#content-side-layout{margin-top:6rem!important}}[data-component-part=scroll-area-viewport]:has(>[data-component-part=scroll-area-content]>div>select[aria-label='Select base URL']){overflow:visible!important;mask-image:none!important}[data-component-part=scroll-area-content]:has(>div>select[aria-label='Select base URL']){min-width:0!important;flex-wrap:wrap!important;column-gap:2px!important;row-gap:2px!important}[data-component-part=scroll-area-content]:has(>div>select[aria-label='Select base URL'])>div:last-child{display:contents!important}.dark #navigation-items>ul{padding-bottom:20px!important;border-bottom:1px solid rgba(255,255,255,.08)!important;margin-bottom:0!important}html:not(.dark) #navigation-items>ul{padding-bottom:20px!important;border-bottom:1px solid rgba(0,0,0,.08)!important;margin-bottom:0!important}.dark a.nav-anchor>div[style*=background]{background:rgba(255,255,255,.1)!important}html:not(.dark) a.nav-anchor>div[style*=background]{background:rgba(0,0,0,.06)!important}.dark #sidebar-group a,.dark #sidebar-group button,.dark a.nav-anchor{color:rgba(255,255,255,.55)!important}.dark a.nav-anchor[class*=text-primary]{color:rgba(255,255,255,.9)!important}.dark a.nav-anchor:hover{color:#fff!important}html:not(.dark) #sidebar-group a,html:not(.dark) #sidebar-group button,html:not(.dark) a.nav-anchor{color:rgba(0,0,0,.7)!important}html:not(.dark) a.nav-anchor[class*=text-primary]{color:rgba(0,0,0,.9)!important}html:not(.dark) a.nav-anchor:hover{color:#000!important}.dark li[data-active=true]>a{background-color:rgba(255,255,255,.07)!important;color:#fff!important;border-radius:4px!important}html:not(.dark) li[data-active=true]>a{background-color:rgba(0,0,0,.06)!important;color:#000!important;border-radius:4px!important}.dark #sidebar-group a:hover,.dark #sidebar-group button:hover{color:rgba(255,255,255,.85)!important;background-color:rgba(255,255,255,.04)!important;border-radius:4px!important}html:not(.dark) #sidebar-group a:hover,html:not(.dark) #sidebar-group button:hover{color:rgba(0,0,0,.85)!important;background-color:rgba(0,0,0,.04)!important;border-radius:4px!important}div:has(>img[src=\"/images/mcp.svg\"])>img{display:none}div:has(>img[src=\"/images/mcp.svg\"])::before{content:\"\";width:1rem;height:1rem;background-color:currentColor;-webkit-mask:url(/images/mcp.svg) center/contain no-repeat;mask:url(/images/mcp.svg) center/contain no-repeat}#sidebar-group a,#sidebar-group button{padding:3px 8px!important;border-radius:4px!important}#sidebar-group li li a,#sidebar-group li li button{padding-left:20px!important}#sidebar-group li li li a,#sidebar-group li li li button{padding-left:32px!important}.sidebar-group-header{padding-left:8px!important}@media (min-width:768px){#sidebar-title,.sidebar-group-header h5{font-size:.7rem!important;text-transform:uppercase!important;letter-spacing:.07em!important;font-weight:600!important}.dark #sidebar-title,.dark .sidebar-group-header h5{color:rgba(255,255,255,.9)!important}html:not(.dark) #sidebar-title,html:not(.dark) .sidebar-group-header h5{color:rgba(0,0,0,.75)!important}}@media (max-width:767px){#sidebar-title,.sidebar-group-header h5{font-size:.9375rem!important;text-transform:none!important;letter-spacing:0!important;font-weight:700!important}.dark #sidebar-title,.dark .sidebar-group-header h5{color:rgba(255,255,255,.95)!important}html:not(.dark) #sidebar-title,html:not(.dark) .sidebar-group-header h5{color:rgba(0,0,0,.9)!important}}#navbar a[href=\"https://app.nango.dev\"],#navbar a[href=\"https://app.nango.dev/signup\"]{padding:7px 16px!important;font-size:.875rem!important;font-weight:500!important;border-radius:4px!important;line-height:1.25rem!important}#navbar a[href=\"https://app.nango.dev\"]{margin-right:-8px!important}#navbar a[href=\"https://app.nango.dev/signup\"]{margin-left:-8px!important;background-color:#29abe3!important;background-image:none!important;border:1px solid #29abe3!important;color:#fff!important}.dark #navbar a[href=\"https://app.nango.dev\"]{display:inline-flex!important;align-items:center!important;background-color:transparent!important;color:#fff!important;border:1px solid rgba(255,255,255,.25)!important;text-decoration:none!important}.dark #navbar a[href=\"https://app.nango.dev\"]:hover{background-color:rgba(255,255,255,.08)!important}#navbar a[href=\"https://app.nango.dev/signup\"] span.absolute,#navbar a[href=\"https://app.nango.dev/signup\"] span[class*=bg-primary],#navbar a[href=\"https://app.nango.dev/signup\"]>span:first-child{display:none!important}#navbar a[href=\"https://app.nango.dev/signup\"]:hover{background-color:#217ea6!important;border-color:#217ea6!important;color:#fff!important}#content-area div.rounded-2xl.pointer-events-auto[class*=bg-background-light],.chat-assistant-floating-input{display:none!important}.sticky:has(>#chat-assistant-sheet){z-index:40!important}"}],"page":{"pagePath":"reference/backend/http-api/environments/create-api-key","slug":"/reference/backend/http-api/environments/create-api-key","pageMetadata":{"title":"Create an environment API key","openapi":"POST /environments/{environmentUuid}/api-keys","description":"Create a new environment API key","href":"/reference/backend/http-api/environments/create-api-key"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a new environment API key\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Info}=_components;if(!Info)_missingMdxReference(`Info`,true);return _jsxs(_Fragment,{children:[_jsx(Info,{children:_jsxs(_components.p,{children:[`Requires an `,_jsx(_components.a,{href:`/reference/backend/http-api/api-keys#account-api-keys`,children:`Account API key`}),` with the `,_jsx(_components.code,{children:`account:environments:api_keys:create`}),` scope. Create one from `,_jsx(_components.a,{href:`https://app.nango.dev/api-keys`,children:`Account API keys`}),` in the dashboard.`]})}),`\n`,_jsxs(_components.p,{children:[`Creates an Environment API key with custom `,_jsx(_components.code,{children:`scopes`}),`. Not specifying any `,_jsx(_components.code,{children:`scopes`}),` defaults to full environment access.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`environmentUuid`}),` is the UUID returned when the environment was `,_jsx(_components.a,{href:`/reference/backend/http-api/environments/create`,children:`created`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create an environment API key","openapi":"POST /environments/{environmentUuid}/api-keys","description":"Create a new environment API key","href":"/reference/backend/http-api/environments/create-api-key"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Info,ResponseExample}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Info)_missingMdxReference(`Info`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);return _jsxs(_Fragment,{children:[_jsx(Info,{children:_jsxs(_components.p,{children:[`Requires an `,_jsx(_components.a,{href:`/reference/backend/http-api/api-keys#account-api-keys`,children:`Account API key`}),` with the `,_jsx(_components.code,{children:`account:environments:api_keys:create`}),` scope. Create one from `,_jsx(_components.a,{href:`https://app.nango.dev/api-keys`,children:`Account API keys`}),` in the dashboard.`]})}),`\n`,_jsxs(_components.p,{children:[`Creates an Environment API key with custom `,_jsx(_components.code,{children:`scopes`}),`. Not specifying any `,_jsx(_components.code,{children:`scopes`}),` defaults to full environment access.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`environmentUuid`}),` is the UUID returned when the environment was `,_jsx(_components.a,{href:`/reference/backend/http-api/environments/create`,children:`created`}),`.`]}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:`Example Response`,numberOfLines:`10`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`10`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`456`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"uuid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"123e4567-e89b-12d3-a456-426614174001\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"display_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"provisioned-ci\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"scopes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"environment:*\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"secret\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"\u003cYOUR-ENVIRONMENT-API-KEY>\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"created_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-18T12:00:00.000Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create an environment API key","openapi":"POST /environments/{environmentUuid}/api-keys","description":"Create a new environment API key","href":"/reference/backend/http-api/environments/create-api-key"}}}},"mdxExtracts":{"tableOfContents":[],"codeExamples":{"response":{"type":"ResponseExample","children":[{"filename":"Example Response","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"10\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">456\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"uuid\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"123e4567-e89b-12d3-a456-426614174001\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"display_name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"provisioned-ci\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"scopes\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"environment:*\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"secret\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"\u0026#x3C;YOUR-ENVIRONMENT-API-KEY>\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"created_at\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2026-08-18T12:00:00.000Z\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}}},"jsLinks":["/docs/_mintlify/custom/nango/66b2950062f9d11d/custom.js"],"openApiReferenceData":{"operation":{"summary":"Create an environment API key","description":"Create a new environment API key","parameters":["3043d61f-5cca-49a1-8b16-f35193031ccd"],"requestBody":"e257f9eb-c15a-43c0-9d9e-427c9266fa06","responses":{"200":"a7a3a8c7-8387-4690-a185-6dd5b09209a6","400":"57e99ee6-f1d1-40bd-a788-242ec77eb4c1","401":"e42b2d2c-bbf1-4648-ae36-2b804bff70d5","403":"7f7195a4-8a57-467e-a1e2-6cd6e17aa668","404":"235942fc-3d0c-42c1-b49b-c5f3c339f5a9","409":"8cd01784-6bd2-46f5-b0de-dba0910ac7d8","500":"6a001169-aca7-4c2f-a962-43dee8dbf1cb"},"method":"post","type":"path","servers":["8786d4d5-0d04-4e4b-9eca-73f6245eabd8","d820e55d-b18d-4aaf-b9f0-05894096816b"],"security":["a2055fa9-3ec6-4f7d-ab87-f01002812059"],"path":"/environments/{environmentUuid}/api-keys","baseUrlOptions":["https://api.nango.dev","http://localhost:3003"],"title":"Create an environment API key","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExamples":[{"dropdown":false,"language":"json","code":{"type":"pre","key":null,"ref":null,"props":{"className":"shiki shiki-themes github-light-default dark-plus","style":{"backgroundColor":"#ffffff","--shiki-dark-bg":"#0B0C0E","color":"#1f2328","--shiki-dark":"#D4D4D4"},"language":"json","children":{"type":"code","key":null,"ref":null,"props":{"language":"json","numberOfLines":"10","children":[{"type":"span","key":"0","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":"{"}}}},"\n",{"type":"span","key":"2","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"data\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": {"}}]}},"\n",{"type":"span","key":"4","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"id\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#B5CEA8"},"children":"456"}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"6","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"uuid\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"123e4567-e89b-12d3-a456-426614174001\""}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"8","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"display_name\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"provisioned-ci\""}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"10","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"scopes\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": ["}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"environment:*\""}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":"],"}}]}},"\n",{"type":"span","key":"12","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"secret\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"\u003cYOUR-ENVIRONMENT-API-KEY>\""}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":","}}]}},"\n",{"type":"span","key":"14","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#116329","--shiki-dark":"#9CDCFE"},"children":" \"created_at\""}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":": "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":"\"2026-08-18T12:00:00.000Z\""}}]}},"\n",{"type":"span","key":"16","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":" }"}}}},"\n",{"type":"span","key":"18","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#1F2328","--shiki-dark":"#D4D4D4"},"children":"}"}}}},"\n"]}}}},"filename":"Example Response"}],"responseExampleType":"mdx"},"dependencies":{"parameters":{"3043d61f-5cca-49a1-8b16-f35193031ccd":{"name":"environmentUuid","in":"path","required":true,"description":"Environment UUID that will own the key.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Environment UUID that will own the key.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"123e4567-e89b-12d3-a456-426614174000"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["display_name"],"properties":{"display_name":{"type":"string","description":"Display name for the key. Must be unique within the environment.","minLength":1,"maxLength":255,"example":"provisioned-ci","isRequired":true,"uniqueKey":"display_name","typeLabel":"string"},"scopes":{"type":"array","minItems":1,"items":{"type":"string","uniqueKey":"scopes.items.[INDEX]","typeLabel":"string"},"description":"Environment scopes to grant the key, such as `environment:deploy` or `environment:*`. Defaults to `environment:*` (full access).","example":["environment:deploy"],"uniqueKey":"scopes","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"display_name":"provisioned-ci","scopes":["environment:deploy"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a7a3a8c7-8387-4690-a185-6dd5b09209a6":{"description":"Successfully created an Environment API key","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["id","uuid","display_name","scopes","secret","created_at"],"properties":{"id":{"type":"integer","description":"Numeric key ID.","example":456,"isRequired":true,"uniqueKey":"data.id","typeLabel":"integer"},"uuid":{"type":"string","format":"uuid","description":"API key UUID. Use this to delete the key later.","example":"123e4567-e89b-12d3-a456-426614174001","isRequired":true,"uniqueKey":"data.uuid","typeLabel":"string\u003cuuid>"},"display_name":{"type":"string","example":"provisioned-ci","isRequired":true,"uniqueKey":"data.display_name","typeLabel":"string"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"data.scopes.items.[INDEX]","typeLabel":"string"},"description":"Scopes granted to the key. `environment:*` when no scopes were specified.","example":["environment:deploy"],"isRequired":true,"uniqueKey":"data.scopes","typeLabel":"string[]"},"secret":{"type":"string","description":"The API key secret. Store it now; it is not returned again.","isRequired":true,"uniqueKey":"data.secret","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":456,"uuid":"123e4567-e89b-12d3-a456-426614174001","display_name":"provisioned-ci","scopes":["environment:deploy"],"secret":"\u003cstring>","created_at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"57e99ee6-f1d1-40bd-a788-242ec77eb4c1":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"error":{"type":"object","additionalProperties":false,"required":["code"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","errors":[{}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"e42b2d2c-bbf1-4648-ae36-2b804bff70d5":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"error":{"type":"object","additionalProperties":false,"required":["code"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","errors":[{}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"7f7195a4-8a57-467e-a1e2-6cd6e17aa668":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"error":{"type":"object","additionalProperties":false,"required":["code"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","errors":[{}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"235942fc-3d0c-42c1-b49b-c5f3c339f5a9":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"error":{"type":"object","additionalProperties":false,"required":["code"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","errors":[{}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"8cd01784-6bd2-46f5-b0de-dba0910ac7d8":{"description":"A key with this display name already exists in the environment.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"error":{"type":"object","additionalProperties":false,"required":["code"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","errors":[{}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"6a001169-aca7-4c2f-a962-43dee8dbf1cb":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"error":{"type":"object","additionalProperties":false,"required":["code"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","errors":[{}]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a2055fa9-3ec6-4f7d-ab87-f01002812059":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An Environment API key from your Nango environment, or an Account API key for account-level endpoints.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"8786d4d5-0d04-4e4b-9eca-73f6245eabd8":{"url":"https://api.nango.dev","description":"Production server"},"d820e55d-b18d-4aaf-b9f0-05894096816b":{"url":"http://localhost:3003","description":"Local server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An Environment API key from your Nango environment, or an Account API key for account-level endpoints.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An Environment API key from your Nango environment, or an Account API key for account-level endpoints.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"spec.yaml"},"subdomain":"nango","siteName":"Nango Docs","title":"Create an environment API key - Nango Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-19T20:17:20.061Z","originalFileLocation":"reference/backend/http-api/environments/create-api-key.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a new environment API key\">\u003cmeta data-mint-head name=\"application-name\" content=\"Nango Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/nango/H6v9PP50zUaxkdQK/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/nango/H6v9PP50zUaxkdQK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/nango/H6v9PP50zUaxkdQK/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/nango/H6v9PP50zUaxkdQK/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/nango/H6v9PP50zUaxkdQK/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/nango/H6v9PP50zUaxkdQK/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/nango/H6v9PP50zUaxkdQK/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/nango/H6v9PP50zUaxkdQK/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/nango/H6v9PP50zUaxkdQK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create an environment API key - Nango Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new environment API key\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nango Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://nango.dev/docs/reference/backend/http-api/environments/create-api-key\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nango.mintlify.app/_mintlify/api/og/v2?division=Environments\u0026amp;title=Create+an+environment+API+key\u0026amp;description=Create+a+new+environment+API+key\u0026amp;theme=79d4473b17677a097a22660e\u0026amp;signature=6aebf44b1598f2f1462ba9ee6af85847e7a031b10f294e1ac4f53c6df975470b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create an environment API key - Nango Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new environment API key\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nango.mintlify.app/_mintlify/api/og/v2?division=Environments\u0026amp;title=Create+an+environment+API+key\u0026amp;description=Create+a+new+environment+API+key\u0026amp;theme=79d4473b17677a097a22660e\u0026amp;signature=6aebf44b1598f2f1462ba9ee6af85847e7a031b10f294e1ac4f53c6df975470b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/nango/H6v9PP50zUaxkdQK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nango Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#29abe2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://nango.dev/docs/reference/backend/http-api/environments/create-api-key\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/reference/backend/http-api/environments/create-api-key.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://nango.dev/#organization\",\"name\":\"Nango Docs\",\"url\":\"https://nango.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nango/h2zzveDlAs05T6zr/images/Nango-Light-Mode.svg?fit=max\u0026auto=format\u0026n=h2zzveDlAs05T6zr\u0026q=85\u0026s=0c2845b2219705011e11ef4985aa9d91\"}},{\"@type\":\"WebSite\",\"@id\":\"https://nango.dev/docs#website\",\"name\":\"Nango Docs\",\"url\":\"https://nango.dev/docs\",\"publisher\":{\"@id\":\"https://nango.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://nango.dev/docs/reference/backend/http-api/environments/create-api-key#webpage\",\"url\":\"https://nango.dev/docs/reference/backend/http-api/environments/create-api-key\",\"name\":\"Create an environment API key\",\"description\":\"Create a new environment API key\",\"dateModified\":\"2026-10-19T20:17:20.061Z\",\"isPartOf\":{\"@id\":\"https://nango.dev/docs#website\"},\"breadcrumb\":{\"@id\":\"https://nango.dev/docs/reference/backend/http-api/environments/create-api-key#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://nango.dev/docs/reference/backend/http-api/environments/create-api-key#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://nango.dev/docs/reference/frontend/frontend-sdk\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Backend\",\"item\":\"https://nango.dev/docs/reference/backend/http-api/api-keys\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"HTTP API\",\"item\":\"https://nango.dev/docs/reference/backend/http-api/api-keys\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Environments\",\"item\":\"https://nango.dev/docs/reference/backend/http-api/environments/list\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Create an environment API key\",\"item\":\"https://nango.dev/docs/reference/backend/http-api/environments/create-api-key\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://nango.dev/docs/reference/backend/http-api/environments/create-api-key#apireference\",\"headline\":\"Create an environment API key\",\"name\":\"Create an environment API key\",\"description\":\"Create a new environment API key\",\"url\":\"https://nango.dev/docs/reference/backend/http-api/environments/create-api-key\",\"mainEntityOfPage\":{\"@id\":\"https://nango.dev/docs/reference/backend/http-api/environments/create-api-key#webpage\"},\"dateModified\":\"2026-10-19T20:17:20.061Z\",\"publisher\":{\"@id\":\"https://nango.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://nango.dev/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nango Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Nango Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","groups":[{"group":"Getting started","pages":[{"title":"Introduction","sidebarTitle":"Introduction","href":"/getting-started/intro-to-nango"},{"title":"Quickstart","sidebarTitle":"🚀 Quickstart","href":"/getting-started/quickstart"},{"title":"Coding agent setup","sidebarTitle":"✨ Coding agent setup","href":"/getting-started/coding-agent-setup"},{"group":"Use cases","expanded":false,"pages":[{"title":"Tool calling for AI agents","sidebarTitle":"Tool calling for AI agents","href":"/getting-started/use-cases/tool-calling"},{"title":"Sync external API data","sidebarTitle":"Sync external API data","href":"/getting-started/use-cases/syncs"},{"title":"Run external API operations","sidebarTitle":"Run external API operations","href":"/getting-started/use-cases/actions"},{"title":"Process external webhooks","sidebarTitle":"Process external webhooks","href":"/getting-started/use-cases/webhooks-from-external-apis"},{"title":"Build a unified API","sidebarTitle":"Build a unified API","href":"/getting-started/use-cases/unified-apis"},{"title":"Customize per customer","sidebarTitle":"Customize per customer","href":"/getting-started/use-cases/customer-configuration"},{"title":"React to connection lifecycle events","sidebarTitle":"Connection lifecycle events","href":"/getting-started/use-cases/implement-event-handler"},{"title":"Sample app","sidebarTitle":"Sample app","href":"/getting-started/use-cases/sample-app"}]}]},{"group":"Guides","pages":[{"group":"Auth","expanded":false,"pages":[{"title":"Auth guide","sidebarTitle":"Auth guide","href":"/guides/auth/auth-guide"},{"title":"Share a connect link","sidebarTitle":"Share a connect link","href":"/guides/auth/share-connect-link"},{"title":"Connection tags, configuration, and metadata","sidebarTitle":"Tags, configuration \u0026 metadata","href":"/guides/auth/connection-tags-configuration-metadata"},{"title":"Customize Connect UI","sidebarTitle":"Customize Connect UI","href":"/guides/auth/customize-connect-ui"},{"title":"Token refreshing \u0026 validity","sidebarTitle":"Token refreshing \u0026 validity","href":"/guides/auth/token-refreshing"},{"title":"MCP Auth","sidebarTitle":"MCP Auth","href":"/guides/auth/mcp-auth"}]},{"title":"Agent sessions","sidebarTitle":"Agent sessions","href":"/guides/agent-sessions"},{"group":"Functions","expanded":false,"pages":[{"title":"Functions guide","sidebarTitle":"Functions guide","href":"/guides/functions/functions-guide"},{"group":"Sync functions","pages":[{"title":"Sync function guide","sidebarTitle":"Sync function guide","href":"/guides/functions/syncs/sync-functions"},{"title":"Sync efficiency","sidebarTitle":"Sync efficiency","href":"/guides/functions/syncs/sync-efficiency"},{"title":"Checkpoints","sidebarTitle":"Checkpoints","href":"/guides/functions/syncs/checkpoints"},{"title":"Records cache","sidebarTitle":"Records cache","href":"/guides/functions/syncs/records-cache"},{"title":"Deletion detection","sidebarTitle":"Deletion detection","href":"/guides/functions/syncs/deletion-detection"},{"title":"Real-time syncs with webhooks","sidebarTitle":"Real-time syncs","href":"/guides/functions/syncs/realtime-syncs"},{"title":"Sync partitioning","sidebarTitle":"Sync partitioning","href":"/guides/functions/syncs/sync-partitioning"}]},{"title":"Action functions","sidebarTitle":"Action functions","href":"/guides/functions/action-functions"},{"title":"Webhook functions","sidebarTitle":"Webhook functions","href":"/guides/functions/webhook-functions"},{"title":"Event functions","sidebarTitle":"Event functions","href":"/guides/functions/event-functions"},{"title":"Storage","sidebarTitle":"Storage","href":"/guides/functions/storage"},{"title":"Function logging","sidebarTitle":"Logging","href":"/guides/functions/logging"},{"title":"Rate limits","sidebarTitle":"Rate limits","href":"/guides/functions/rate-limits"},{"title":"Data validation","sidebarTitle":"Data validation","href":"/guides/functions/data-validation"},{"title":"Testing integrations","sidebarTitle":"Testing","href":"/guides/functions/testing"},{"title":"CI/CD for Nango Functions","sidebarTitle":"CI/CD","href":"/guides/functions/ci-cd"},{"title":"Unified APIs with functions","sidebarTitle":"Unified APIs","href":"/guides/functions/unified-apis"}]},{"group":"Platform","expanded":false,"pages":[{"title":"Observability","sidebarTitle":"Observability","href":"/guides/platform/observability"},{"title":"Environments","sidebarTitle":"Environments","href":"/guides/platform/environments"},{"title":"Limits","sidebarTitle":"Limits","href":"/guides/platform/limits"},{"title":"Security","sidebarTitle":"Security","href":"/guides/platform/security"},{"title":"Audit trail","sidebarTitle":"Audit trail","href":"/guides/platform/audit-trail"},{"title":"Proxy requests","sidebarTitle":"Proxy requests","href":"/guides/platform/proxy-requests"},{"title":"Receive webhooks from Nango","sidebarTitle":"Webhooks from Nango","href":"/guides/platform/webhooks-from-nango"},{"title":"External webhook forwarding","sidebarTitle":"External webhook forwarding","href":"/guides/platform/webhook-forwarding"},{"title":"Common issues","sidebarTitle":"Common issues","href":"/guides/platform/common-issues"},{"group":"Self-Hosting","pages":[{"title":"Self-host Nango","sidebarTitle":"Overview","href":"/guides/platform/self-hosting/self-hosting"},{"title":"BYOC","sidebarTitle":"BYOC","href":"/guides/platform/self-hosting/byoc"},{"title":"Self-Managed","sidebarTitle":"Self-Managed","href":"/guides/platform/self-hosting/self-managed"}]},{"group":"Migrations","pages":[{"title":"Migrate to checkpoints","sidebarTitle":"Migrate to checkpoints","href":"/guides/platform/migrations/migrate-to-checkpoints"},{"title":"Migrate from end user","sidebarTitle":"Migrate from end user","href":"/guides/platform/migrations/migrate-from-end-user"},{"title":"Migrate from public key","sidebarTitle":"Migrate from public key","href":"/guides/platform/migrations/migrate-from-public-key"},{"title":"Migrate from Connection MCP to agent sessions","sidebarTitle":"Migrate from Connection MCP","href":"/guides/platform/migrations/migrate-from-connection-mcp"},{"title":"Migrating to Zero YAML","sidebarTitle":"Migrating to Zero YAML","href":"/guides/platform/migrations/migrate-to-zero-yaml"}]},{"title":"Contributing to Nango","sidebarTitle":"Contributing","href":"/contributing"}]}]},{"group":"Reference","pages":[{"group":"Frontend","pages":[{"title":"Frontend SDK","sidebarTitle":"Frontend SDK","icon":"js","href":"/reference/frontend/frontend-sdk"}]},{"group":"Backend","pages":[{"group":"HTTP API","icon":"cloud","pages":[{"title":"API keys","sidebarTitle":"API keys","href":"/reference/backend/http-api/api-keys"},{"title":"Authentication","href":"/reference/backend/http-api/authentication"},{"title":"Rate limits","href":"/reference/backend/http-api/rate-limits"},{"group":"Environments","pages":[{"title":"List environments","openapi":"GET /environments","href":"/reference/backend/http-api/environments/list"},{"title":"Get an environment","openapi":"GET /environments/{environmentUuid}","href":"/reference/backend/http-api/environments/get"},{"title":"Create an environment","openapi":"POST /environments","href":"/reference/backend/http-api/environments/create"},{"title":"Delete an environment","openapi":"DELETE /environments/{environmentUuid}","href":"/reference/backend/http-api/environments/delete"},{"title":"List environment API keys","openapi":"GET /environments/{environmentUuid}/api-keys","href":"/reference/backend/http-api/environments/list-api-keys"},{"title":"Get an environment API key","openapi":"GET /environments/{environmentUuid}/api-keys/{keyUuid}","description":"Retrieve an Environment API key, including its secret.","href":"/reference/backend/http-api/environments/get-api-key"},{"title":"Create an environment API key","openapi":"POST /environments/{environmentUuid}/api-keys","href":"/reference/backend/http-api/environments/create-api-key"},{"title":"Update an environment API key","openapi":"PATCH /environments/{environmentUuid}/api-keys/{keyUuid}","description":"Change the display name and/or scopes of an Environment API key. Requires an Account API key with the `account:environments:api_keys:update` scope.","href":"/reference/backend/http-api/environments/update-api-key"},{"title":"Delete an environment API key","openapi":"DELETE /environments/{environmentUuid}/api-keys/{keyUuid}","href":"/reference/backend/http-api/environments/delete-api-key"},{"title":"Rotate the webhook signing key","openapi":"POST /environment/webhook-signing-key/rotate","href":"/reference/backend/http-api/environments/rotate-webhook-signing-key"}]},{"group":"Integrations","pages":[{"title":"List all integrations","openapi":"GET /integrations","href":"/reference/backend/http-api/integration/list"},{"title":"Get an integration","openapi":"GET /integrations/{uniqueKey}","href":"/reference/backend/http-api/integration/get"},{"title":"Create an integration","openapi":"POST /integrations","href":"/reference/backend/http-api/integration/create"},{"title":"Update an integration","openapi":"PATCH /integrations/{uniqueKey}","href":"/reference/backend/http-api/integration/update"},{"title":"Delete an integration","openapi":"DELETE /integrations/{uniqueKey}","href":"/reference/backend/http-api/integration/delete"}]},{"group":"Connect","pages":[{"title":"Create a connect session","openapi":"POST /connect/sessions","href":"/reference/backend/http-api/connect/sessions/create"},{"title":"Create a reconnect session","openapi":"POST /connect/sessions/reconnect","href":"/reference/backend/http-api/connect/sessions/reconnect"},{"title":"Get a connect session","openapi":"GET /connect/session","href":"/reference/backend/http-api/connect/session/get"},{"title":"Delete a connect session","openapi":"DELETE /connect/session","href":"/reference/backend/http-api/connect/session/delete"}]},{"group":"Connections","pages":[{"title":"Import a connection","openapi":"POST /connections","href":"/reference/backend/http-api/connections/post"},{"title":"List connections","openapi":"GET /connections","href":"/reference/backend/http-api/connections/list"},{"title":"Get connection \u0026 credentials","openapi":"GET /connections/{connectionId}","href":"/reference/backend/http-api/connections/get"},{"title":"Patch a connection","openapi":"PATCH /connections/{connectionId}","href":"/reference/backend/http-api/connections/patch"},{"title":"Set connection metadata","openapi":"POST /connections/metadata","href":"/reference/backend/http-api/connections/set-metadata"},{"title":"Edit connection metadata","openapi":"PATCH /connections/metadata","href":"/reference/backend/http-api/connections/update-metadata"},{"title":"Delete a connection","openapi":"DELETE /connections/{connectionId}","href":"/reference/backend/http-api/connections/delete"}]},{"group":"Functions","pages":[{"title":"List functions","openapi":"GET /integrations/{uniqueKey}/functions","href":"/reference/backend/http-api/functions/list"},{"title":"Get a function","openapi":"GET /integrations/{uniqueKey}/functions/{name}","href":"/reference/backend/http-api/functions/get"},{"title":"Get a function's source code","openapi":"GET /integrations/{uniqueKey}/functions/{name}/code","href":"/reference/backend/http-api/functions/code"},{"title":"Delete a function","openapi":"DELETE /integrations/{uniqueKey}/functions/{name}","href":"/reference/backend/http-api/functions/delete"},{"title":"Compile a function","openapi":"POST /functions/compile","href":"/reference/backend/http-api/functions/compile"},{"title":"Dry run a function","openapi":"POST /functions/dryruns","href":"/reference/backend/http-api/functions/dryruns-create"},{"title":"Get dry run results","openapi":"GET /functions/dryruns/{id}","href":"/reference/backend/http-api/functions/dryruns-get"},{"title":"Create a function deployment","openapi":"POST /functions/deployments","href":"/reference/backend/http-api/functions/deployments-create"},{"title":"Get a function deployment","openapi":"GET /functions/deployments/{id}","href":"/reference/backend/http-api/functions/deployments-get"},{"title":"Get integration functions config","openapi":"GET /scripts/config","href":"/reference/backend/http-api/scripts/config"}]},{"group":"Syncs","pages":[{"title":"Get records","sidebarTitle":"Get records","openapi":"GET /records","href":"/reference/backend/http-api/sync/records-list"},{"title":"Prune records","sidebarTitle":"Prune records","openapi":"PATCH /records/prune","href":"/reference/backend/http-api/sync/prune-records"},{"title":"Trigger sync(s)","openapi":"POST /sync/trigger","href":"/reference/backend/http-api/sync/trigger"},{"title":"Start sync(s)","openapi":"POST /sync/start","href":"/reference/backend/http-api/sync/start"},{"title":"Pause sync(s)","openapi":"POST /sync/pause","href":"/reference/backend/http-api/sync/pause"},{"title":"Sync status","openapi":"GET /sync/status","href":"/reference/backend/http-api/sync/status"},{"title":"Override sync connection frequency","openapi":"PUT /sync/update-connection-frequency","href":"/reference/backend/http-api/sync/update-connection-frequency"},{"title":"Get environment variables","openapi":"GET /environment-variables","href":"/reference/backend/http-api/sync/environment-variables"},{"title":"Create sync variant","sidebarTitle":"Create variant","openapi":"POST /sync/{name}/variant/{variant}","href":"/reference/backend/http-api/sync/create-variant"},{"title":"Delete sync variant","sidebarTitle":"Delete variant","openapi":"DELETE /sync/{name}/variant/{variant}","href":"/reference/backend/http-api/sync/delete-variant"}]},{"group":"Actions","pages":[{"title":"Trigger an action","openapi":"POST /action/trigger","href":"/reference/backend/http-api/action/trigger"}]},{"group":"Proxy","pages":[{"title":"Proxy - GET requests","sidebarTitle":"Proxy - GET requests","openapi":"GET /proxy/{anyPath}","href":"/reference/backend/http-api/proxy/get"},{"title":"Proxy - POST requests","sidebarTitle":"Proxy - POST requests","openapi":"POST /proxy/{anyPath}","href":"/reference/backend/http-api/proxy/post"},{"title":"Proxy - PUT requests","sidebarTitle":"Proxy - PUT requests","openapi":"PUT /proxy/{anyPath}","href":"/reference/backend/http-api/proxy/put"},{"title":"Proxy - PATCH requests","sidebarTitle":"Proxy - PATCH requests","openapi":"PATCH /proxy/{anyPath}","href":"/reference/backend/http-api/proxy/patch"},{"title":"Proxy - DELETE requests","sidebarTitle":"Proxy - DELETE requests","openapi":"DELETE /proxy/{anyPath}","href":"/reference/backend/http-api/proxy/delete"}]},{"group":"Providers","pages":[{"title":"List all providers","openapi":"GET /providers","href":"/reference/backend/http-api/providers/list"},{"title":"Get a provider","openapi":"GET /providers/{provider}","href":"/reference/backend/http-api/providers/get"},{"title":"List provider templates","openapi":"GET /providers/{provider}/templates","href":"/reference/backend/http-api/providers/templates"}]}]},{"group":"Backend SDK","icon":"cubes","pages":[{"title":"Node","sidebarTitle":"Node","icon":"node","href":"/reference/backend/backend-sdk/node"},{"title":"Python","sidebarTitle":"Python","icon":"python","href":"/reference/backend/backend-sdk/python"},{"title":"Java","sidebarTitle":"Java","icon":"java","href":"/reference/backend/backend-sdk/java"},{"title":"Ruby","sidebarTitle":"Ruby","icon":"gem","href":"/reference/backend/backend-sdk/ruby"},{"title":"Go","sidebarTitle":"Go","icon":"golang","href":"/reference/backend/backend-sdk/go"},{"title":"Rust","sidebarTitle":"Rust","icon":"rust","href":"/reference/backend/backend-sdk/rust"},{"title":"PHP","sidebarTitle":"PHP","icon":"php","href":"/reference/backend/backend-sdk/php"}]},{"title":"Management MCP","sidebarTitle":"Management MCP","icon":"https://mintlify.s3.us-west-1.amazonaws.com/nango/images/mcp.svg","href":"/reference/backend/management-mcp"}]},{"group":"Functions","pages":[{"title":"Functions CLI","sidebarTitle":"Functions CLI","icon":"terminal","href":"/reference/functions/functions-cli"},{"title":"Functions SDK","sidebarTitle":"Functions SDK","icon":"code","href":"/reference/functions/functions-sdk"}]}]}]},{"tab":"APIs \u0026 Integrations","icon":"plug","pages":[{"title":"APIs \u0026 Integrations","href":"/integrations/overview"}]},{"tab":"Changelog","icon":"bolt","pages":[{"title":"Changelog","href":"/updates/changelog"}]},{"tab":"Support","icon":"slack","href":"https://nango.dev/slack"}]},"title":"Create an environment API key - Nango Docs","buildId":"dpl_EARnBX9sYeZdmtDtdMETnj8cZgAL","deploymentId":"dpl_EARnBX9sYeZdmtDtdMETnj8cZgAL","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Dwo5Zw1g.js","utils-C7ri5h_X.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-NXX1NHuC.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BFzrXK_e.js","snippetPresets-DLhzf4mt.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BlCO4kMh.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B9z96fnb.js","shallow-AopVKJh8.js","getApiPlaygroundDisplay-bXnLOTlk.js","CodeSnippet-DmJ3qzrb.js","CodeSnippets-hcFGtmzn.js","Page-ChlUUCY4.js","getPastedJson-ps4MHraj.js","icon-L__7y7ys.js","MethodPill-CLOMdS5n.js","DuplicateIcon-m7x5FI4L.js","createIcon-BiD_Arde.js","DynamicMarkdown-a43r1ghB.js","SectionHeading-4c_bODjK.js","axios-vUo_bRtp.js","Markdown-DWTe9S87.js","clsx-Dhq8D58W.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CVox-mr5.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-yCZrC9EP.js"]}