{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ngrok documentation","colors":{"primary":"#273FC3","light":"#699AFC","dark":"#699AFC"},"logo":{"light":"https://mintcdn.com/ngrok/uPrboN8usISU3fq0/logo/light.svg?fit=max\u0026auto=format\u0026n=uPrboN8usISU3fq0\u0026q=85\u0026s=6a4a2c8995f8731e1bac3f795a68130d","dark":"https://mintcdn.com/ngrok/uPrboN8usISU3fq0/logo/dark.svg?fit=max\u0026auto=format\u0026n=uPrboN8usISU3fq0\u0026q=85\u0026s=e363c8b6e09a92e726a981e0156ba233","href":"https://ngrok.com/docs"},"favicon":"https://mintcdn.com/ngrok/BQQt-CHCs_8OwVmS/favicon.ico?fit=max\u0026auto=format\u0026n=BQQt-CHCs_8OwVmS\u0026q=85\u0026s=294907ab135b589ed607e4888e1a10a4","background":{"color":{"dark":"#121212"}},"navbar":{"links":[{"href":"https://ngrok.com/","label":"Homepage"},{"href":"https://dashboard.ngrok.com/","label":"Dashboard"}],"primary":{"type":"button","label":"Sign up","href":"https://dashboard.ngrok.com/signup"}},"footer":{"socials":{"x":"https://x.com/ngrokhq","github":"https://github.com/ngrok","linkedin":"https://linkedin.com/company/ngrok","youtube":"https://www.youtube.com/@ngrokHQ"},"links":[{"header":"Product","items":[{"label":"Gateway","href":"https://ngrok.com/docs/gateway/overview"},{"label":"AI Gateway","href":"https://ngrok.ai"},{"label":"Traffic Policy","href":"https://ngrok.com/docs/traffic-policy"},{"label":"Secure Tunnels","href":"https://ngrok.com/docs/agent/overview"},{"label":"Traffic Observability","href":"https://ngrok.com/docs/obs"},{"label":"Kubernetes Operator","href":"https://ngrok.com/docs/k8s"}]},{"header":"Problems we solve","items":[{"label":"API gateway","href":"https://ngrok.com/docs/guides/api-gateway/get-started"},{"label":"AI gateway","href":"https://ngrok.ai/"},{"label":"Webhook gateway","href":"https://ngrok.com/docs/gateway/examples/webhook-gateway"},{"label":"Ephemeral workloads","href":"https://ngrok.com/docs/gateway/examples/ephemeral-workloads"},{"label":"Customer connectivity","href":"https://ngrok.com/use-cases/saas-customer-connectivity"},{"label":"Device gateway","href":"https://ngrok.com/docs/guides/device-gateway/overview"},{"label":"Remote access","href":"https://ngrok.com/docs/guides/ssh-rdp"},{"label":"Share localhost","href":"https://ngrok.com/use-cases/share-localhost"},{"label":"Connect MCPs to AI providers","href":"https://ngrok.com/docs/gateway/api-gateway/mcp-gateway"},{"label":"Test webhooks","href":"https://ngrok.com/docs/share-localhost/webhooks"},{"label":"Access remote K8s clusters","href":"https://ngrok.com/docs/k8s/guides/local-projection"},{"label":"Minecraft","href":"https://ngrok.com/docs/gateway/examples/minecraft"}]},{"header":"Resources","items":[{"label":"Docs","href":"https://ngrok.com/docs/start"},{"label":"Guides","href":"https://ngrok.com/docs/guides"},{"label":"Pricing","href":"https://ngrok.com/pricing"},{"label":"Download","href":"https://ngrok.com/download"},{"label":"Security","href":"https://ngrok.com/security"},{"label":"Trust","href":"https://trust.ngrok.com/"},{"label":"Case studies","href":"https://ngrok.com/customers"},{"label":"Integrations","href":"https://ngrok.com/docs/integrations"},{"label":"Support","href":"https://ngrok.com/support"},{"label":"Abuse","href":"https://ngrok.com/abuse"},{"label":"Status","href":"https://status.ngrok.com/"}]},{"header":"Company","items":[{"label":"About","href":"https://ngrok.com/about"},{"label":"Contact","href":"https://ngrok.com/contact"},{"label":"Blog","href":"https://ngrok.com/blog"},{"label":"Newsletter","href":"https://ngrok.com/newsletter"},{"label":"Press","href":"https://ngrok.com/press"},{"label":"Brand","href":"https://ngrok.com/brand"},{"label":"Careers","href":"https://ngrok.com/careers"}]}]},"seo":{"metatags":{"canonical":"https://ngrok.com/docs"},"indexing":"navigable"},"fonts":{"heading":{"family":"Roobert","weight":600,"source":"https://assets.ngrok.com/fonts/roobert/roobert-proportional-vf.woff2","format":"woff2"},"body":{"family":"Roobert","weight":400,"source":"https://assets.ngrok.com/fonts/roobert/roobert-proportional-vf.woff2","format":"woff2"}},"integrations":{"posthog":{"apiKey":"phc_mUGMN4JlTzthGcz0XNK0z6NKUqdeQMn7rPRAM3mifjQ","apiHost":"https://e.ngrok.com"}},"contextual":{"options":["copy","view","mcp","add-mcp","claude","cursor","vscode","assistant","chatgpt","perplexity","grok","aistudio","devin","windsurf","devin-mcp","download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ngrok","hasAudioNarration":false,"actualSubdomain":"ngrok","customDomains":["ngrok.com"],"gitSource":{"type":"github","owner":"ngrok","repo":"ngrok-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfeafc5ae0aaf790e63ac1","collectionId":"5c07b188-e653-4afb-bdfd-58cf51c391e8","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfeafc5ae0aaf790e63ac1"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6adfeafc5ae0aaf790e63ac1","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Reference","count":266},{"language":"default","tag":"Gateway","count":242},{"language":"default","tag":"Platform API","count":239},{"language":"default","tag":"Integrations","count":150},{"language":"default","tag":"AI Gateway","count":119},{"language":"default","tag":"Connectivity","count":91},{"language":"default","tag":"Webhooks","count":65},{"language":"default","tag":"Kubernetes Operators","count":58},{"language":"default","tag":"Traffic Policy","count":58},{"language":"default","tag":"Examples","count":46}],"searchSettings":{"isFiltersEnabled":false}},"assistantConfig":{"enableAskAiButton":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@ngrok.com","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":false,"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"img{max-width:100%;height:auto}.tooltip{font-weight:700;text-decoration:none!important;position:relative}.tooltip::after{content:\"\";position:absolute;bottom:0;left:0;width:100%;height:1px;border-bottom:1px dotted rgba(0,0,0,.8)}.light .tooltip,:root .tooltip,[data-theme=light] .tooltip{color:rgba(0,0,0,.8)}.light .tooltip::after,:root .tooltip::after,[data-theme=light] .tooltip::after{border-bottom-color:rgba(0,0,0,.8)}.dark .tooltip,[data-theme=dark] .tooltip{color:rgba(255,255,255,.8)}.dark .tooltip::after,[data-theme=dark] .tooltip::after{border-bottom-color:rgba(255,255,255,.8)}@media (prefers-color-scheme:light){.tooltip{color:rgba(0,0,0,.8)}.tooltip::after{border-bottom-color:rgba(0,0,0,.8)}}@media (prefers-color-scheme:dark){.tooltip{color:rgba(255,255,255,.8)}.tooltip::after{border-bottom-color:rgba(255,255,255,.8)}}:root td .tooltip{font-weight:inherit;color:inherit}td button[data-state]{text-align:start}td button[data-state] code{white-space:nowrap;word-break:normal;overflow-wrap:normal}td:first-child:has(>button[data-state] code){width:100%}table:has(td:first-child>button[data-state] code) td,table:has(td:first-child>button[data-state] code) th{min-width:0;white-space:nowrap}td .icon{mask-size:contain;-webkit-mask-size:contain}td .tooltip:has(>.icon){text-decoration:none}td .tooltip:has(>.icon)::after{display:none}td code,td pre{word-wrap:break-word;overflow-wrap:break-word;word-break:break-word}td pre{white-space:pre-wrap;min-width:200px}td:has(code),td:has(pre){min-width:240px;width:auto}td code{min-width:150px}@font-face{font-family:\"Roobert\";src:url(https://assets.ngrok.com/fonts/roobert/roobert-proportional-vf.woff2) format(\"woff2 supports variations\"),url(https://assets.ngrok.com/fonts/roobert/roobert-proportional-vf.woff2) format(\"woff2-variations\");font-weight:300 900;font-display:swap;font-style:normal}@font-face{font-family:\"JetBrains Mono\";src:url(https://assets.ngrok.com/fonts/jetbrains/jetbrainsmono-wght.woff2) format(\"woff2 supports variations\"),url(https://assets.ngrok.com/fonts/jetbrains/jetbrainsmono-wght.woff2) format(\"woff2-variations\");font-weight:100 800;font-display:swap;font-style:normal}@font-face{font-family:\"JetBrains Mono\";src:url(https://assets.ngrok.com/fonts/jetbrains/jetbrainsmono-italic-wght.woff2) format(\"woff2 supports variations\"),url(https://assets.ngrok.com/fonts/jetbrains/jetbrainsmono-italic-wght.woff2) format(\"woff2-variations\");font-weight:100 800;font-display:swap;font-style:italic}.hljs,.token,code,pre,pre code{font-family:\"JetBrains Mono\",ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace!important}#topbar-cta-button span.bg-primary-dark{background-color:#121212!important;transition:background-color!important}#topbar-cta-button a:hover span.bg-primary-dark{background-color:#171717!important}#topbar-cta-button span.text-white,#topbar-cta-button svg{color:#fff!important}.dark #topbar-cta-button span.bg-primary-dark,[data-theme=dark] #topbar-cta-button span.bg-primary-dark{background-color:rgba(255,255,255,.85)!important;transition:background-color!important}.dark #topbar-cta-button a:hover span.bg-primary-dark,[data-theme=dark] #topbar-cta-button a:hover span.bg-primary-dark{background-color:#fff!important}.dark #topbar-cta-button span.text-white,.dark #topbar-cta-button svg,[data-theme=dark] #topbar-cta-button span.text-white,[data-theme=dark] #topbar-cta-button svg{color:#000!important}footer#footer a{overflow:visible;text-overflow:clip;white-space:nowrap}@media (min-width:768px) and (max-width:880px){footer#footer a{white-space:normal}}.nav-tabs-item>div.absolute.bottom-0{height:2px!important}.ngrok-consent{--ngrok-consent-surface:#ffffff;--ngrok-consent-border:#d4d4d4;--ngrok-consent-text:#121212;--ngrok-consent-action-bg-hover:rgb(115 115 115 / 10%);--ngrok-consent-focus-ring:rgb(39 63 195 / 35%);--ngrok-consent-shadow:0 1px 13px 0 rgb(0 0 0 / 5%),\n 0 4px 6px -4px rgb(0 0 0 / 10%),\n 0 10px 15px -3px rgb(0 0 0 / 10%);position:fixed;inset-inline:0;bottom:1rem;z-index:2147483000;display:flex;justify-content:center;padding-inline:1rem;pointer-events:none}:is(html.dark, html[data-theme=\"dark\"]) .ngrok-consent{--ngrok-consent-surface:#171717;--ngrok-consent-border:#404040;--ngrok-consent-text:#ffffff;--ngrok-consent-focus-ring:rgb(105 154 252 / 35%);--ngrok-consent-shadow:0 1px 13px 0 rgb(0 0 0 / 15%),\n 0 4px 6px -4px rgb(0 0 0 / 30%),\n 0 10px 15px -3px rgb(0 0 0 / 30%)}@media (min-width:640px){.ngrok-consent{bottom:2.5rem}}.ngrok-consent-panel{pointer-events:auto;display:flex;align-items:center;gap:.75rem;width:fit-content;max-width:100%;padding:.5rem .75rem;border:1px solid var(--ngrok-consent-border);border-radius:1rem;background-color:var(--ngrok-consent-surface);color:var(--ngrok-consent-text);box-shadow:var(--ngrok-consent-shadow);transition-property:opacity,translate;transition-timing-function:cubic-bezier(0,0,.2,1);transition-duration:400ms}.ngrok-consent-panel[hidden]{display:none}.ngrok-consent-panel[data-state=closed]{pointer-events:none;opacity:0;transition-duration:200ms}@media (prefers-reduced-motion:no-preference){.ngrok-consent-panel[data-state=closed]{translate:0 calc(100% + 2.5rem)}}.ngrok-consent-message{margin:0;font-size:.875rem;line-height:1.25rem}.ngrok-consent-actions{display:flex;align-items:center;gap:.375rem}.ngrok-consent-icon-button{display:inline-flex;flex-shrink:0;align-items:center;justify-content:center;width:1.5rem;height:1.5rem;padding:0;border:1px solid transparent;border-radius:.375rem;background-color:transparent;color:var(--ngrok-consent-text);cursor:pointer;outline:2px solid transparent;outline-offset:2px;text-decoration:none;transition:transform 150ms cubic-bezier(0,0,.2,1)}.ngrok-consent-icon-button:hover{background-color:var(--ngrok-consent-action-bg-hover)}.ngrok-consent-icon-button:active{transform:scale(.97)}.ngrok-consent-icon-button:focus-visible{box-shadow:0 0 0 4px var(--ngrok-consent-focus-ring)}.ngrok-consent-icon-button svg{width:1.25rem;height:1.25rem;flex-shrink:0}"}],"page":{"pagePath":"api-reference/agentingresses/create","slug":"/api-reference/agentingresses/create","pageMetadata":{"openapi":"post /agent_ingresses","description":"Create a new agent ingress configuration to define how agents connect to the ngrok service.","title":"Create","href":"/api-reference/agentingresses/create"},"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 agent ingress configuration to define how agents connect to the ngrok service.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /agent_ingresses","description":"Create a new agent ingress configuration to define how agents connect to the ngrok service.","title":"Create","href":"/api-reference/agentingresses/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/ngrok/05d9da4b27f4fed8/redirect-to-ngrok.js","/docs/_mintlify/custom/ngrok/cabe0d94bdb3d370/persist-query-params.js","/docs/_mintlify/custom/ngrok/09633916ed60fa29/definition-wrapper.js","/docs/_mintlify/custom/ngrok/6167f7a3c0c9913f/consent.js"],"openApiReferenceData":{"operation":{"summary":"Create","description":"Create a new agent ingress configuration to define how agents connect to the ngrok service.","tags":["AgentIngresses"],"operationId":"AgentIngressesCreate","parameters":["f554672e-7cff-4095-9df8-797f424b3a3d"],"requestBody":"be566acb-c714-4019-a212-ae1692cd73e3","responses":{"201":"50ba5a21-11ed-444f-8c06-aa92110f673d","4XX":"dca213cc-4365-43f0-a959-79ba10541d36","5XX":"a0738ac7-3204-4c02-921e-62494fca7779"},"method":"post","type":"path","servers":["550bde25-ea75-4493-9440-b67f1eec212b"],"security":["cd4e7608-2279-4297-97cb-aeec0a887d92"],"path":"/agent_ingresses","baseUrlOptions":["https://api.ngrok.com"],"title":"Create","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f554672e-7cff-4095-9df8-797f424b3a3d":{"name":"ngrok-version","in":"header","required":true,"schema":{"type":"integer","default":2,"isRequired":true,"uniqueKey":"","typeLabel":"integer"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["domain"],"properties":{"domain":{"description":"the domain that you own to be used as the base domain name to generate regional agent ingress domains.\n","type":"string","isRequired":true,"uniqueKey":"domain","typeLabel":"string"},"description":{"description":"human-readable description of the use of this Agent Ingress. optional, max 255 bytes.\n","type":"string","uniqueKey":"description","typeLabel":"string"},"metadata":{"description":"arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes\n","type":"string","uniqueKey":"metadata","typeLabel":"string"},"certificate_management_policy":{"type":"object","properties":{"authority":{"description":"certificate authority to request certificates from. The only supported value is letsencrypt.\n","type":"string","uniqueKey":"certificate_management_policy.authority","typeLabel":"string"},"private_key_type":{"description":"type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.\n","type":"string","uniqueKey":"certificate_management_policy.private_key_type","typeLabel":"string"}},"description":"configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.\n","uniqueKey":"certificate_management_policy","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"domain":"\u003cstring>","description":"\u003cstring>","metadata":"\u003cstring>","certificate_management_policy":{"authority":"\u003cstring>","private_key_type":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"50ba5a21-11ed-444f-8c06-aa92110f673d":{"description":"Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress.\n","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"unique Agent Ingress resource identifier\n","type":"string","uniqueKey":"id","typeLabel":"string"},"uri":{"description":"URI to the API resource of this Agent ingress\n","type":"string","uniqueKey":"uri","typeLabel":"string"},"description":{"description":"human-readable description of the use of this Agent Ingress. optional, max 255 bytes.\n","type":"string","uniqueKey":"description","typeLabel":"string"},"metadata":{"description":"arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes\n","type":"string","uniqueKey":"metadata","typeLabel":"string"},"domain":{"description":"the domain that you own to be used as the base domain name to generate regional agent ingress domains.\n","type":"string","uniqueKey":"domain","typeLabel":"string"},"ns_targets":{"description":"a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok\n","type":"array","items":{"type":"string","uniqueKey":"ns_targets.items.[INDEX]","typeLabel":"string"},"uniqueKey":"ns_targets","typeLabel":"string[]"},"region_domains":{"description":"a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions\n","type":"array","items":{"type":"string","uniqueKey":"region_domains.items.[INDEX]","typeLabel":"string"},"uniqueKey":"region_domains","typeLabel":"string[]"},"created_at":{"description":"timestamp when the Agent Ingress was created, RFC 3339 format\n","type":"string","uniqueKey":"created_at","typeLabel":"string"},"certificate_management_policy":{"type":"object","properties":{"authority":{"description":"certificate authority to request certificates from. The only supported value is letsencrypt.\n","type":"string","uniqueKey":"certificate_management_policy.authority","typeLabel":"string"},"private_key_type":{"description":"type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.\n","type":"string","uniqueKey":"certificate_management_policy.private_key_type","typeLabel":"string"}},"description":"configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled\n","uniqueKey":"certificate_management_policy","typeLabel":"object"},"certificate_management_status":{"type":"object","properties":{"renews_at":{"description":"timestamp when the next renewal will be requested, RFC 3339 format\n","type":"string","uniqueKey":"certificate_management_status.renews_at","typeLabel":"string"},"provisioning_job":{"type":"object","properties":{"error_code":{"description":"if present, an error code indicating why provisioning is failing. It may be either a temporary condition (INTERNAL_ERROR), or a permanent one the user must correct (DNS_ERROR).\n","type":"string","uniqueKey":"certificate_management_status.provisioning_job.error_code","typeLabel":"string"},"msg":{"description":"a message describing the current status or error\n","type":"string","uniqueKey":"certificate_management_status.provisioning_job.msg","typeLabel":"string"},"started_at":{"description":"timestamp when the provisioning job started, RFC 3339 format\n","type":"string","uniqueKey":"certificate_management_status.provisioning_job.started_at","typeLabel":"string"},"retries_at":{"description":"timestamp when the provisioning job will be retried\n","type":"string","uniqueKey":"certificate_management_status.provisioning_job.retries_at","typeLabel":"string"}},"description":"status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed\n","uniqueKey":"certificate_management_status.provisioning_job","typeLabel":"object"}},"description":"status of the automatic certificate management for this domain, or null if automatic management is disabled\n","uniqueKey":"certificate_management_status","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","uri":"\u003cstring>","description":"\u003cstring>","metadata":"\u003cstring>","domain":"\u003cstring>","ns_targets":["\u003cstring>"],"region_domains":["\u003cstring>"],"created_at":"\u003cstring>","certificate_management_policy":{"authority":"\u003cstring>","private_key_type":"\u003cstring>"},"certificate_management_status":{"renews_at":"\u003cstring>","provisioning_job":{"error_code":"\u003cstring>","msg":"\u003cstring>","started_at":"\u003cstring>","retries_at":"\u003cstring>"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"dca213cc-4365-43f0-a959-79ba10541d36":{"description":"An error. The body carries a machine-readable error_code and a human-readable msg; every code is documented at https://ngrok.com/docs/errors. A 429 with error code ERR_NGROK_226 means the account exceeded the documented request-rate limit.\n","content":{"application/json":{"schema":{"type":"object","description":"The error body every api.ngrok.com 4xx and 5xx response returns. Every error condition has a globally unique, documented error code; see https://ngrok.com/docs/errors\n","required":["status_code","msg"],"properties":{"status_code":{"description":"The HTTP status code of the response, duplicated in the body.\n","type":"integer","isRequired":true,"uniqueKey":"status_code","typeLabel":"integer"},"msg":{"description":"Human-readable description of the error and how to resolve it.\n","type":"string","isRequired":true,"uniqueKey":"msg","typeLabel":"string"},"error_code":{"description":"Globally unique machine-readable error code, for example ERR_NGROK_226. Each code is documented at https://ngrok.com/docs/errors/reference. Omitted on transport-level errors such as a plain 404 for an unknown path.\n","type":"string","uniqueKey":"error_code","typeLabel":"string"},"details":{"description":"Additional error context. details.operation_id identifies the failed request when contacting support.\n","type":"object","additionalProperties":{"type":"string","uniqueKey":"details.additionalProperties","typeLabel":"string"},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status_code":123,"msg":"\u003cstring>","error_code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"a0738ac7-3204-4c02-921e-62494fca7779":{"description":"An error. The body carries a machine-readable error_code and a human-readable msg; every code is documented at https://ngrok.com/docs/errors. A 429 with error code ERR_NGROK_226 means the account exceeded the documented request-rate limit.\n","content":{"application/json":{"schema":{"type":"object","description":"The error body every api.ngrok.com 4xx and 5xx response returns. Every error condition has a globally unique, documented error code; see https://ngrok.com/docs/errors\n","required":["status_code","msg"],"properties":{"status_code":{"description":"The HTTP status code of the response, duplicated in the body.\n","type":"integer","isRequired":true,"uniqueKey":"status_code","typeLabel":"integer"},"msg":{"description":"Human-readable description of the error and how to resolve it.\n","type":"string","isRequired":true,"uniqueKey":"msg","typeLabel":"string"},"error_code":{"description":"Globally unique machine-readable error code, for example ERR_NGROK_226. Each code is documented at https://ngrok.com/docs/errors/reference. Omitted on transport-level errors such as a plain 404 for an unknown path.\n","type":"string","uniqueKey":"error_code","typeLabel":"string"},"details":{"description":"Additional error context. details.operation_id identifies the failed request when contacting support.\n","type":"object","additionalProperties":{"type":"string","uniqueKey":"details.additionalProperties","typeLabel":"string"},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status_code":123,"msg":"\u003cstring>","error_code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"cd4e7608-2279-4297-97cb-aeec0a887d92":{"authentication":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"550bde25-ea75-4493-9440-b67f1eec212b":{"url":"https://api.ngrok.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"authentication","name":"Authorization"}],"title":"authentication"}]},"originalFileLocation":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml"},"subdomain":"ngrok","siteName":"ngrok documentation","title":"Create - ngrok documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T00:07:06.154Z","originalFileLocation":"api-reference/agentingresses/create.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 agent ingress configuration to define how agents connect to the ngrok service.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ngrok documentation\">\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/ngrok/EDFj7szN2_Vn64sM/_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/ngrok/EDFj7szN2_Vn64sM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/ngrok/EDFj7szN2_Vn64sM/_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/ngrok/EDFj7szN2_Vn64sM/_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/ngrok/EDFj7szN2_Vn64sM/_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/ngrok/EDFj7szN2_Vn64sM/_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/ngrok/EDFj7szN2_Vn64sM/_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/ngrok/EDFj7szN2_Vn64sM/_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/ngrok/EDFj7szN2_Vn64sM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create - ngrok documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new agent ingress configuration to define how agents connect to the ngrok service.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ngrok documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://ngrok.com/docs/api-reference/agentingresses/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ngrok.mintlify.app/_mintlify/api/og/v2?division=Agent+Ingresses\u0026amp;title=Create\u0026amp;description=Create+a+new+agent+ingress+configuration+to+define+how+agents+connect+to+the+ngrok+service.\u0026amp;theme=dd59335b8ec10833612cbd2f\u0026amp;signature=e7b872aba0bfa9a43fb254f602f4379e55b0fc48865c9af5974960524138d031\">\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 - ngrok documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new agent ingress configuration to define how agents connect to the ngrok service.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ngrok.mintlify.app/_mintlify/api/og/v2?division=Agent+Ingresses\u0026amp;title=Create\u0026amp;description=Create+a+new+agent+ingress+configuration+to+define+how+agents+connect+to+the+ngrok+service.\u0026amp;theme=dd59335b8ec10833612cbd2f\u0026amp;signature=e7b872aba0bfa9a43fb254f602f4379e55b0fc48865c9af5974960524138d031\">\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/ngrok/EDFj7szN2_Vn64sM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ngrok documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#273FC3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://ngrok.com/docs/api-reference/agentingresses/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/agentingresses/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://ngrok.com/#organization\",\"name\":\"ngrok documentation\",\"url\":\"https://ngrok.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ngrok/uPrboN8usISU3fq0/logo/light.svg?fit=max\u0026auto=format\u0026n=uPrboN8usISU3fq0\u0026q=85\u0026s=6a4a2c8995f8731e1bac3f795a68130d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://ngrok.com/docs#website\",\"name\":\"ngrok documentation\",\"url\":\"https://ngrok.com/docs\",\"publisher\":{\"@id\":\"https://ngrok.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://ngrok.com/docs/api-reference/agentingresses/create#webpage\",\"url\":\"https://ngrok.com/docs/api-reference/agentingresses/create\",\"name\":\"Create\",\"description\":\"Create a new agent ingress configuration to define how agents connect to the ngrok service.\",\"dateModified\":\"2026-10-27T00:07:06.154Z\",\"isPartOf\":{\"@id\":\"https://ngrok.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://ngrok.com/docs/api-reference/agentingresses/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://ngrok.com/docs/api-reference/agentingresses/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Secure Tunnels\",\"item\":\"https://ngrok.com/docs/api-reference/agentingresses/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agent Ingresses\",\"item\":\"https://ngrok.com/docs/api-reference/agentingresses/list\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create\",\"item\":\"https://ngrok.com/docs/api-reference/agentingresses/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://ngrok.com/docs/api-reference/agentingresses/create#apireference\",\"headline\":\"Create\",\"name\":\"Create\",\"description\":\"Create a new agent ingress configuration to define how agents connect to the ngrok service.\",\"url\":\"https://ngrok.com/docs/api-reference/agentingresses/create\",\"mainEntityOfPage\":{\"@id\":\"https://ngrok.com/docs/api-reference/agentingresses/create#webpage\"},\"dateModified\":\"2026-10-27T00:07:06.154Z\",\"publisher\":{\"@id\":\"https://ngrok.com/#organization\"},\"isPartOf\":{\"@id\":\"https://ngrok.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ngrok documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"ngrok documentation","nav":{"global":null,"tabs":[{"tab":"Start","pages":[{"title":"Start","href":"/start"}]},{"tab":"Gateway","pages":[{"title":"Gateway","href":"/gateway/overview"}]},{"tab":"AI Gateway","pages":[{"title":"AI Gateway","href":"/ai-gateway/overview"}]},{"tab":"Share Localhost","pages":[{"title":"Share Localhost","href":"/share-localhost/overview"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations"}]},{"tab":"Reference","menu":[{"item":"Platform API","pages":[{"title":"ngrok API Overview","sidebarTitle":"Overview","href":"/api"},{"title":"API Filtering","sidebarTitle":"API Filtering","href":"/api/api-filtering"},{"group":"Gateway","pages":[{"group":"Endpoints","pages":[{"openapi":"get /endpoints","title":"List","href":"/api-reference/endpoints/list"},{"openapi":"post /endpoints","title":"Create","href":"/api-reference/endpoints/create"},{"openapi":"get /endpoints/{id}","title":"Get","href":"/api-reference/endpoints/get"},{"openapi":"delete /endpoints/{id}","title":"Delete","href":"/api-reference/endpoints/delete"},{"openapi":"patch /endpoints/{id}","title":"Update","href":"/api-reference/endpoints/update"}]},{"group":"Reserved Addrs","pages":[{"openapi":"get /reserved_addrs","title":"List","href":"/api-reference/reservedaddrs/list"},{"openapi":"post /reserved_addrs","title":"Create","href":"/api-reference/reservedaddrs/create"},{"openapi":"get /reserved_addrs/{id}","title":"Get","href":"/api-reference/reservedaddrs/get"},{"openapi":"delete /reserved_addrs/{id}","title":"Delete","href":"/api-reference/reservedaddrs/delete"},{"openapi":"patch /reserved_addrs/{id}","title":"Update","href":"/api-reference/reservedaddrs/update"}]},{"group":"Reserved Domains","pages":[{"openapi":"get /reserved_domains","title":"List","href":"/api-reference/reserveddomains/list"},{"openapi":"post /reserved_domains","title":"Create","href":"/api-reference/reserveddomains/create"},{"openapi":"get /reserved_domains/{id}","title":"Get","href":"/api-reference/reserveddomains/get"},{"openapi":"delete /reserved_domains/{id}","title":"Delete","href":"/api-reference/reserveddomains/delete"},{"openapi":"patch /reserved_domains/{id}","title":"Update","href":"/api-reference/reserveddomains/update"},{"openapi":"delete /reserved_domains/{id}/certificate","title":"DeleteCertificate","href":"/api-reference/reserveddomains/deletecertificate"},{"openapi":"delete /reserved_domains/{id}/certificate_management_policy","title":"DeleteCertificateManagementPolicy","href":"/api-reference/reserveddomains/deletecertificatemanagementpolicy"}]},{"group":"TLS Certificates","pages":[{"openapi":"get /tls_certificates","title":"List","href":"/api-reference/tlscertificates/list"},{"openapi":"post /tls_certificates","title":"Create","href":"/api-reference/tlscertificates/create"},{"openapi":"get /tls_certificates/{id}","title":"Get","href":"/api-reference/tlscertificates/get"},{"openapi":"delete /tls_certificates/{id}","title":"Delete","href":"/api-reference/tlscertificates/delete"},{"openapi":"patch /tls_certificates/{id}","title":"Update","href":"/api-reference/tlscertificates/update"}]},{"title":"Kubernetes Operators","href":"/api-reference/kubernetes-operators"}]},{"group":"Traffic Policy","pages":[{"group":"Certificate Authorities","pages":[{"openapi":"get /certificate_authorities","title":"List","href":"/api-reference/certificateauthorities/list"},{"openapi":"post /certificate_authorities","title":"Create","href":"/api-reference/certificateauthorities/create"},{"openapi":"get /certificate_authorities/{id}","title":"Get","href":"/api-reference/certificateauthorities/get"},{"openapi":"delete /certificate_authorities/{id}","title":"Delete","href":"/api-reference/certificateauthorities/delete"},{"openapi":"patch /certificate_authorities/{id}","title":"Update","href":"/api-reference/certificateauthorities/update"}]},{"group":"IP Policies","pages":[{"openapi":"get /ip_policies","title":"List","href":"/api-reference/ippolicies/list"},{"openapi":"post /ip_policies","title":"Create","href":"/api-reference/ippolicies/create"},{"openapi":"get /ip_policies/{id}","title":"Get","href":"/api-reference/ippolicies/get"},{"openapi":"delete /ip_policies/{id}","title":"Delete","href":"/api-reference/ippolicies/delete"},{"openapi":"patch /ip_policies/{id}","title":"Update","href":"/api-reference/ippolicies/update"}]},{"group":"IP Policy Rules","pages":[{"openapi":"get /ip_policy_rules","title":"List","href":"/api-reference/ippolicyrules/list"},{"openapi":"post /ip_policy_rules","title":"Create","href":"/api-reference/ippolicyrules/create"},{"openapi":"get /ip_policy_rules/{id}","title":"Get","href":"/api-reference/ippolicyrules/get"},{"openapi":"delete /ip_policy_rules/{id}","title":"Delete","href":"/api-reference/ippolicyrules/delete"},{"openapi":"patch /ip_policy_rules/{id}","title":"Update","href":"/api-reference/ippolicyrules/update"}]},{"group":"Applications","pages":[{"group":"Application Users","pages":[{"openapi":"get /app/users","title":"List","href":"/api-reference/applicationusers/list"},{"openapi":"get /app/users/{id}","title":"Get","href":"/api-reference/applicationusers/get"},{"openapi":"delete /app/users/{id}","title":"Delete","href":"/api-reference/applicationusers/delete"}]},{"group":"Application Sessions","pages":[{"openapi":"get /app/sessions","title":"List","href":"/api-reference/applicationsessions/list"},{"openapi":"get /app/sessions/{id}","title":"Get","href":"/api-reference/applicationsessions/get"},{"openapi":"delete /app/sessions/{id}","title":"Delete","href":"/api-reference/applicationsessions/delete"}]}]}]},{"group":"Secure Tunnels","pages":[{"group":"Agent Ingresses","pages":[{"openapi":"get /agent_ingresses","description":"List all agent ingress configurations in your ngrok account with optional filtering and pagination.","title":"List","href":"/api-reference/agentingresses/list"},{"openapi":"post /agent_ingresses","title":"Create","href":"/api-reference/agentingresses/create"},{"openapi":"get /agent_ingresses/{id}","description":"Retrieve details about a specific agent ingress configuration by its unique identifier.","title":"Get","href":"/api-reference/agentingresses/get"},{"openapi":"delete /agent_ingresses/{id}","title":"Delete","href":"/api-reference/agentingresses/delete"},{"openapi":"patch /agent_ingresses/{id}","title":"Update","href":"/api-reference/agentingresses/update"}]},{"group":"Tunnel Sessions","pages":[{"openapi":"get /tunnel_sessions","title":"List","href":"/api-reference/tunnelsessions/list"},{"openapi":"get /tunnel_sessions/{id}","title":"Get","href":"/api-reference/tunnelsessions/get"},{"openapi":"post /tunnel_sessions/{id}/restart","title":"Restart","href":"/api-reference/tunnelsessions/restart"},{"openapi":"post /tunnel_sessions/{id}/stop","title":"Stop","href":"/api-reference/tunnelsessions/stop"},{"openapi":"post /tunnel_sessions/{id}/update","title":"Update","href":"/api-reference/tunnelsessions/update"}]}]},{"group":"Observability","pages":[{"group":"Event Destinations","pages":[{"openapi":"get /event_destinations","title":"List","href":"/api-reference/eventdestinations/list"},{"openapi":"post /event_destinations","title":"Create","href":"/api-reference/eventdestinations/create"},{"openapi":"get /event_destinations/{id}","title":"Get","href":"/api-reference/eventdestinations/get"},{"openapi":"delete /event_destinations/{id}","title":"Delete","href":"/api-reference/eventdestinations/delete"},{"openapi":"patch /event_destinations/{id}","title":"Update","href":"/api-reference/eventdestinations/update"}]},{"group":"Event Sources","pages":[{"openapi":"get /event_subscriptions/{subscription_id}/sources","title":"List","href":"/api-reference/eventsources/list"},{"openapi":"post /event_subscriptions/{subscription_id}/sources","title":"Create","href":"/api-reference/eventsources/create"},{"openapi":"get /event_subscriptions/{subscription_id}/sources/{type}","title":"Get","href":"/api-reference/eventsources/get"},{"openapi":"delete /event_subscriptions/{subscription_id}/sources/{type}","title":"Delete","href":"/api-reference/eventsources/delete"},{"openapi":"patch /event_subscriptions/{subscription_id}/sources/{type}","title":"Update","href":"/api-reference/eventsources/update"}]},{"group":"Event Subscriptions","pages":[{"openapi":"get /event_subscriptions","title":"List","href":"/api-reference/eventsubscriptions/list"},{"openapi":"post /event_subscriptions","title":"Create","href":"/api-reference/eventsubscriptions/create"},{"openapi":"get /event_subscriptions/{id}","title":"Get","href":"/api-reference/eventsubscriptions/get"},{"openapi":"delete /event_subscriptions/{id}","title":"Delete","href":"/api-reference/eventsubscriptions/delete"},{"openapi":"patch /event_subscriptions/{id}","title":"Update","href":"/api-reference/eventsubscriptions/update"}]}]},{"group":"IAM","pages":[{"group":"IP Restrictions","pages":[{"openapi":"get /ip_restrictions","title":"List","href":"/api-reference/iprestrictions/list"},{"openapi":"post /ip_restrictions","title":"Create","href":"/api-reference/iprestrictions/create"},{"openapi":"get /ip_restrictions/{id}","title":"Get","href":"/api-reference/iprestrictions/get"},{"openapi":"delete /ip_restrictions/{id}","title":"Delete","href":"/api-reference/iprestrictions/delete"},{"openapi":"patch /ip_restrictions/{id}","title":"Update","href":"/api-reference/iprestrictions/update"}]},{"group":"API Keys","pages":[{"openapi":"get /api_keys","title":"List","href":"/api-reference/apikeys/list"},{"openapi":"post /api_keys","title":"Create","href":"/api-reference/apikeys/create"},{"openapi":"get /api_keys/{id}","title":"Get","href":"/api-reference/apikeys/get"},{"openapi":"delete /api_keys/{id}","title":"Delete","href":"/api-reference/apikeys/delete"},{"openapi":"patch /api_keys/{id}","title":"Update","href":"/api-reference/apikeys/update"}]},{"group":"SSH Credentials","pages":[{"openapi":"get /ssh_credentials","title":"List","href":"/api-reference/sshcredentials/list"},{"openapi":"post /ssh_credentials","title":"Create","href":"/api-reference/sshcredentials/create"},{"openapi":"get /ssh_credentials/{id}","title":"Get","href":"/api-reference/sshcredentials/get"},{"openapi":"delete /ssh_credentials/{id}","title":"Delete","href":"/api-reference/sshcredentials/delete"},{"openapi":"patch /ssh_credentials/{id}","title":"Update","href":"/api-reference/sshcredentials/update"}]},{"group":"Credentials","pages":[{"openapi":"get /credentials","title":"List","href":"/api-reference/credentials/list"},{"openapi":"post /credentials","title":"Create","href":"/api-reference/credentials/create"},{"openapi":"get /credentials/{id}","title":"Get","href":"/api-reference/credentials/get"},{"openapi":"delete /credentials/{id}","title":"Delete","href":"/api-reference/credentials/delete"},{"openapi":"patch /credentials/{id}","title":"Update","href":"/api-reference/credentials/update"}]},{"title":"Service Users (Bot Users)","href":"/api-reference/service-users"}]},{"group":"SSH Certificates","pages":[{"group":"SSH Certificate Authorities","pages":[{"openapi":"get /ssh_certificate_authorities","title":"List","href":"/api-reference/sshcertificateauthorities/list"},{"openapi":"post /ssh_certificate_authorities","title":"Create","href":"/api-reference/sshcertificateauthorities/create"},{"openapi":"get /ssh_certificate_authorities/{id}","title":"Get","href":"/api-reference/sshcertificateauthorities/get"},{"openapi":"delete /ssh_certificate_authorities/{id}","title":"Delete","href":"/api-reference/sshcertificateauthorities/delete"},{"openapi":"patch /ssh_certificate_authorities/{id}","title":"Update","href":"/api-reference/sshcertificateauthorities/update"}]},{"group":"SSH Host Certificates","pages":[{"openapi":"get /ssh_host_certificates","title":"List","href":"/api-reference/sshhostcertificates/list"},{"openapi":"post /ssh_host_certificates","title":"Create","href":"/api-reference/sshhostcertificates/create"},{"openapi":"get /ssh_host_certificates/{id}","title":"Get","href":"/api-reference/sshhostcertificates/get"},{"openapi":"delete /ssh_host_certificates/{id}","title":"Delete","href":"/api-reference/sshhostcertificates/delete"},{"openapi":"patch /ssh_host_certificates/{id}","title":"Update","href":"/api-reference/sshhostcertificates/update"}]},{"group":"SSH User Certificates","pages":[{"openapi":"get /ssh_user_certificates","title":"List","href":"/api-reference/sshusercertificates/list"},{"openapi":"post /ssh_user_certificates","title":"Create","href":"/api-reference/sshusercertificates/create"},{"openapi":"get /ssh_user_certificates/{id}","title":"Get","href":"/api-reference/sshusercertificates/get"},{"openapi":"delete /ssh_user_certificates/{id}","title":"Delete","href":"/api-reference/sshusercertificates/delete"},{"openapi":"patch /ssh_user_certificates/{id}","title":"Update","href":"/api-reference/sshusercertificates/update"}]}]},{"group":"Partners","pages":[{"group":"Abuse Reports","pages":[{"openapi":"post /abuse_reports","title":"Create","href":"/api-reference/abusereports/create"},{"openapi":"get /abuse_reports/{id}","title":"Get","href":"/api-reference/abusereports/get"}]}]},{"group":"Vaults \u0026 Secrets","pages":[{"group":"Secrets","pages":[{"openapi":"get /vault_secrets","title":"List","href":"/api-reference/secrets/list"},{"openapi":"post /vault_secrets","title":"Create","href":"/api-reference/secrets/create"},{"openapi":"get /vault_secrets/{id}","title":"Get","href":"/api-reference/secrets/get"},{"openapi":"delete /vault_secrets/{id}","title":"Delete","href":"/api-reference/secrets/delete"},{"openapi":"patch /vault_secrets/{id}","title":"Update","href":"/api-reference/secrets/update"}]},{"group":"Vaults","pages":[{"openapi":"get /vaults","title":"List","href":"/api-reference/vaults/list"},{"openapi":"post /vaults","title":"Create","href":"/api-reference/vaults/create"},{"openapi":"get /vaults/{id}","title":"Get","href":"/api-reference/vaults/get"},{"openapi":"delete /vaults/{id}","title":"Delete","href":"/api-reference/vaults/delete"},{"openapi":"patch /vaults/{id}","title":"Update","href":"/api-reference/vaults/update"}]}]},{"group":"Deprecated","pages":[{"group":"Bot Users","pages":[{"openapi":"get /bot_users","title":"List","href":"/api-reference/botusers/list"},{"openapi":"post /bot_users","title":"Create","href":"/api-reference/botusers/create"},{"openapi":"get /bot_users/{id}","title":"Get","href":"/api-reference/botusers/get"},{"openapi":"delete /bot_users/{id}","title":"Delete","href":"/api-reference/botusers/delete"},{"openapi":"patch /bot_users/{id}","title":"Update","href":"/api-reference/botusers/update"}]},{"group":"Backends","pages":[{"group":"Failover Backends","pages":[{"openapi":"get /backends/failover","title":"List","href":"/api-reference/failoverbackends/list"},{"openapi":"post /backends/failover","title":"Create","href":"/api-reference/failoverbackends/create"},{"openapi":"get /backends/failover/{id}","title":"Get","href":"/api-reference/failoverbackends/get"},{"openapi":"delete /backends/failover/{id}","title":"Delete","href":"/api-reference/failoverbackends/delete"},{"openapi":"patch /backends/failover/{id}","title":"Update","href":"/api-reference/failoverbackends/update"}]},{"group":"HTTP Response Backends","pages":[{"openapi":"get /backends/http_response","title":"List","href":"/api-reference/httpresponsebackends/list"},{"openapi":"post /backends/http_response","title":"Create","href":"/api-reference/httpresponsebackends/create"},{"openapi":"get /backends/http_response/{id}","title":"Get","href":"/api-reference/httpresponsebackends/get"},{"openapi":"delete /backends/http_response/{id}","title":"Delete","href":"/api-reference/httpresponsebackends/delete"},{"openapi":"patch /backends/http_response/{id}","title":"Update","href":"/api-reference/httpresponsebackends/update"}]},{"group":"Static Backends","pages":[{"openapi":"get /backends/static","title":"List","href":"/api-reference/staticbackends/list"},{"openapi":"post /backends/static","title":"Create","href":"/api-reference/staticbackends/create"},{"openapi":"get /backends/static/{id}","title":"Get","href":"/api-reference/staticbackends/get"},{"openapi":"delete /backends/static/{id}","title":"Delete","href":"/api-reference/staticbackends/delete"},{"openapi":"patch /backends/static/{id}","title":"Update","href":"/api-reference/staticbackends/update"}]},{"group":"Tunnel Group Backends","pages":[{"openapi":"get /backends/tunnel_group","title":"List","href":"/api-reference/tunnelgroupbackends/list"},{"openapi":"post /backends/tunnel_group","title":"Create","href":"/api-reference/tunnelgroupbackends/create"},{"openapi":"get /backends/tunnel_group/{id}","title":"Get","href":"/api-reference/tunnelgroupbackends/get"},{"openapi":"delete /backends/tunnel_group/{id}","title":"Delete","href":"/api-reference/tunnelgroupbackends/delete"},{"openapi":"patch /backends/tunnel_group/{id}","title":"Update","href":"/api-reference/tunnelgroupbackends/update"}]},{"group":"Weighted Backends","pages":[{"openapi":"get /backends/weighted","title":"List","href":"/api-reference/weightedbackends/list"},{"openapi":"post /backends/weighted","title":"Create","href":"/api-reference/weightedbackends/create"},{"openapi":"get /backends/weighted/{id}","title":"Get","href":"/api-reference/weightedbackends/get"},{"openapi":"delete /backends/weighted/{id}","title":"Delete","href":"/api-reference/weightedbackends/delete"},{"openapi":"patch /backends/weighted/{id}","title":"Update","href":"/api-reference/weightedbackends/update"}]}]},{"group":"Edge Route Backend Module","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/backend","title":"Get","href":"/api-reference/edgeroutebackendmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/backend","title":"Replace","href":"/api-reference/edgeroutebackendmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/backend","title":"Delete","href":"/api-reference/edgeroutebackendmodule/delete"}]},{"group":"Edge Route Circuit Breaker Module","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/circuit_breaker","title":"Get","href":"/api-reference/edgeroutecircuitbreakermodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/circuit_breaker","title":"Replace","href":"/api-reference/edgeroutecircuitbreakermodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/circuit_breaker","title":"Delete","href":"/api-reference/edgeroutecircuitbreakermodule/delete"}]},{"group":"Edge Route Compression Module","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/compression","title":"Get","href":"/api-reference/edgeroutecompressionmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/compression","title":"Replace","href":"/api-reference/edgeroutecompressionmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/compression","title":"Delete","href":"/api-reference/edgeroutecompressionmodule/delete"}]},{"group":"Edge Route IP Restriction Module","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/ip_restriction","title":"Get","href":"/api-reference/edgerouteiprestrictionmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/ip_restriction","title":"Replace","href":"/api-reference/edgerouteiprestrictionmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/ip_restriction","title":"Delete","href":"/api-reference/edgerouteiprestrictionmodule/delete"}]},{"group":"Edge Route OAuth Module","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/oauth","title":"Get","href":"/api-reference/edgerouteoauthmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/oauth","title":"Replace","href":"/api-reference/edgerouteoauthmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/oauth","title":"Delete","href":"/api-reference/edgerouteoauthmodule/delete"}]},{"group":"Edge Route OIDC Module","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/oidc","title":"Get","href":"/api-reference/edgerouteoidcmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/oidc","title":"Replace","href":"/api-reference/edgerouteoidcmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/oidc","title":"Delete","href":"/api-reference/edgerouteoidcmodule/delete"}]},{"group":"Edge Route Request Headers Module","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/request_headers","title":"Get","href":"/api-reference/edgerouterequestheadersmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/request_headers","title":"Replace","href":"/api-reference/edgerouterequestheadersmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/request_headers","title":"Delete","href":"/api-reference/edgerouterequestheadersmodule/delete"}]},{"group":"Edge Route Response Headers Module","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/response_headers","title":"Get","href":"/api-reference/edgerouteresponseheadersmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/response_headers","title":"Replace","href":"/api-reference/edgerouteresponseheadersmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/response_headers","title":"Delete","href":"/api-reference/edgerouteresponseheadersmodule/delete"}]},{"group":"Edge Route SAML Module","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/saml","title":"Get","href":"/api-reference/edgeroutesamlmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/saml","title":"Replace","href":"/api-reference/edgeroutesamlmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/saml","title":"Delete","href":"/api-reference/edgeroutesamlmodule/delete"}]},{"group":"Edge Route Traffic Policy Module","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/traffic_policy","title":"Get","href":"/api-reference/edgeroutetrafficpolicymodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/traffic_policy","title":"Replace","href":"/api-reference/edgeroutetrafficpolicymodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/traffic_policy","title":"Delete","href":"/api-reference/edgeroutetrafficpolicymodule/delete"}]},{"group":"Edge Route User Agent Filter Module","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/user_agent_filter","title":"Get","href":"/api-reference/edgerouteuseragentfiltermodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/user_agent_filter","title":"Replace","href":"/api-reference/edgerouteuseragentfiltermodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/user_agent_filter","title":"Delete","href":"/api-reference/edgerouteuseragentfiltermodule/delete"}]},{"group":"Edge Route Webhook Verification Module","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/webhook_verification","title":"Get","href":"/api-reference/edgeroutewebhookverificationmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/webhook_verification","title":"Replace","href":"/api-reference/edgeroutewebhookverificationmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/webhook_verification","title":"Delete","href":"/api-reference/edgeroutewebhookverificationmodule/delete"}]},{"group":"Edge Route Websocket TCP Converter Module","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/websocket_tcp_converter","title":"Get","href":"/api-reference/edgeroutewebsockettcpconvertermodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/websocket_tcp_converter","title":"Replace","href":"/api-reference/edgeroutewebsockettcpconvertermodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/websocket_tcp_converter","title":"Delete","href":"/api-reference/edgeroutewebsockettcpconvertermodule/delete"}]},{"group":"Edges HTTPS","pages":[{"openapi":"get /edges/https","title":"List","href":"/api-reference/edgeshttps/list"},{"openapi":"post /edges/https","title":"Create","href":"/api-reference/edgeshttps/create"},{"openapi":"get /edges/https/{id}","title":"Get","href":"/api-reference/edgeshttps/get"},{"openapi":"delete /edges/https/{id}","title":"Delete","href":"/api-reference/edgeshttps/delete"},{"openapi":"patch /edges/https/{id}","title":"Update","href":"/api-reference/edgeshttps/update"}]},{"group":"Edges HTTPS Routes","pages":[{"openapi":"post /edges/https/{edge_id}/routes","title":"Create","href":"/api-reference/edgeshttpsroutes/create"},{"openapi":"get /edges/https/{edge_id}/routes/{id}","title":"Get","href":"/api-reference/edgeshttpsroutes/get"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}","title":"Delete","href":"/api-reference/edgeshttpsroutes/delete"},{"openapi":"patch /edges/https/{edge_id}/routes/{id}","title":"Update","href":"/api-reference/edgeshttpsroutes/update"}]},{"group":"Edges TCP","pages":[{"openapi":"get /edges/tcp","title":"List","href":"/api-reference/edgestcp/list"},{"openapi":"post /edges/tcp","title":"Create","href":"/api-reference/edgestcp/create"},{"openapi":"get /edges/tcp/{id}","title":"Get","href":"/api-reference/edgestcp/get"},{"openapi":"delete /edges/tcp/{id}","title":"Delete","href":"/api-reference/edgestcp/delete"},{"openapi":"patch /edges/tcp/{id}","title":"Update","href":"/api-reference/edgestcp/update"}]},{"group":"Edges TLS","pages":[{"openapi":"get /edges/tls","title":"List","href":"/api-reference/edgestls/list"},{"openapi":"post /edges/tls","title":"Create","href":"/api-reference/edgestls/create"},{"openapi":"get /edges/tls/{id}","title":"Get","href":"/api-reference/edgestls/get"},{"openapi":"delete /edges/tls/{id}","title":"Delete","href":"/api-reference/edgestls/delete"},{"openapi":"patch /edges/tls/{id}","title":"Update","href":"/api-reference/edgestls/update"}]},{"group":"HTTPS Edge Mutual TLS Module","pages":[{"openapi":"get /edges/https/{id}/mutual_tls","title":"Get","href":"/api-reference/httpsedgemutualtlsmodule/get"},{"openapi":"put /edges/https/{id}/mutual_tls","title":"Replace","href":"/api-reference/httpsedgemutualtlsmodule/replace"},{"openapi":"delete /edges/https/{id}/mutual_tls","title":"Delete","href":"/api-reference/httpsedgemutualtlsmodule/delete"}]},{"group":"HTTPS Edge TLS Termination Module","pages":[{"openapi":"get /edges/https/{id}/tls_termination","title":"Get","href":"/api-reference/httpsedgetlsterminationmodule/get"},{"openapi":"put /edges/https/{id}/tls_termination","title":"Replace","href":"/api-reference/httpsedgetlsterminationmodule/replace"},{"openapi":"delete /edges/https/{id}/tls_termination","title":"Delete","href":"/api-reference/httpsedgetlsterminationmodule/delete"}]},{"group":"TCP Edge Backend Module","pages":[{"openapi":"get /edges/tcp/{id}/backend","title":"Get","href":"/api-reference/tcpedgebackendmodule/get"},{"openapi":"put /edges/tcp/{id}/backend","title":"Replace","href":"/api-reference/tcpedgebackendmodule/replace"},{"openapi":"delete /edges/tcp/{id}/backend","title":"Delete","href":"/api-reference/tcpedgebackendmodule/delete"}]},{"group":"TCP Edge IP Restriction Module","pages":[{"openapi":"get /edges/tcp/{id}/ip_restriction","title":"Get","href":"/api-reference/tcpedgeiprestrictionmodule/get"},{"openapi":"put /edges/tcp/{id}/ip_restriction","title":"Replace","href":"/api-reference/tcpedgeiprestrictionmodule/replace"},{"openapi":"delete /edges/tcp/{id}/ip_restriction","title":"Delete","href":"/api-reference/tcpedgeiprestrictionmodule/delete"}]},{"group":"TCP Edge Traffic Policy Module","pages":[{"openapi":"get /edges/tcp/{id}/traffic_policy","title":"Get","href":"/api-reference/tcpedgetrafficpolicymodule/get"},{"openapi":"put /edges/tcp/{id}/traffic_policy","title":"Replace","href":"/api-reference/tcpedgetrafficpolicymodule/replace"},{"openapi":"delete /edges/tcp/{id}/traffic_policy","title":"Delete","href":"/api-reference/tcpedgetrafficpolicymodule/delete"}]},{"group":"TLS Edge Backend Module","pages":[{"openapi":"get /edges/tls/{id}/backend","title":"Get","href":"/api-reference/tlsedgebackendmodule/get"},{"openapi":"put /edges/tls/{id}/backend","title":"Replace","href":"/api-reference/tlsedgebackendmodule/replace"},{"openapi":"delete /edges/tls/{id}/backend","title":"Delete","href":"/api-reference/tlsedgebackendmodule/delete"}]},{"group":"TLS Edge IP Restriction Module","pages":[{"openapi":"get /edges/tls/{id}/ip_restriction","title":"Get","href":"/api-reference/tlsedgeiprestrictionmodule/get"},{"openapi":"put /edges/tls/{id}/ip_restriction","title":"Replace","href":"/api-reference/tlsedgeiprestrictionmodule/replace"},{"openapi":"delete /edges/tls/{id}/ip_restriction","title":"Delete","href":"/api-reference/tlsedgeiprestrictionmodule/delete"}]},{"group":"TLS Edge Mutual TLS Module","pages":[{"openapi":"get /edges/tls/{id}/mutual_tls","title":"Get","href":"/api-reference/tlsedgemutualtlsmodule/get"},{"openapi":"put /edges/tls/{id}/mutual_tls","title":"Replace","href":"/api-reference/tlsedgemutualtlsmodule/replace"},{"openapi":"delete /edges/tls/{id}/mutual_tls","title":"Delete","href":"/api-reference/tlsedgemutualtlsmodule/delete"}]},{"group":"TLS Edge TLS Termination Module","pages":[{"openapi":"get /edges/tls/{id}/tls_termination","title":"Get","href":"/api-reference/tlsedgetlsterminationmodule/get"},{"openapi":"put /edges/tls/{id}/tls_termination","title":"Replace","href":"/api-reference/tlsedgetlsterminationmodule/replace"},{"openapi":"delete /edges/tls/{id}/tls_termination","title":"Delete","href":"/api-reference/tlsedgetlsterminationmodule/delete"}]},{"group":"TLS Edge Traffic Policy Module","pages":[{"openapi":"get /edges/tls/{id}/traffic_policy","title":"Get","href":"/api-reference/tlsedgetrafficpolicymodule/get"},{"openapi":"put /edges/tls/{id}/traffic_policy","title":"Replace","href":"/api-reference/tlsedgetrafficpolicymodule/replace"},{"openapi":"delete /edges/tls/{id}/traffic_policy","title":"Delete","href":"/api-reference/tlsedgetrafficpolicymodule/delete"}]},{"group":"Tunnels","pages":[{"openapi":"get /tunnels","title":"List","href":"/api-reference/tunnels/list"},{"openapi":"get /tunnels/{id}","title":"Get","href":"/api-reference/tunnels/get"}]}]}],"groups":[{"group":"AbuseReports","pages":[{"openapi":"post /abuse_reports","title":"Create","href":"/api-reference/abusereports/create"},{"openapi":"get /abuse_reports/{id}","title":"Get","href":"/api-reference/abusereports/get"}]},{"group":"AgentIngresses","pages":[{"openapi":"get /agent_ingresses","description":"List all agent ingress configurations in your ngrok account with optional filtering and pagination.","title":"List","href":"/api-reference/agentingresses/list"},{"openapi":"post /agent_ingresses","title":"Create","href":"/api-reference/agentingresses/create"},{"openapi":"get /agent_ingresses/{id}","description":"Retrieve details about a specific agent ingress configuration by its unique identifier.","title":"Get","href":"/api-reference/agentingresses/get"},{"openapi":"delete /agent_ingresses/{id}","title":"Delete","href":"/api-reference/agentingresses/delete"},{"openapi":"patch /agent_ingresses/{id}","title":"Update","href":"/api-reference/agentingresses/update"}]},{"group":"AIGatewayProviderKeys","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml get /ai_gateway_provider_keys","href":"/api-reference/aigatewayproviderkeys/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml post /ai_gateway_provider_keys","href":"/api-reference/aigatewayproviderkeys/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml get /ai_gateway_provider_keys/{id}","href":"/api-reference/aigatewayproviderkeys/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml delete /ai_gateway_provider_keys/{id}","href":"/api-reference/aigatewayproviderkeys/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml patch /ai_gateway_provider_keys/{id}","href":"/api-reference/aigatewayproviderkeys/update"}]},{"group":"AIGatewayAPIKeys","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml get /ai_gateway_api_keys","href":"/api-reference/aigatewayapikeys/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml post /ai_gateway_api_keys","href":"/api-reference/aigatewayapikeys/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml get /ai_gateway_api_keys/{id}","href":"/api-reference/aigatewayapikeys/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml delete /ai_gateway_api_keys/{id}","href":"/api-reference/aigatewayapikeys/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml patch /ai_gateway_api_keys/{id}","href":"/api-reference/aigatewayapikeys/update"}]},{"group":"APIKeys","pages":[{"openapi":"get /api_keys","title":"List","href":"/api-reference/apikeys/list"},{"openapi":"post /api_keys","title":"Create","href":"/api-reference/apikeys/create"},{"openapi":"get /api_keys/{id}","title":"Get","href":"/api-reference/apikeys/get"},{"openapi":"delete /api_keys/{id}","title":"Delete","href":"/api-reference/apikeys/delete"},{"openapi":"patch /api_keys/{id}","title":"Update","href":"/api-reference/apikeys/update"}]},{"group":"ApplicationSessions","pages":[{"openapi":"get /app/sessions","title":"List","href":"/api-reference/applicationsessions/list"},{"openapi":"get /app/sessions/{id}","title":"Get","href":"/api-reference/applicationsessions/get"},{"openapi":"delete /app/sessions/{id}","title":"Delete","href":"/api-reference/applicationsessions/delete"}]},{"group":"ApplicationUsers","pages":[{"openapi":"get /app/users","title":"List","href":"/api-reference/applicationusers/list"},{"openapi":"get /app/users/{id}","title":"Get","href":"/api-reference/applicationusers/get"},{"openapi":"delete /app/users/{id}","title":"Delete","href":"/api-reference/applicationusers/delete"}]},{"group":"TunnelSessions","pages":[{"openapi":"get /tunnel_sessions","title":"List","href":"/api-reference/tunnelsessions/list"},{"openapi":"get /tunnel_sessions/{id}","title":"Get","href":"/api-reference/tunnelsessions/get"},{"openapi":"post /tunnel_sessions/{id}/restart","title":"Restart","href":"/api-reference/tunnelsessions/restart"},{"openapi":"post /tunnel_sessions/{id}/stop","title":"Stop","href":"/api-reference/tunnelsessions/stop"},{"openapi":"post /tunnel_sessions/{id}/update","title":"Update","href":"/api-reference/tunnelsessions/update"}]},{"group":"FailoverBackends","pages":[{"openapi":"get /backends/failover","title":"List","href":"/api-reference/failoverbackends/list"},{"openapi":"post /backends/failover","title":"Create","href":"/api-reference/failoverbackends/create"},{"openapi":"get /backends/failover/{id}","title":"Get","href":"/api-reference/failoverbackends/get"},{"openapi":"delete /backends/failover/{id}","title":"Delete","href":"/api-reference/failoverbackends/delete"},{"openapi":"patch /backends/failover/{id}","title":"Update","href":"/api-reference/failoverbackends/update"}]},{"group":"HTTPResponseBackends","pages":[{"openapi":"get /backends/http_response","title":"List","href":"/api-reference/httpresponsebackends/list"},{"openapi":"post /backends/http_response","title":"Create","href":"/api-reference/httpresponsebackends/create"},{"openapi":"get /backends/http_response/{id}","title":"Get","href":"/api-reference/httpresponsebackends/get"},{"openapi":"delete /backends/http_response/{id}","title":"Delete","href":"/api-reference/httpresponsebackends/delete"},{"openapi":"patch /backends/http_response/{id}","title":"Update","href":"/api-reference/httpresponsebackends/update"}]},{"group":"StaticBackends","pages":[{"openapi":"get /backends/static","title":"List","href":"/api-reference/staticbackends/list"},{"openapi":"post /backends/static","title":"Create","href":"/api-reference/staticbackends/create"},{"openapi":"get /backends/static/{id}","title":"Get","href":"/api-reference/staticbackends/get"},{"openapi":"delete /backends/static/{id}","title":"Delete","href":"/api-reference/staticbackends/delete"},{"openapi":"patch /backends/static/{id}","title":"Update","href":"/api-reference/staticbackends/update"}]},{"group":"TunnelGroupBackends","pages":[{"openapi":"get /backends/tunnel_group","title":"List","href":"/api-reference/tunnelgroupbackends/list"},{"openapi":"post /backends/tunnel_group","title":"Create","href":"/api-reference/tunnelgroupbackends/create"},{"openapi":"get /backends/tunnel_group/{id}","title":"Get","href":"/api-reference/tunnelgroupbackends/get"},{"openapi":"delete /backends/tunnel_group/{id}","title":"Delete","href":"/api-reference/tunnelgroupbackends/delete"},{"openapi":"patch /backends/tunnel_group/{id}","title":"Update","href":"/api-reference/tunnelgroupbackends/update"}]},{"group":"WeightedBackends","pages":[{"openapi":"get /backends/weighted","title":"List","href":"/api-reference/weightedbackends/list"},{"openapi":"post /backends/weighted","title":"Create","href":"/api-reference/weightedbackends/create"},{"openapi":"get /backends/weighted/{id}","title":"Get","href":"/api-reference/weightedbackends/get"},{"openapi":"delete /backends/weighted/{id}","title":"Delete","href":"/api-reference/weightedbackends/delete"},{"openapi":"patch /backends/weighted/{id}","title":"Update","href":"/api-reference/weightedbackends/update"}]},{"group":"BotUsers","pages":[{"openapi":"get /bot_users","title":"List","href":"/api-reference/botusers/list"},{"openapi":"post /bot_users","title":"Create","href":"/api-reference/botusers/create"},{"openapi":"get /bot_users/{id}","title":"Get","href":"/api-reference/botusers/get"},{"openapi":"delete /bot_users/{id}","title":"Delete","href":"/api-reference/botusers/delete"},{"openapi":"patch /bot_users/{id}","title":"Update","href":"/api-reference/botusers/update"}]},{"group":"CertificateAuthorities","pages":[{"openapi":"get /certificate_authorities","title":"List","href":"/api-reference/certificateauthorities/list"},{"openapi":"post /certificate_authorities","title":"Create","href":"/api-reference/certificateauthorities/create"},{"openapi":"get /certificate_authorities/{id}","title":"Get","href":"/api-reference/certificateauthorities/get"},{"openapi":"delete /certificate_authorities/{id}","title":"Delete","href":"/api-reference/certificateauthorities/delete"},{"openapi":"patch /certificate_authorities/{id}","title":"Update","href":"/api-reference/certificateauthorities/update"}]},{"group":"Credentials","pages":[{"openapi":"get /credentials","title":"List","href":"/api-reference/credentials/list"},{"openapi":"post /credentials","title":"Create","href":"/api-reference/credentials/create"},{"openapi":"get /credentials/{id}","title":"Get","href":"/api-reference/credentials/get"},{"openapi":"delete /credentials/{id}","title":"Delete","href":"/api-reference/credentials/delete"},{"openapi":"patch /credentials/{id}","title":"Update","href":"/api-reference/credentials/update"}]},{"group":"EdgesHTTPSRoutes","pages":[{"openapi":"post /edges/https/{edge_id}/routes","title":"Create","href":"/api-reference/edgeshttpsroutes/create"},{"openapi":"get /edges/https/{edge_id}/routes/{id}","title":"Get","href":"/api-reference/edgeshttpsroutes/get"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}","title":"Delete","href":"/api-reference/edgeshttpsroutes/delete"},{"openapi":"patch /edges/https/{edge_id}/routes/{id}","title":"Update","href":"/api-reference/edgeshttpsroutes/update"}]},{"group":"EdgesHTTPS","pages":[{"openapi":"get /edges/https","title":"List","href":"/api-reference/edgeshttps/list"},{"openapi":"post /edges/https","title":"Create","href":"/api-reference/edgeshttps/create"},{"openapi":"get /edges/https/{id}","title":"Get","href":"/api-reference/edgeshttps/get"},{"openapi":"delete /edges/https/{id}","title":"Delete","href":"/api-reference/edgeshttps/delete"},{"openapi":"patch /edges/https/{id}","title":"Update","href":"/api-reference/edgeshttps/update"}]},{"group":"HTTPSEdgeMutualTLSModule","pages":[{"openapi":"get /edges/https/{id}/mutual_tls","title":"Get","href":"/api-reference/httpsedgemutualtlsmodule/get"},{"openapi":"put /edges/https/{id}/mutual_tls","title":"Replace","href":"/api-reference/httpsedgemutualtlsmodule/replace"},{"openapi":"delete /edges/https/{id}/mutual_tls","title":"Delete","href":"/api-reference/httpsedgemutualtlsmodule/delete"}]},{"group":"HTTPSEdgeTLSTerminationModule","pages":[{"openapi":"get /edges/https/{id}/tls_termination","title":"Get","href":"/api-reference/httpsedgetlsterminationmodule/get"},{"openapi":"put /edges/https/{id}/tls_termination","title":"Replace","href":"/api-reference/httpsedgetlsterminationmodule/replace"},{"openapi":"delete /edges/https/{id}/tls_termination","title":"Delete","href":"/api-reference/httpsedgetlsterminationmodule/delete"}]},{"group":"EdgeRouteBackendModule","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/backend","title":"Get","href":"/api-reference/edgeroutebackendmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/backend","title":"Replace","href":"/api-reference/edgeroutebackendmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/backend","title":"Delete","href":"/api-reference/edgeroutebackendmodule/delete"}]},{"group":"EdgeRouteIPRestrictionModule","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/ip_restriction","title":"Get","href":"/api-reference/edgerouteiprestrictionmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/ip_restriction","title":"Replace","href":"/api-reference/edgerouteiprestrictionmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/ip_restriction","title":"Delete","href":"/api-reference/edgerouteiprestrictionmodule/delete"}]},{"group":"EdgeRouteRequestHeadersModule","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/request_headers","title":"Get","href":"/api-reference/edgerouterequestheadersmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/request_headers","title":"Replace","href":"/api-reference/edgerouterequestheadersmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/request_headers","title":"Delete","href":"/api-reference/edgerouterequestheadersmodule/delete"}]},{"group":"EdgeRouteResponseHeadersModule","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/response_headers","title":"Get","href":"/api-reference/edgerouteresponseheadersmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/response_headers","title":"Replace","href":"/api-reference/edgerouteresponseheadersmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/response_headers","title":"Delete","href":"/api-reference/edgerouteresponseheadersmodule/delete"}]},{"group":"EdgeRouteCompressionModule","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/compression","title":"Get","href":"/api-reference/edgeroutecompressionmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/compression","title":"Replace","href":"/api-reference/edgeroutecompressionmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/compression","title":"Delete","href":"/api-reference/edgeroutecompressionmodule/delete"}]},{"group":"EdgeRouteCircuitBreakerModule","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/circuit_breaker","title":"Get","href":"/api-reference/edgeroutecircuitbreakermodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/circuit_breaker","title":"Replace","href":"/api-reference/edgeroutecircuitbreakermodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/circuit_breaker","title":"Delete","href":"/api-reference/edgeroutecircuitbreakermodule/delete"}]},{"group":"EdgeRouteWebhookVerificationModule","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/webhook_verification","title":"Get","href":"/api-reference/edgeroutewebhookverificationmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/webhook_verification","title":"Replace","href":"/api-reference/edgeroutewebhookverificationmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/webhook_verification","title":"Delete","href":"/api-reference/edgeroutewebhookverificationmodule/delete"}]},{"group":"EdgeRouteOAuthModule","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/oauth","title":"Get","href":"/api-reference/edgerouteoauthmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/oauth","title":"Replace","href":"/api-reference/edgerouteoauthmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/oauth","title":"Delete","href":"/api-reference/edgerouteoauthmodule/delete"}]},{"group":"EdgeRouteSAMLModule","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/saml","title":"Get","href":"/api-reference/edgeroutesamlmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/saml","title":"Replace","href":"/api-reference/edgeroutesamlmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/saml","title":"Delete","href":"/api-reference/edgeroutesamlmodule/delete"}]},{"group":"EdgeRouteOIDCModule","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/oidc","title":"Get","href":"/api-reference/edgerouteoidcmodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/oidc","title":"Replace","href":"/api-reference/edgerouteoidcmodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/oidc","title":"Delete","href":"/api-reference/edgerouteoidcmodule/delete"}]},{"group":"EdgeRouteWebsocketTCPConverterModule","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/websocket_tcp_converter","title":"Get","href":"/api-reference/edgeroutewebsockettcpconvertermodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/websocket_tcp_converter","title":"Replace","href":"/api-reference/edgeroutewebsockettcpconvertermodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/websocket_tcp_converter","title":"Delete","href":"/api-reference/edgeroutewebsockettcpconvertermodule/delete"}]},{"group":"EdgeRouteUserAgentFilterModule","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/user_agent_filter","title":"Get","href":"/api-reference/edgerouteuseragentfiltermodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/user_agent_filter","title":"Replace","href":"/api-reference/edgerouteuseragentfiltermodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/user_agent_filter","title":"Delete","href":"/api-reference/edgerouteuseragentfiltermodule/delete"}]},{"group":"EdgeRouteTrafficPolicyModule","pages":[{"openapi":"get /edges/https/{edge_id}/routes/{id}/traffic_policy","title":"Get","href":"/api-reference/edgeroutetrafficpolicymodule/get"},{"openapi":"put /edges/https/{edge_id}/routes/{id}/traffic_policy","title":"Replace","href":"/api-reference/edgeroutetrafficpolicymodule/replace"},{"openapi":"delete /edges/https/{edge_id}/routes/{id}/traffic_policy","title":"Delete","href":"/api-reference/edgeroutetrafficpolicymodule/delete"}]},{"group":"EdgesTCP","pages":[{"openapi":"get /edges/tcp","title":"List","href":"/api-reference/edgestcp/list"},{"openapi":"post /edges/tcp","title":"Create","href":"/api-reference/edgestcp/create"},{"openapi":"get /edges/tcp/{id}","title":"Get","href":"/api-reference/edgestcp/get"},{"openapi":"delete /edges/tcp/{id}","title":"Delete","href":"/api-reference/edgestcp/delete"},{"openapi":"patch /edges/tcp/{id}","title":"Update","href":"/api-reference/edgestcp/update"}]},{"group":"TCPEdgeBackendModule","pages":[{"openapi":"get /edges/tcp/{id}/backend","title":"Get","href":"/api-reference/tcpedgebackendmodule/get"},{"openapi":"put /edges/tcp/{id}/backend","title":"Replace","href":"/api-reference/tcpedgebackendmodule/replace"},{"openapi":"delete /edges/tcp/{id}/backend","title":"Delete","href":"/api-reference/tcpedgebackendmodule/delete"}]},{"group":"TCPEdgeIPRestrictionModule","pages":[{"openapi":"get /edges/tcp/{id}/ip_restriction","title":"Get","href":"/api-reference/tcpedgeiprestrictionmodule/get"},{"openapi":"put /edges/tcp/{id}/ip_restriction","title":"Replace","href":"/api-reference/tcpedgeiprestrictionmodule/replace"},{"openapi":"delete /edges/tcp/{id}/ip_restriction","title":"Delete","href":"/api-reference/tcpedgeiprestrictionmodule/delete"}]},{"group":"TCPEdgeTrafficPolicyModule","pages":[{"openapi":"get /edges/tcp/{id}/traffic_policy","title":"Get","href":"/api-reference/tcpedgetrafficpolicymodule/get"},{"openapi":"put /edges/tcp/{id}/traffic_policy","title":"Replace","href":"/api-reference/tcpedgetrafficpolicymodule/replace"},{"openapi":"delete /edges/tcp/{id}/traffic_policy","title":"Delete","href":"/api-reference/tcpedgetrafficpolicymodule/delete"}]},{"group":"EdgesTLS","pages":[{"openapi":"get /edges/tls","title":"List","href":"/api-reference/edgestls/list"},{"openapi":"post /edges/tls","title":"Create","href":"/api-reference/edgestls/create"},{"openapi":"get /edges/tls/{id}","title":"Get","href":"/api-reference/edgestls/get"},{"openapi":"delete /edges/tls/{id}","title":"Delete","href":"/api-reference/edgestls/delete"},{"openapi":"patch /edges/tls/{id}","title":"Update","href":"/api-reference/edgestls/update"}]},{"group":"TLSEdgeBackendModule","pages":[{"openapi":"get /edges/tls/{id}/backend","title":"Get","href":"/api-reference/tlsedgebackendmodule/get"},{"openapi":"put /edges/tls/{id}/backend","title":"Replace","href":"/api-reference/tlsedgebackendmodule/replace"},{"openapi":"delete /edges/tls/{id}/backend","title":"Delete","href":"/api-reference/tlsedgebackendmodule/delete"}]},{"group":"TLSEdgeIPRestrictionModule","pages":[{"openapi":"get /edges/tls/{id}/ip_restriction","title":"Get","href":"/api-reference/tlsedgeiprestrictionmodule/get"},{"openapi":"put /edges/tls/{id}/ip_restriction","title":"Replace","href":"/api-reference/tlsedgeiprestrictionmodule/replace"},{"openapi":"delete /edges/tls/{id}/ip_restriction","title":"Delete","href":"/api-reference/tlsedgeiprestrictionmodule/delete"}]},{"group":"TLSEdgeMutualTLSModule","pages":[{"openapi":"get /edges/tls/{id}/mutual_tls","title":"Get","href":"/api-reference/tlsedgemutualtlsmodule/get"},{"openapi":"put /edges/tls/{id}/mutual_tls","title":"Replace","href":"/api-reference/tlsedgemutualtlsmodule/replace"},{"openapi":"delete /edges/tls/{id}/mutual_tls","title":"Delete","href":"/api-reference/tlsedgemutualtlsmodule/delete"}]},{"group":"TLSEdgeTLSTerminationModule","pages":[{"openapi":"get /edges/tls/{id}/tls_termination","title":"Get","href":"/api-reference/tlsedgetlsterminationmodule/get"},{"openapi":"put /edges/tls/{id}/tls_termination","title":"Replace","href":"/api-reference/tlsedgetlsterminationmodule/replace"},{"openapi":"delete /edges/tls/{id}/tls_termination","title":"Delete","href":"/api-reference/tlsedgetlsterminationmodule/delete"}]},{"group":"TLSEdgeTrafficPolicyModule","pages":[{"openapi":"get /edges/tls/{id}/traffic_policy","title":"Get","href":"/api-reference/tlsedgetrafficpolicymodule/get"},{"openapi":"put /edges/tls/{id}/traffic_policy","title":"Replace","href":"/api-reference/tlsedgetrafficpolicymodule/replace"},{"openapi":"delete /edges/tls/{id}/traffic_policy","title":"Delete","href":"/api-reference/tlsedgetrafficpolicymodule/delete"}]},{"group":"Endpoints","pages":[{"openapi":"get /endpoints","title":"List","href":"/api-reference/endpoints/list"},{"openapi":"post /endpoints","title":"Create","href":"/api-reference/endpoints/create"},{"openapi":"get /endpoints/{id}","title":"Get","href":"/api-reference/endpoints/get"},{"openapi":"delete /endpoints/{id}","title":"Delete","href":"/api-reference/endpoints/delete"},{"openapi":"patch /endpoints/{id}","title":"Update","href":"/api-reference/endpoints/update"}]},{"group":"EventDestinations","pages":[{"openapi":"get /event_destinations","title":"List","href":"/api-reference/eventdestinations/list"},{"openapi":"post /event_destinations","title":"Create","href":"/api-reference/eventdestinations/create"},{"openapi":"get /event_destinations/{id}","title":"Get","href":"/api-reference/eventdestinations/get"},{"openapi":"delete /event_destinations/{id}","title":"Delete","href":"/api-reference/eventdestinations/delete"},{"openapi":"patch /event_destinations/{id}","title":"Update","href":"/api-reference/eventdestinations/update"}]},{"group":"EventSubscriptions","pages":[{"openapi":"get /event_subscriptions","title":"List","href":"/api-reference/eventsubscriptions/list"},{"openapi":"post /event_subscriptions","title":"Create","href":"/api-reference/eventsubscriptions/create"},{"openapi":"get /event_subscriptions/{id}","title":"Get","href":"/api-reference/eventsubscriptions/get"},{"openapi":"delete /event_subscriptions/{id}","title":"Delete","href":"/api-reference/eventsubscriptions/delete"},{"openapi":"patch /event_subscriptions/{id}","title":"Update","href":"/api-reference/eventsubscriptions/update"}]},{"group":"EventSources","pages":[{"openapi":"get /event_subscriptions/{subscription_id}/sources","title":"List","href":"/api-reference/eventsources/list"},{"openapi":"post /event_subscriptions/{subscription_id}/sources","title":"Create","href":"/api-reference/eventsources/create"},{"openapi":"get /event_subscriptions/{subscription_id}/sources/{type}","title":"Get","href":"/api-reference/eventsources/get"},{"openapi":"delete /event_subscriptions/{subscription_id}/sources/{type}","title":"Delete","href":"/api-reference/eventsources/delete"},{"openapi":"patch /event_subscriptions/{subscription_id}/sources/{type}","title":"Update","href":"/api-reference/eventsources/update"}]},{"group":"IPPolicies","pages":[{"openapi":"get /ip_policies","title":"List","href":"/api-reference/ippolicies/list"},{"openapi":"post /ip_policies","title":"Create","href":"/api-reference/ippolicies/create"},{"openapi":"get /ip_policies/{id}","title":"Get","href":"/api-reference/ippolicies/get"},{"openapi":"delete /ip_policies/{id}","title":"Delete","href":"/api-reference/ippolicies/delete"},{"openapi":"patch /ip_policies/{id}","title":"Update","href":"/api-reference/ippolicies/update"}]},{"group":"IPPolicyRules","pages":[{"openapi":"get /ip_policy_rules","title":"List","href":"/api-reference/ippolicyrules/list"},{"openapi":"post /ip_policy_rules","title":"Create","href":"/api-reference/ippolicyrules/create"},{"openapi":"get /ip_policy_rules/{id}","title":"Get","href":"/api-reference/ippolicyrules/get"},{"openapi":"delete /ip_policy_rules/{id}","title":"Delete","href":"/api-reference/ippolicyrules/delete"},{"openapi":"patch /ip_policy_rules/{id}","title":"Update","href":"/api-reference/ippolicyrules/update"}]},{"group":"IPRestrictions","pages":[{"openapi":"get /ip_restrictions","title":"List","href":"/api-reference/iprestrictions/list"},{"openapi":"post /ip_restrictions","title":"Create","href":"/api-reference/iprestrictions/create"},{"openapi":"get /ip_restrictions/{id}","title":"Get","href":"/api-reference/iprestrictions/get"},{"openapi":"delete /ip_restrictions/{id}","title":"Delete","href":"/api-reference/iprestrictions/delete"},{"openapi":"patch /ip_restrictions/{id}","title":"Update","href":"/api-reference/iprestrictions/update"}]},{"group":"ReservedAddrs","pages":[{"openapi":"get /reserved_addrs","title":"List","href":"/api-reference/reservedaddrs/list"},{"openapi":"post /reserved_addrs","title":"Create","href":"/api-reference/reservedaddrs/create"},{"openapi":"get /reserved_addrs/{id}","title":"Get","href":"/api-reference/reservedaddrs/get"},{"openapi":"delete /reserved_addrs/{id}","title":"Delete","href":"/api-reference/reservedaddrs/delete"},{"openapi":"patch /reserved_addrs/{id}","title":"Update","href":"/api-reference/reservedaddrs/update"}]},{"group":"ReservedDomains","pages":[{"openapi":"get /reserved_domains","title":"List","href":"/api-reference/reserveddomains/list"},{"openapi":"post /reserved_domains","title":"Create","href":"/api-reference/reserveddomains/create"},{"openapi":"get /reserved_domains/{id}","title":"Get","href":"/api-reference/reserveddomains/get"},{"openapi":"delete /reserved_domains/{id}","title":"Delete","href":"/api-reference/reserveddomains/delete"},{"openapi":"patch /reserved_domains/{id}","title":"Update","href":"/api-reference/reserveddomains/update"},{"openapi":"delete /reserved_domains/{id}/certificate","title":"DeleteCertificate","href":"/api-reference/reserveddomains/deletecertificate"},{"openapi":"delete /reserved_domains/{id}/certificate_management_policy","title":"DeleteCertificateManagementPolicy","href":"/api-reference/reserveddomains/deletecertificatemanagementpolicy"}]},{"group":"Secrets","pages":[{"openapi":"get /vault_secrets","title":"List","href":"/api-reference/secrets/list"},{"openapi":"post /vault_secrets","title":"Create","href":"/api-reference/secrets/create"},{"openapi":"get /vault_secrets/{id}","title":"Get","href":"/api-reference/secrets/get"},{"openapi":"delete /vault_secrets/{id}","title":"Delete","href":"/api-reference/secrets/delete"},{"openapi":"patch /vault_secrets/{id}","title":"Update","href":"/api-reference/secrets/update"}]},{"group":"ServiceUsers","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml get /service_users","href":"/api-reference/serviceusers/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml post /service_users","href":"/api-reference/serviceusers/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml get /service_users/{id}","href":"/api-reference/serviceusers/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml delete /service_users/{id}","href":"/api-reference/serviceusers/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml patch /service_users/{id}","href":"/api-reference/serviceusers/update"}]},{"group":"SSHCertificateAuthorities","pages":[{"openapi":"get /ssh_certificate_authorities","title":"List","href":"/api-reference/sshcertificateauthorities/list"},{"openapi":"post /ssh_certificate_authorities","title":"Create","href":"/api-reference/sshcertificateauthorities/create"},{"openapi":"get /ssh_certificate_authorities/{id}","title":"Get","href":"/api-reference/sshcertificateauthorities/get"},{"openapi":"delete /ssh_certificate_authorities/{id}","title":"Delete","href":"/api-reference/sshcertificateauthorities/delete"},{"openapi":"patch /ssh_certificate_authorities/{id}","title":"Update","href":"/api-reference/sshcertificateauthorities/update"}]},{"group":"SSHCredentials","pages":[{"openapi":"get /ssh_credentials","title":"List","href":"/api-reference/sshcredentials/list"},{"openapi":"post /ssh_credentials","title":"Create","href":"/api-reference/sshcredentials/create"},{"openapi":"get /ssh_credentials/{id}","title":"Get","href":"/api-reference/sshcredentials/get"},{"openapi":"delete /ssh_credentials/{id}","title":"Delete","href":"/api-reference/sshcredentials/delete"},{"openapi":"patch /ssh_credentials/{id}","title":"Update","href":"/api-reference/sshcredentials/update"}]},{"group":"SSHHostCertificates","pages":[{"openapi":"get /ssh_host_certificates","title":"List","href":"/api-reference/sshhostcertificates/list"},{"openapi":"post /ssh_host_certificates","title":"Create","href":"/api-reference/sshhostcertificates/create"},{"openapi":"get /ssh_host_certificates/{id}","title":"Get","href":"/api-reference/sshhostcertificates/get"},{"openapi":"delete /ssh_host_certificates/{id}","title":"Delete","href":"/api-reference/sshhostcertificates/delete"},{"openapi":"patch /ssh_host_certificates/{id}","title":"Update","href":"/api-reference/sshhostcertificates/update"}]},{"group":"SSHUserCertificates","pages":[{"openapi":"get /ssh_user_certificates","title":"List","href":"/api-reference/sshusercertificates/list"},{"openapi":"post /ssh_user_certificates","title":"Create","href":"/api-reference/sshusercertificates/create"},{"openapi":"get /ssh_user_certificates/{id}","title":"Get","href":"/api-reference/sshusercertificates/get"},{"openapi":"delete /ssh_user_certificates/{id}","title":"Delete","href":"/api-reference/sshusercertificates/delete"},{"openapi":"patch /ssh_user_certificates/{id}","title":"Update","href":"/api-reference/sshusercertificates/update"}]},{"group":"TLSCertificates","pages":[{"openapi":"get /tls_certificates","title":"List","href":"/api-reference/tlscertificates/list"},{"openapi":"post /tls_certificates","title":"Create","href":"/api-reference/tlscertificates/create"},{"openapi":"get /tls_certificates/{id}","title":"Get","href":"/api-reference/tlscertificates/get"},{"openapi":"delete /tls_certificates/{id}","title":"Delete","href":"/api-reference/tlscertificates/delete"},{"openapi":"patch /tls_certificates/{id}","title":"Update","href":"/api-reference/tlscertificates/update"}]},{"group":"Tunnels","pages":[{"openapi":"get /tunnels","title":"List","href":"/api-reference/tunnels/list"},{"openapi":"get /tunnels/{id}","title":"Get","href":"/api-reference/tunnels/get"}]},{"group":"Vaults","pages":[{"openapi":"get /vaults","title":"List","href":"/api-reference/vaults/list"},{"openapi":"post /vaults","title":"Create","href":"/api-reference/vaults/create"},{"openapi":"get /vaults/{id}","title":"Get","href":"/api-reference/vaults/get"},{"openapi":"delete /vaults/{id}","title":"Delete","href":"/api-reference/vaults/delete"},{"openapi":"patch /vaults/{id}","title":"Update","href":"/api-reference/vaults/update"},{"title":"GetSecretsByVault","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml get /vaults/{id}/secrets","href":"/api-reference/vaults/getsecretsbyvault"}]}]},{"item":"Agent API","pages":[{"title":"Agent API","href":"/gateway/agent/api"}]},{"item":"Agent CLI","pages":[{"title":"Agent CLI","href":"/gateway/agent/cli"}]},{"item":"Agent Config File","pages":[{"title":"Agent Config File","href":"/gateway/agent/config"}]},{"item":"Agent SDKs","pages":[{"title":"Agent SDKs","href":"/agent-sdks"}]},{"item":"Errors","pages":[{"title":"Errors","href":"/errors"}]},{"item":"Changelogs","pages":[{"title":"Changelogs","href":"/gateway/agent/changelog"}]}]},{"tab":"Pricing","pages":[{"title":"Pricing","href":"/pricing-limits"}]},{"tab":"About","pages":[{"title":"About","href":"/about"}]}]},"title":"Create - ngrok documentation","buildId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","deploymentId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bg4Z7D_G.js","utils-Biz734EK.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6F9YHs6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BoJjY_VP.js","snippetPresets-CnZ-mOFh.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-DC_SB2pp.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BYKtOiIP.js","shallow-COAac_UD.js","getApiPlaygroundDisplay-BV4Viqi2.js","CodeSnippet-DDgW-JXl.js","CodeSnippets-CP1LpNhG.js","Page-BeiUfucV.js","getPastedJson-Cvgvbfmv.js","icon-D-H368xH.js","MethodPill-CXSxH1VW.js","DuplicateIcon-JcbBzF1x.js","createIcon-BDt_aHZM.js","DynamicMarkdown-DO1Fz7ar.js","SectionHeading-mwKBArs3.js","axios-vUo_bRtp.js","Markdown-C3KUTGJN.js","clsx-C6CAjViH.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C3vb5JQZ.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C8Hisf3g.js"]}