Responses are generated using AI and may contain mistakes.
Altostrat Studio — AI agents for the full support loop. Investigate, coordinate, take approved action, and carry cases through to resolution. Build your support workflow →
Find generated OpenAPI reference material for public Altostrat SDX endpoints.
The API Reference tab contains generated endpoint documentation for teams that automate SDX outside the portal. The public base URL is:
https://v1.api.altostrat.io
Use the product documentation first when you are learning how SDX features behave. Use the generated API groups when you already know the workflow you want to automate and need endpoint names, request shapes, response fields, and authentication details.
Use the paths exactly as shown in this reference. Several SDX services are mounted behind gateway prefixes such as /api, /workflows, /vpn, /content, /metrics, /reports, and /scripts.
Confirm the portal workflow manually before automating it.
Use API keys only for integrations that need server-to-server access.
Store credentials in a secret manager or the SDX vault where appropriate.
Prefer the narrowest role and team access that lets the integration do its job.
Test automation in a non-critical team or site before you run it across production.
This reference focuses on APIs that customers encounter in the portal or use for product automation. Internal service-to-service endpoints, local development endpoints, health checks, and backend-only token exchange routes are intentionally omitted.
API keys and workflow vault secrets can grant powerful access. Treat them like production credentials, rotate them when ownership changes, and remove unused keys.
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Altostrat Documentation","colors":{"primary":"#000","light":"#3b82f6","dark":"#020202"},"logo":{"light":"https://mintcdn.com/altostratnetworks/gNgwhxQB0wwttrp4/images/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=gNgwhxQB0wwttrp4\u0026q=85\u0026s=c6ee38df580d221dfbcc33f44899a660","dark":"https://mintcdn.com/altostratnetworks/gNgwhxQB0wwttrp4/images/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=gNgwhxQB0wwttrp4\u0026q=85\u0026s=fdc9045af46b82d2cc05990ef496c7b5","href":"https://altostrat.io"},"favicon":"https://mintcdn.com/altostratnetworks/Vau7ES3tLFIjStVL/favicon.png?fit=max\u0026auto=format\u0026n=Vau7ES3tLFIjStVL\u0026q=85\u0026s=66dd174203df59a98c151f52161b8e1f","navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://sdx.altostrat.app"}},"seo":{"metatags":{"og:image":"/images/logo/og-img.png","og:type":"website","og:site_name":"Altostrat Docs"},"indexing":"all"},"fonts":{"family":"Figtree"},"icons":{"library":"lucide"},"integrations":{"amplitude":{"apiKey":"248e98b21af4dc5177ebd8cf4acc7b09"},"fathom":{"siteId":"TXYDMOUB"},"gtm":{"tagId":"G-MGJMEY2SW2"}},"banner":{"content":"**Altostrat Studio** — AI agents for the full support loop. Investigate, coordinate, take approved action, and carry cases through to resolution. [Build your support workflow →](/studio/en/support-loop)","dismissible":true},"contextual":{"options":["copy"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"altostratnetworks","hasAudioNarration":false,"actualSubdomain":"altostratnetworks","customDomains":["altostrat.io"],"gitSource":{"type":"github","owner":"altostrat","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ade8610757645e9e4c92bed","collectionId":"79a16ee8-bea3-4b8e-8bb6-a2a2c11c3dea","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ade8610757645e9e4c92bed"},"feedback":{"thumbs":true,"issues":true,"edits":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae66d720339475b5aaad2b3","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"SDX","count":438},{"language":"default","tag":"API Reference","count":413},{"language":"default","tag":"Radius","count":169},{"language":"default","tag":"Documentation","count":150},{"language":"default","tag":"Workflows","count":95},{"language":"default","tag":"Device Management \u0026 Orchestration","count":95},{"language":"default","tag":"Automation \u0026 AI","count":90},{"language":"default","tag":"Radius API","count":78},{"language":"default","tag":"Studio","count":74},{"language":"default","tag":"Network Services \u0026 Connectivity","count":58}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"h1,h2,h3,h4{font-weight:600!important}.codeblock-dark div:not(:last-child){color:#fafafa}#footer{display:none}"}],"page":{"pagePath":"api/en/introduction","slug":"/api/en/introduction","pageMetadata":{"title":"API Reference","description":"Find generated OpenAPI reference material for public Altostrat SDX endpoints.","mode":"wide","href":"/api/en/introduction"},"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: \"Find generated OpenAPI reference material for public Altostrat SDX endpoints.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The API Reference tab contains generated endpoint documentation for teams that automate SDX outside the portal. The public base URL is:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://v1.api.altostrat.io`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`Use the product documentation first when you are learning how SDX features behave. Use the generated API groups when you already know the workflow you want to automate and need endpoint names, request shapes, response fields, and authentication details.`}),`\n`,_jsx(Heading,{level:`2`,id:`before-you-build`,children:`Before You Build`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Use the paths exactly as shown in this reference. Several SDX services are mounted behind gateway prefixes such as `,_jsx(_components.code,{children:`/api`}),`, `,_jsx(_components.code,{children:`/workflows`}),`, `,_jsx(_components.code,{children:`/vpn`}),`, `,_jsx(_components.code,{children:`/content`}),`, `,_jsx(_components.code,{children:`/metrics`}),`, `,_jsx(_components.code,{children:`/reports`}),`, and `,_jsx(_components.code,{children:`/scripts`}),`.`]}),`\n`,_jsx(_components.li,{children:`Confirm the portal workflow manually before automating it.`}),`\n`,_jsx(_components.li,{children:`Use API keys only for integrations that need server-to-server access.`}),`\n`,_jsx(_components.li,{children:`Store credentials in a secret manager or the SDX vault where appropriate.`}),`\n`,_jsx(_components.li,{children:`Prefer the narrowest role and team access that lets the integration do its job.`}),`\n`,_jsx(_components.li,{children:`Test automation in a non-critical team or site before you run it across production.`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`what-is-included`,children:`What Is Included`}),`\n`,_jsx(_components.p,{children:`This reference focuses on APIs that customers encounter in the portal or use for product automation. Internal service-to-service endpoints, local development endpoints, health checks, and backend-only token exchange routes are intentionally omitted.`}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`API keys and workflow vault secrets can grant powerful access. Treat them like production credentials, rotate them when ownership changes, and remove unused keys.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API Reference","description":"Find generated OpenAPI reference material for public Altostrat SDX endpoints.","mode":"wide","href":"/api/en/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Before You Build","slug":"before-you-build","depth":2,"children":[]},{"title":"What Is Included","slug":"what-is-included","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/altostratnetworks/257ff86c6de7ea65/scripts/generate-api-docs.js","/docs/_mintlify/custom/altostratnetworks/21e62138b19d2dae/scripts/translate-api-docs.js"],"subdomain":"altostratnetworks","siteName":"Altostrat Documentation","title":"API Reference - Altostrat Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-22T01:27:37.752Z","originalFileLocation":"api/en/introduction.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=\"Find generated OpenAPI reference material for public Altostrat SDX endpoints.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Altostrat 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/altostratnetworks/upr7PCH0FDkIqVup/_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/altostratnetworks/upr7PCH0FDkIqVup/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/altostratnetworks/upr7PCH0FDkIqVup/_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/altostratnetworks/upr7PCH0FDkIqVup/_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/altostratnetworks/upr7PCH0FDkIqVup/_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/altostratnetworks/upr7PCH0FDkIqVup/_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/altostratnetworks/upr7PCH0FDkIqVup/_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/altostratnetworks/upr7PCH0FDkIqVup/_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/altostratnetworks/upr7PCH0FDkIqVup/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Reference - Altostrat Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Find generated OpenAPI reference material for public Altostrat SDX endpoints.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Altostrat Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://altostrat.io/docs/api/en/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://altostratnetworks.mintlify.app/images/logo/og-img.png\">\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=\"API Reference - Altostrat Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Find generated OpenAPI reference material for public Altostrat SDX endpoints.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://altostratnetworks.mintlify.app/images/logo/og-img.png\">\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/altostratnetworks/upr7PCH0FDkIqVup/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Altostrat Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://altostrat.io/docs/api/en/introduction\">\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/en/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://altostrat.io/#organization\",\"name\":\"Altostrat Documentation\",\"url\":\"https://altostrat.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/altostratnetworks/gNgwhxQB0wwttrp4/images/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=gNgwhxQB0wwttrp4\u0026q=85\u0026s=c6ee38df580d221dfbcc33f44899a660\"}},{\"@type\":\"WebSite\",\"@id\":\"https://altostrat.io/docs#website\",\"name\":\"Altostrat Documentation\",\"url\":\"https://altostrat.io/docs\",\"publisher\":{\"@id\":\"https://altostrat.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://altostrat.io/docs/api/en/introduction#webpage\",\"url\":\"https://altostrat.io/docs/api/en/introduction\",\"name\":\"API Reference\",\"description\":\"Find generated OpenAPI reference material for public Altostrat SDX endpoints.\",\"dateModified\":\"2026-04-22T01:27:37.752Z\",\"isPartOf\":{\"@id\":\"https://altostrat.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://altostrat.io/docs/api/en/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://altostrat.io/docs/api/en/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Altostrat Documentation\",\"item\":\"https://altostrat.io/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://altostrat.io/docs/api/en/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://altostrat.io/docs/api/en/introduction#article\",\"headline\":\"API Reference\",\"name\":\"API Reference\",\"description\":\"Find generated OpenAPI reference material for public Altostrat SDX endpoints.\",\"url\":\"https://altostrat.io/docs/api/en/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://altostrat.io/docs/api/en/introduction#webpage\"},\"image\":\"https://altostrat.io/images/logo/og-img.png\",\"dateModified\":\"2026-04-22T01:27:37.752Z\",\"publisher\":{\"@id\":\"https://altostrat.io/#organization\"},\"isPartOf\":{\"@id\":\"https://altostrat.io/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Altostrat Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Altostrat Documentation","nav":{"global":null,"products":[{"product":"Studio","icon":"sparkles","description":"AI agents for the full support loop.","pages":[{"title":"Studio","href":"/studio/en/welcome"}]},{"product":"Radius","icon":"radio-tower","description":"Managed RADIUS, RadSec, identity, policy, and network access control.","pages":[{"title":"Radius","href":"/radius/en/introduction"}]},{"product":"SDX","icon":"router","description":"Operate MikroTik fleets with Altostrat SDX.","tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/sdx/en/getting-started/introduction"}]},{"tab":"Changelog","icon":"history","pages":[{"title":"Changelog","href":"/sdx/en/changelog/overview"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Getting Started","icon":"rocket","expanded":true,"pages":[{"title":"API Reference","mode":"wide","href":"/api/en/introduction"}]},{"group":"Platform \u0026 Identity","icon":"shield-check","expanded":false,"pages":[{"group":"Workspaces","pages":[{"group":"Workspaces","pages":[{"title":"List workspaces","description":"Returns a list of workspaces the authenticated user is a member of.","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces","href":"/api/en/workspaces/list-workspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml post /workspaces","href":"/api/en/workspaces/create-a-workspace"},{"title":"Retrieve a workspace","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}","href":"/api/en/workspaces/retrieve-a-workspace"},{"title":"Archive a workspace","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml delete /workspaces/{workspaceId}","href":"/api/en/workspaces/archive-a-workspace"},{"title":"Update a workspace","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml patch /workspaces/{workspaceId}","href":"/api/en/workspaces/update-a-workspace"}]},{"group":"Workspace Members","pages":[{"title":"List workspace members","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/members","href":"/api/en/workspace-members/list-workspace-members"},{"title":"Add a member to a workspace","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml post /workspaces/{workspaceId}/members","href":"/api/en/workspace-members/add-a-member-to-a-workspace"},{"title":"Remove a member from a workspace","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml delete /workspaces/{workspaceId}/members/{memberId}","href":"/api/en/workspace-members/remove-a-member-from-a-workspace"},{"title":"Update a member's role","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml patch /workspaces/{workspaceId}/members/{memberId}","href":"/api/en/workspace-members/update-a-members-role"}]},{"group":"Organizations","pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/organizations","href":"/api/en/organizations/list-organizations"},{"title":"Create an organization","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml post /workspaces/{workspaceId}/organizations","href":"/api/en/organizations/create-an-organization"},{"title":"Retrieve an organization","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/organizations/{organizationId}","href":"/api/en/organizations/retrieve-an-organization"},{"title":"Delete an organization","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml delete /workspaces/{workspaceId}/organizations/{organizationId}","href":"/api/en/organizations/delete-an-organization"},{"title":"Update an organization","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml patch /workspaces/{workspaceId}/organizations/{organizationId}","href":"/api/en/organizations/update-an-organization"},{"title":"List child organizations","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/organizations/{organizationId}/children","href":"/api/en/organizations/list-child-organizations"},{"title":"Create a child organization","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml post /workspaces/{workspaceId}/organizations/{organizationId}/children","href":"/api/en/organizations/create-a-child-organization"},{"title":"Retrieve parent organization","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/organizations/{organizationId}/parent","href":"/api/en/organizations/retrieve-parent-organization"},{"title":"List all descendant organizations","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/organizations/{organizationId}/descendants","href":"/api/en/organizations/list-all-descendant-organizations"},{"title":"Retrieve organization limits","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/organizations/{organizationId}/limits","href":"/api/en/organizations/retrieve-organization-limits"},{"title":"Export organization usage as CSV","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/organizations/usage.csv","href":"/api/en/organizations/export-organization-usage-as-csv"},{"title":"Export organization usage as PDF","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/organizations/usage.pdf","href":"/api/en/organizations/export-organization-usage-as-pdf"}]},{"group":"Billing Accounts","pages":[{"title":"List billing accounts","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/billing-accounts","href":"/api/en/billing-accounts/list-billing-accounts"},{"title":"Create a billing account","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml post /workspaces/{workspaceId}/billing-accounts","href":"/api/en/billing-accounts/create-a-billing-account"},{"title":"Retrieve a billing account","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/billing-accounts/{billingAccountId}","href":"/api/en/billing-accounts/retrieve-a-billing-account"},{"title":"Delete a billing account","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml delete /workspaces/{workspaceId}/billing-accounts/{billingAccountId}","href":"/api/en/billing-accounts/delete-a-billing-account"},{"title":"Update a billing account","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml patch /workspaces/{workspaceId}/billing-accounts/{billingAccountId}","href":"/api/en/billing-accounts/update-a-billing-account"}]},{"group":"Subscriptions","pages":[{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/billing-accounts/{billingAccountId}/subscriptions","href":"/api/en/subscriptions/list-subscriptions"},{"title":"Create a subscription","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml post /workspaces/{workspaceId}/billing-accounts/{billingAccountId}/subscriptions","href":"/api/en/subscriptions/create-a-subscription"},{"title":"Retrieve a subscription","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/billing-accounts/{billingAccountId}/subscriptions/{subscriptionId}","href":"/api/en/subscriptions/retrieve-a-subscription"},{"title":"Cancel a subscription","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml delete /workspaces/{workspaceId}/billing-accounts/{billingAccountId}/subscriptions/{subscriptionId}","href":"/api/en/subscriptions/cancel-a-subscription"},{"title":"Update a subscription","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml patch /workspaces/{workspaceId}/billing-accounts/{billingAccountId}/subscriptions/{subscriptionId}","href":"/api/en/subscriptions/update-a-subscription"},{"title":"Check trial eligibility","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/billing-accounts/{billingAccountId}/trial-eligibility","href":"/api/en/subscriptions/check-trial-eligibility"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/billing-accounts/{billingAccountId}/invoices","href":"/api/en/invoices/list-invoices"},{"title":"Preview an invoice","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml post /workspaces/{workspaceId}/billing-accounts/{billingAccountId}/invoices/preview","href":"/api/en/invoices/preview-an-invoice"}]},{"group":"Payment Methods","pages":[{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /workspaces/{workspaceId}/billing-accounts/{billingAccountId}/payment-methods","href":"/api/en/payment-methods/list-payment-methods"},{"title":"Create a Setup Intent","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml post /workspaces/{workspaceId}/billing-accounts/{billingAccountId}/payment-methods","href":"/api/en/payment-methods/create-a-setup-intent"},{"title":"Set default payment method","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml put /workspaces/{workspaceId}/billing-accounts/{billingAccountId}/payment-methods/{paymentMethodId}","href":"/api/en/payment-methods/set-default-payment-method"},{"title":"Detach a payment method","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml delete /workspaces/{workspaceId}/billing-accounts/{billingAccountId}/payment-methods/{paymentMethodId}","href":"/api/en/payment-methods/detach-a-payment-method"}]},{"group":"Public","pages":[{"title":"Resolve login hint","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /organizations/resolve/{login_hint}","href":"/api/en/public/resolve-login-hint"},{"title":"Get public branding information","deprecated":null,"version":null,"openapi":"/api/en/workspaces.yaml get /organizations/{id}/branding","href":"/api/en/public/get-public-branding-information"}]}]},{"group":"API Keys","pages":[{"group":"API Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/api/en/api-keys.yaml get /api/keys","href":"/api/en/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/api/en/api-keys.yaml post /api/keys","href":"/api/en/api-keys/create-an-api-key"},{"title":"Retrieve an API key","deprecated":null,"version":null,"openapi":"/api/en/api-keys.yaml get /api/keys/{id}","href":"/api/en/api-keys/retrieve-an-api-key"},{"title":"Delete an API key","deprecated":null,"version":null,"openapi":"/api/en/api-keys.yaml delete /api/keys/{id}","href":"/api/en/api-keys/delete-an-api-key"},{"title":"Rotate an API key secret","deprecated":null,"version":null,"openapi":"/api/en/api-keys.yaml post /api/keys/{id}/rotate","href":"/api/en/api-keys/rotate-an-api-key-secret"}]}]},{"group":"Authentication","pages":[{"group":"Discovery","pages":[{"title":"OIDC Discovery Endpoint","deprecated":null,"version":null,"openapi":"/api/en/authentication.yaml get /.well-known/openid-configuration","href":"/api/en/discovery/oidc-discovery-endpoint"},{"title":"JSON Web Key Set (JWKS) Endpoint","deprecated":null,"version":null,"openapi":"/api/en/authentication.yaml get /.well-known/jwks.json","href":"/api/en/discovery/json-web-key-set-jwks-endpoint"}]},{"group":"OAuth 2.0 \u0026 OIDC","pages":[{"title":"Initiate User Authentication","deprecated":null,"version":null,"openapi":"/api/en/authentication.yaml get /authorize","href":"/api/en/oauth-20-\u0026-oidc/initiate-user-authentication"},{"title":"Exchange Code or Refresh Token for Tokens","deprecated":null,"version":null,"openapi":"/api/en/authentication.yaml post /oauth/token","href":"/api/en/oauth-20-\u0026-oidc/exchange-code-or-refresh-token-for-tokens"},{"title":"Get User Profile","deprecated":null,"version":null,"openapi":"/api/en/authentication.yaml get /userinfo","href":"/api/en/oauth-20-\u0026-oidc/get-user-profile"},{"title":"Revoke Token","deprecated":null,"version":null,"openapi":"/api/en/authentication.yaml post /oauth/revoke","href":"/api/en/oauth-20-\u0026-oidc/revoke-token"},{"title":"Log Out User (OIDC Compliant)","deprecated":null,"version":null,"openapi":"/api/en/authentication.yaml get /oidc/logout","href":"/api/en/oauth-20-\u0026-oidc/log-out-user-oidc-compliant"},{"title":"Log Out User (Legacy)","deprecated":null,"version":null,"openapi":"/api/en/authentication.yaml get /v2/logout","href":"/api/en/oauth-20-\u0026-oidc/log-out-user-legacy"}]}]},{"group":"Audit Logs","pages":[{"group":"Audit Logs","pages":[{"title":"List audit log events","deprecated":null,"version":null,"openapi":"/api/en/audit-logs.yaml get /audit-logs","href":"/api/en/audit-logs/list-audit-log-events"}]}]}]},{"group":"Device Management \u0026 Orchestration","icon":"router","expanded":false,"pages":[{"group":"MikroTik Devices","pages":[{"group":"Sites","pages":[{"title":"List Sites","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml get /sites","href":"/api/en/sites/list-sites"},{"title":"List Sites (Minimal)","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml get /sites/minimal","href":"/api/en/sites/list-sites-minimal"},{"title":"List Recent Sites","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml get /sites/recent","href":"/api/en/sites/list-recent-sites"},{"title":"Retrieve a Site","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml get /sites/{siteId}","href":"/api/en/sites/retrieve-a-site"},{"title":"Delete a Site","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml delete /sites/{siteId}","href":"/api/en/sites/delete-a-site"},{"title":"Update a Site","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml patch /sites/{siteId}","href":"/api/en/sites/update-a-site"}]},{"group":"Jobs","pages":[{"title":"List Jobs for a Site","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml get /site/{siteId}/job","href":"/api/en/jobs/list-jobs-for-a-site"},{"title":"Create a Job for a Site","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml post /site/{siteId}/job","href":"/api/en/jobs/create-a-job-for-a-site"},{"title":"Retrieve a Job","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml get /site/{siteId}/job/{jobId}","href":"/api/en/jobs/retrieve-a-job"},{"title":"Cancel a Pending Job","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml delete /site/{siteId}/job/{jobId}","href":"/api/en/jobs/cancel-a-pending-job"}]},{"group":"Device Stats","pages":[{"title":"Retrieve Site Stats Over a Date Range","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml get /sites/{siteId}/mikrotik-stats","href":"/api/en/device-stats/retrieve-site-stats-over-a-date-range"}]},{"group":"Runbooks","pages":[{"title":"Retrieve a Runbook","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml get /runbooks/{runbookId}","href":"/api/en/runbooks/retrieve-a-runbook"}]},{"group":"Developer API","pages":[{"title":"Run a synchronous RouterOS command","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml post /api/synchronous/{siteId}","href":"/api/en/developer-api/run-a-synchronous-routeros-command"},{"title":"Queue an asynchronous RouterOS script","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml post /api/asynchronous/{siteId}","href":"/api/en/developer-api/queue-an-asynchronous-routeros-script"}]},{"group":"Developer Routers","pages":[{"title":"List developer API routers","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml get /api/routers","href":"/api/en/developer-routers/list-developer-api-routers"},{"title":"Get router metadata","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml get /api/routers/{siteId}/metadata","href":"/api/en/developer-routers/get-router-metadata"},{"title":"Get router metrics summary","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml get /api/routers/{siteId}/metrics","href":"/api/en/developer-routers/get-router-metrics-summary"},{"title":"List router faults","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml get /api/routers/{siteId}/faults","href":"/api/en/developer-routers/list-router-faults"},{"title":"List router jobs","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml get /api/routers/{siteId}/jobs","href":"/api/en/developer-routers/list-router-jobs"},{"title":"Get router OEM data","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-api.yaml get /api/routers/{siteId}/oem","href":"/api/en/developer-routers/get-router-oem-data"}]}]},{"group":"Control Plane","pages":[{"group":"Policies","pages":[{"title":"List all policies","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml get /control-plane/policies","href":"/api/en/policies/list-all-policies"},{"title":"Create a policy","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml post /control-plane/policies","href":"/api/en/policies/create-a-policy"},{"title":"Retrieve a policy","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml get /control-plane/policies/{policyId}","href":"/api/en/policies/retrieve-a-policy"},{"title":"Update a policy","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml put /control-plane/policies/{policyId}","href":"/api/en/policies/update-a-policy"},{"title":"Delete a policy","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml delete /control-plane/policies/{policyId}","href":"/api/en/policies/delete-a-policy"}]},{"group":"Transient Access","pages":[{"title":"List transient accesses for a site","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml get /control-plane/{siteId}/transient-accesses","href":"/api/en/transient-access/list-transient-accesses-for-a-site"},{"title":"Create a transient access session","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml post /control-plane/{siteId}/transient-accesses","href":"/api/en/transient-access/create-a-transient-access-session"},{"title":"Retrieve a transient access session","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml get /control-plane/{siteId}/transient-accesses/{accessId}","href":"/api/en/transient-access/retrieve-a-transient-access-session"},{"title":"Revoke a transient access session","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml delete /control-plane/{siteId}/transient-accesses/{accessId}","href":"/api/en/transient-access/revoke-a-transient-access-session"}]},{"group":"Transient Port Forwarding","pages":[{"title":"List transient port forwards for a site","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml get /control-plane/{siteId}/transient-forward","href":"/api/en/transient-port-forwarding/list-transient-port-forwards-for-a-site"},{"title":"Create a transient port forward","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml post /control-plane/{siteId}/transient-forward","href":"/api/en/transient-port-forwarding/create-a-transient-port-forward"},{"title":"Retrieve a transient port forward","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml get /control-plane/{siteId}/transient-forward/{forwardId}","href":"/api/en/transient-port-forwarding/retrieve-a-transient-port-forward"},{"title":"Revoke a transient port forward","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml delete /control-plane/{siteId}/transient-forward/{forwardId}","href":"/api/en/transient-port-forwarding/revoke-a-transient-port-forward"}]},{"group":"Site Operations","pages":[{"title":"Get API credentials for a site","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml get /control-plane/{siteId}/credentials","href":"/api/en/site-operations/get-api-credentials-for-a-site"},{"title":"Rotate API credentials for a site","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml post /control-plane/{siteId}/credentials","href":"/api/en/site-operations/rotate-api-credentials-for-a-site"},{"title":"Get management server for a site","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml get /control-plane/{siteId}/management-server","href":"/api/en/site-operations/get-management-server-for-a-site"},{"title":"Perform an action on a site","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml post /control-plane/{siteId}/action","href":"/api/en/site-operations/perform-an-action-on-a-site"},{"title":"Resend bootstrap scheduler","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml post /control-plane/{siteId}/resend-scheduler","href":"/api/en/site-operations/resend-bootstrap-scheduler"}]},{"group":"Site Notes","pages":[{"title":"Get site note","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml get /control-plane/{siteId}/note","href":"/api/en/site-notes/get-site-note"},{"title":"Update site note","deprecated":null,"version":null,"openapi":"/api/en/control-plane.yaml post /control-plane/{siteId}/note","href":"/api/en/site-notes/update-site-note"}]}]},{"group":"Backups","pages":[{"group":"Backups","pages":[{"title":"List Backups for a Site","deprecated":null,"version":null,"openapi":"/api/en/backups.yaml get /backup/{siteId}","href":"/api/en/backups/list-backups-for-a-site"},{"title":"Request a New Backup","deprecated":null,"version":null,"openapi":"/api/en/backups.yaml post /backup/{siteId}","href":"/api/en/backups/request-a-new-backup"},{"title":"Retrieve a Specific Backup","deprecated":null,"version":null,"openapi":"/api/en/backups.yaml get /backup/{siteId}/{filename}","href":"/api/en/backups/retrieve-a-specific-backup"},{"title":"List discovered site subnets","deprecated":null,"version":null,"openapi":"/api/en/backups.yaml get /backup/{siteId}/subnets","href":"/api/en/backups/list-discovered-site-subnets"}]}]},{"group":"Scripts","pages":[{"group":"Scheduled Scripts","pages":[{"title":"List Scheduled Scripts","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml get /scripts/scheduled","href":"/api/en/scheduled-scripts/list-scheduled-scripts"},{"title":"Schedule a New Script","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml post /scripts/scheduled","href":"/api/en/scheduled-scripts/schedule-a-new-script"},{"title":"Retrieve a Scheduled Script","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml get /scripts/scheduled/{scheduledScriptId}","href":"/api/en/scheduled-scripts/retrieve-a-scheduled-script"},{"title":"Update a Scheduled Script","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml put /scripts/scheduled/{scheduledScriptId}","href":"/api/en/scheduled-scripts/update-a-scheduled-script"},{"title":"Cancel or Delete a Scheduled Script","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml delete /scripts/scheduled/{scheduledScriptId}","href":"/api/en/scheduled-scripts/cancel-or-delete-a-scheduled-script"},{"title":"Run a Test Execution","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml put /scripts/scheduled/{scheduledScriptId}/run-test","href":"/api/en/scheduled-scripts/run-a-test-execution"},{"title":"Immediately Run a Scheduled Script","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml put /scripts/scheduled/{scheduledScriptId}/run","href":"/api/en/scheduled-scripts/immediately-run-a-scheduled-script"},{"title":"Get Execution Progress","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml get /scripts/scheduled/{scheduledScriptId}/progress","href":"/api/en/scheduled-scripts/get-execution-progress"},{"title":"Request Script Authorization","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml get /scripts/scheduled/{scheduledScriptId}/authorize","href":"/api/en/scheduled-scripts/request-script-authorization"}]},{"group":"Script Templates","pages":[{"title":"List Script Templates","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml get /scripts/templates","href":"/api/en/script-templates/list-script-templates"},{"title":"Create a Script Template","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml post /scripts/templates","href":"/api/en/script-templates/create-a-script-template"},{"title":"Retrieve a Script Template","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml get /scripts/templates/{templateId}","href":"/api/en/script-templates/retrieve-a-script-template"},{"title":"Update a Script Template","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml put /scripts/templates/{templateId}","href":"/api/en/script-templates/update-a-script-template"},{"title":"Delete a Script Template","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml delete /scripts/templates/{templateId}","href":"/api/en/script-templates/delete-a-script-template"}]},{"group":"Community Scripts","pages":[{"title":"List Community Scripts","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml get /scripts/community-scripts","href":"/api/en/community-scripts/list-community-scripts"},{"title":"Submit a Community Script","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml post /scripts/community-scripts","href":"/api/en/community-scripts/submit-a-community-script"},{"title":"Retrieve a Community Script","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml get /scripts/community-scripts/{communityScriptId}","href":"/api/en/community-scripts/retrieve-a-community-script"},{"title":"Get Raw Script Content","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml get /scripts/community-scripts/{communityScriptId}.rsc","href":"/api/en/community-scripts/get-raw-script-content"},{"title":"Get Raw README Content","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml get /scripts/community-scripts/{communityScriptId}.md","href":"/api/en/community-scripts/get-raw-readme-content"}]},{"group":"AI Script Generation","pages":[{"title":"Generate Script from Prompt","deprecated":null,"version":null,"openapi":"/api/en/scripts.yaml post /scripts/gen-ai","href":"/api/en/ai-script-generation/generate-script-from-prompt"}]}]},{"group":"Schedules","pages":[{"group":"Schedules","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/api/en/schedules.yaml get /chrono/schedules","href":"/api/en/schedules/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/api/en/schedules.yaml post /chrono/schedules","href":"/api/en/schedules/create-a-new-schedule"},{"title":"Retrieve a schedule","deprecated":null,"version":null,"openapi":"/api/en/schedules.yaml get /chrono/schedules/{scheduleId}","href":"/api/en/schedules/retrieve-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/api/en/schedules.yaml put /chrono/schedules/{scheduleId}","href":"/api/en/schedules/update-a-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/api/en/schedules.yaml delete /chrono/schedules/{scheduleId}","href":"/api/en/schedules/delete-a-schedule"}]}]},{"group":"Metadata","pages":[{"group":"Tags","pages":[{"title":"List all tag definitions","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml get /tags","href":"/api/en/tags/list-all-tag-definitions"},{"title":"Create a tag definition","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml post /tags","href":"/api/en/tags/create-a-tag-definition"},{"title":"Retrieve a tag definition","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml get /tags/{tagId}","href":"/api/en/tags/retrieve-a-tag-definition"},{"title":"Update a tag definition","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml put /tags/{tagId}","href":"/api/en/tags/update-a-tag-definition"},{"title":"Delete a tag definition","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml delete /tags/{tagId}","href":"/api/en/tags/delete-a-tag-definition"}]},{"group":"Tag Values","pages":[{"title":"List unique values for a tag","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml get /tags/{tagId}/values","href":"/api/en/tag-values/list-unique-values-for-a-tag"},{"title":"Apply a tag to a resource","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml post /tags/{tagId}/values","href":"/api/en/tag-values/apply-a-tag-to-a-resource"},{"title":"Update a tag on a resource","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml put /tags/{tagId}/values/{correlationId}","href":"/api/en/tag-values/update-a-tag-on-a-resource"},{"title":"Remove a tag from a resource","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml delete /tags/{tagId}/values/{correlationId}","href":"/api/en/tag-values/remove-a-tag-from-a-resource"},{"title":"Find resources by tag value","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml get /tags/{tagId}/resources","href":"/api/en/tag-values/find-resources-by-tag-value"},{"title":"List tags for a resource","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml get /resources/{correlationId}/tags","href":"/api/en/tag-values/list-tags-for-a-resource"}]},{"group":"Metadata","pages":[{"title":"List all metadata objects","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml get /metadata","href":"/api/en/metadata/list-all-metadata-objects"},{"title":"Create a metadata object","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml post /metadata","href":"/api/en/metadata/create-a-metadata-object"},{"title":"Retrieve a metadata object","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml get /metadata/{resourceId}","href":"/api/en/metadata/retrieve-a-metadata-object"},{"title":"Update a metadata object","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml put /metadata/{resourceId}","href":"/api/en/metadata/update-a-metadata-object"},{"title":"Delete a metadata object","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml delete /metadata/{resourceId}","href":"/api/en/metadata/delete-a-metadata-object"}]},{"group":"Site Files","pages":[{"title":"List site notes","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml get /metadata/{siteId}/notes","href":"/api/en/site-files/list-site-notes"},{"title":"Create a site note","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml post /metadata/{siteId}/notes","href":"/api/en/site-files/create-a-site-note"},{"title":"Get site note content","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml get /metadata/{siteId}/notes/{noteId}","href":"/api/en/site-files/get-site-note-content"},{"title":"Delete a site note","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml delete /metadata/{siteId}/notes/{noteId}","href":"/api/en/site-files/delete-a-site-note"},{"title":"Get media upload URL","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml post /metadata/{siteId}/media","href":"/api/en/site-files/get-media-upload-url"},{"title":"Download a media file","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml get /metadata/{siteId}/media/{mediaId}","href":"/api/en/site-files/download-a-media-file"},{"title":"Delete a media file","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml delete /metadata/{siteId}/media/{mediaId}","href":"/api/en/site-files/delete-a-media-file"},{"title":"Get document upload URL","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml post /metadata/{siteId}/documents","href":"/api/en/site-files/get-document-upload-url"},{"title":"Download a document file","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml get /metadata/{siteId}/documents/{documentId}","href":"/api/en/site-files/download-a-document-file"},{"title":"Delete a document file","deprecated":null,"version":null,"openapi":"/api/en/metadata.yaml delete /metadata/{siteId}/documents/{documentId}","href":"/api/en/site-files/delete-a-document-file"}]}]}]},{"group":"Automation \u0026 AI","icon":"sparkles","expanded":false,"pages":[{"group":"Workflows","pages":[{"group":"Workflows","pages":[{"title":"List all workflows","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml get /workflows","href":"/api/en/workflows/list-all-workflows"},{"title":"Create a new workflow","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml post /workflows","href":"/api/en/workflows/create-a-new-workflow"},{"title":"Retrieve a workflow","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml get /workflows/{workflowId}","href":"/api/en/workflows/retrieve-a-workflow"},{"title":"Update a workflow","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml put /workflows/{workflowId}","href":"/api/en/workflows/update-a-workflow"},{"title":"Delete a workflow","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml delete /workflows/{workflowId}","href":"/api/en/workflows/delete-a-workflow"},{"title":"Execute a synchronous workflow","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml post /workflows/sync/{workflowId}","href":"/api/en/workflows/execute-a-synchronous-workflow"},{"title":"List triggerable workflows","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml get /workflows/triggerable-workflows","href":"/api/en/workflows/list-triggerable-workflows"},{"title":"Validate a workflow definition","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml post /workflows/validate","href":"/api/en/workflows/validate-a-workflow-definition"}]},{"group":"Workflow Runs","pages":[{"title":"Execute a workflow","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml post /workflows/{workflowId}/execute","href":"/api/en/workflow-runs/execute-a-workflow"},{"title":"List workflow runs","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml get /workflows/{workflowId}/executions","href":"/api/en/workflow-runs/list-workflow-runs"},{"title":"Retrieve a workflow run","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml get /workflows/runs/{runId}","href":"/api/en/workflow-runs/retrieve-a-workflow-run"},{"title":"Re-run a workflow","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml post /workflows/runs/{runId}/rerun","href":"/api/en/workflow-runs/re-run-a-workflow"},{"title":"Resume a failed workflow","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml post /workflows/runs/{runId}/resume-from/{nodeId}","href":"/api/en/workflow-runs/resume-a-failed-workflow"}]},{"group":"Webhooks","pages":[{"title":"Trigger a workflow via webhook","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml post /workflows/webhooks/{webhookToken}","href":"/api/en/webhooks/trigger-a-workflow-via-webhook"}]},{"group":"Utilities","pages":[{"title":"Test a single node","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml post /workflows/test-node","href":"/api/en/utilities/test-a-single-node"},{"title":"List available node types","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml get /workflows/node-types","href":"/api/en/utilities/list-available-node-types"}]},{"group":"Vault","pages":[{"title":"List vault items","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml get /workflows/vault","href":"/api/en/vault/list-vault-items"},{"title":"Create a vault item","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml post /workflows/vault","href":"/api/en/vault/create-a-vault-item"},{"title":"Retrieve a vault item","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml get /workflows/vault/{vaultId}","href":"/api/en/vault/retrieve-a-vault-item"},{"title":"Update a vault item","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml put /workflows/vault/{vaultId}","href":"/api/en/vault/update-a-vault-item"},{"title":"Delete a vault item","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml delete /workflows/vault/{vaultId}","href":"/api/en/vault/delete-a-vault-item"}]},{"group":"Workflow Logs","pages":[{"title":"List workflow logs","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml get /workflows/{workflowId}/logs","href":"/api/en/workflow-logs/list-workflow-logs"},{"title":"Get workflow log statistics","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml get /workflows/{workflowId}/logs/stats","href":"/api/en/workflow-logs/get-workflow-log-statistics"},{"title":"List recent workflow logs","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml get /workflows/logs/recent","href":"/api/en/workflow-logs/list-recent-workflow-logs"}]},{"group":"Authorizations","pages":[{"title":"List workflow authorizations","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml get /workflows/authorization","href":"/api/en/authorizations/list-workflow-authorizations"},{"title":"Create a workflow authorization URL","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml post /workflows/authorization","href":"/api/en/authorizations/create-a-workflow-authorization-url"},{"title":"Delete a workflow authorization","deprecated":null,"version":null,"openapi":"/api/en/workflows.yaml delete /workflows/authorization/{authId}","href":"/api/en/authorizations/delete-a-workflow-authorization"}]}]}]},{"group":"Network Services \u0026 Connectivity","icon":"globe","expanded":false,"pages":[{"group":"WAN Failover","pages":[{"group":"Failover Service","pages":[{"title":"List Sites with Failover Service","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml get /failover/service-counts","href":"/api/en/failover-service/list-sites-with-failover-service"},{"title":"Get Failover Service Status","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml get /failover/{site_id}/configs","href":"/api/en/failover-service/get-failover-service-status"},{"title":"Activate Failover Service","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml post /failover/{site_id}/configs","href":"/api/en/failover-service/activate-failover-service"},{"title":"Deactivate Failover Service","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml delete /failover/{site_id}/configs/{subscription_id}","href":"/api/en/failover-service/deactivate-failover-service"}]},{"group":"WAN Tunnels","pages":[{"title":"Update Tunnel Priorities","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml post /wan/{site_id}/failover/priorities","href":"/api/en/wan-tunnels/update-tunnel-priorities"},{"title":"List Tunnels for a Site","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml get /failover/{site_id}/tunnels","href":"/api/en/wan-tunnels/list-tunnels-for-a-site"},{"title":"Add a new WAN Tunnel","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml post /failover/{site_id}/tunnels","href":"/api/en/wan-tunnels/add-a-new-wan-tunnel"},{"title":"List Tunnels for a Site","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml get /wan/{site_id}/tunnel","href":"/api/en/wan-tunnels/list-tunnels-for-a-site-1"},{"title":"Add a new WAN Tunnel","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml post /wan/{site_id}/tunnel","href":"/api/en/wan-tunnels/add-a-new-wan-tunnel-1"},{"title":"Get a Specific Tunnel","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml get /failover/{site_id}/tunnels/{tunnel_id}","href":"/api/en/wan-tunnels/get-a-specific-tunnel"},{"title":"Configure a WAN Tunnel","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml put /failover/{site_id}/tunnels/{tunnel_id}","href":"/api/en/wan-tunnels/configure-a-wan-tunnel"},{"title":"Delete a WAN Tunnel","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml delete /failover/{site_id}/tunnels/{tunnel_id}","href":"/api/en/wan-tunnels/delete-a-wan-tunnel"},{"title":"List WAN tunnels across accessible sites","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml get /wan/tunnels","href":"/api/en/wan-tunnels/list-wan-tunnels-across-accessible-sites"},{"title":"List WAN tunnels across accessible sites","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml get /failover/tunnels","href":"/api/en/wan-tunnels/list-wan-tunnels-across-accessible-sites-1"}]},{"group":"Helper Endpoints","pages":[{"title":"List Router Interfaces","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml get /wan/{site_id}/tunnel/interfaces","href":"/api/en/helper-endpoints/list-router-interfaces"},{"title":"Look up Eligible Gateways","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml post /wan/{site_id}/tunnel/gateways","href":"/api/en/helper-endpoints/look-up-eligible-gateways"},{"title":"List Router Interfaces for Failover","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml get /failover/{site_id}/interfaces","href":"/api/en/helper-endpoints/list-router-interfaces-for-failover"},{"title":"Look up Eligible Gateways for Failover","deprecated":null,"version":null,"openapi":"/api/en/wan-failover.yaml post /failover/{site_id}/gateways","href":"/api/en/helper-endpoints/look-up-eligible-gateways-for-failover"}]}]},{"group":"Managed VPN","pages":[{"group":"Instances","pages":[{"title":"List all VPN instances","deprecated":null,"version":null,"openapi":"/api/en/managed-vpn.yaml get /vpn/instances","href":"/api/en/instances/list-all-vpn-instances"},{"title":"Create a VPN instance","deprecated":null,"version":null,"openapi":"/api/en/managed-vpn.yaml post /vpn/instances","href":"/api/en/instances/create-a-vpn-instance"},{"title":"Retrieve a VPN instance","deprecated":null,"version":null,"openapi":"/api/en/managed-vpn.yaml get /vpn/instances/{instanceId}","href":"/api/en/instances/retrieve-a-vpn-instance"},{"title":"Update a VPN instance","deprecated":null,"version":null,"openapi":"/api/en/managed-vpn.yaml put /vpn/instances/{instanceId}","href":"/api/en/instances/update-a-vpn-instance"},{"title":"Delete a VPN instance","deprecated":null,"version":null,"openapi":"/api/en/managed-vpn.yaml delete /vpn/instances/{instanceId}","href":"/api/en/instances/delete-a-vpn-instance"},{"title":"Retrieve instance bandwidth","deprecated":null,"version":null,"openapi":"/api/en/managed-vpn.yaml get /vpn/instances/{instanceId}/bandwidth","href":"/api/en/instances/retrieve-instance-bandwidth"}]},{"group":"Peers","pages":[{"title":"List all peers for an instance","deprecated":null,"version":null,"openapi":"/api/en/managed-vpn.yaml get /vpn/instances/{instanceId}/peers","href":"/api/en/peers/list-all-peers-for-an-instance"},{"title":"Create a peer","deprecated":null,"version":null,"openapi":"/api/en/managed-vpn.yaml post /vpn/instances/{instanceId}/peers","href":"/api/en/peers/create-a-peer"},{"title":"Retrieve a peer","deprecated":null,"version":null,"openapi":"/api/en/managed-vpn.yaml get /vpn/instances/{instanceId}/peers/{peerId}","href":"/api/en/peers/retrieve-a-peer"},{"title":"Update a peer","deprecated":null,"version":null,"openapi":"/api/en/managed-vpn.yaml put /vpn/instances/{instanceId}/peers/{peerId}","href":"/api/en/peers/update-a-peer"},{"title":"Delete a peer","deprecated":null,"version":null,"openapi":"/api/en/managed-vpn.yaml delete /vpn/instances/{instanceId}/peers/{peerId}","href":"/api/en/peers/delete-a-peer"}]},{"group":"Utilities","pages":[{"title":"List available server regions","deprecated":null,"version":null,"openapi":"/api/en/managed-vpn.yaml get /vpn/servers/regions","href":"/api/en/utilities/list-available-server-regions"},{"title":"List subnets for a site","deprecated":null,"version":null,"openapi":"/api/en/managed-vpn.yaml get /vpn/site/{siteId}/subnets","href":"/api/en/utilities/list-subnets-for-a-site"}]},{"group":"Client Configuration","pages":[{"title":"Fetch a VPN client configuration","deprecated":null,"version":null,"openapi":"/api/en/managed-vpn.yaml get /vpn/client","href":"/api/en/client-configuration/fetch-a-vpn-client-configuration"}]}]},{"group":"Captive Portal","pages":[{"group":"Captive Portal Instances","pages":[{"title":"List all captive portal instances","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml get /captive/instances","href":"/api/en/captive-portal-instances/list-all-captive-portal-instances"},{"title":"Create a captive portal instance","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml post /captive/instances","href":"/api/en/captive-portal-instances/create-a-captive-portal-instance"},{"title":"Retrieve a captive portal instance","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml get /captive/instances/{instanceId}","href":"/api/en/captive-portal-instances/retrieve-a-captive-portal-instance"},{"title":"Update a captive portal instance","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml put /captive/instances/{instanceId}","href":"/api/en/captive-portal-instances/update-a-captive-portal-instance"},{"title":"Delete a captive portal instance","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml delete /captive/instances/{instanceId}","href":"/api/en/captive-portal-instances/delete-a-captive-portal-instance"},{"title":"Upload an instance image","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml post /captive/instances/{instanceId}/images/{type}","href":"/api/en/captive-portal-instances/upload-an-instance-image"}]},{"group":"Coupons","pages":[{"title":"List valid coupons for an instance","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml get /captive/instances/{instanceId}/coupons","href":"/api/en/coupons/list-valid-coupons-for-an-instance"},{"title":"Create coupons","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml post /captive/instances/{instanceId}/coupons","href":"/api/en/coupons/create-coupons"}]},{"group":"Coupon Schedules","pages":[{"title":"List coupon schedules","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml get /captive/instances/{instanceId}/coupon-schedules","href":"/api/en/coupon-schedules/list-coupon-schedules"},{"title":"Create a coupon schedule","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml post /captive/instances/{instanceId}/coupon-schedules","href":"/api/en/coupon-schedules/create-a-coupon-schedule"},{"title":"Retrieve a coupon schedule","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml get /captive/instances/{instanceId}/coupon-schedules/{scheduleId}","href":"/api/en/coupon-schedules/retrieve-a-coupon-schedule"},{"title":"Update a coupon schedule","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml put /captive/instances/{instanceId}/coupon-schedules/{scheduleId}","href":"/api/en/coupon-schedules/update-a-coupon-schedule"},{"title":"Delete a coupon schedule","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml delete /captive/instances/{instanceId}/coupon-schedules/{scheduleId}","href":"/api/en/coupon-schedules/delete-a-coupon-schedule"},{"title":"Run a coupon schedule now","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml post /captive/instances/{instanceId}/coupon-schedules/{scheduleId}/run","href":"/api/en/coupon-schedules/run-a-coupon-schedule-now"},{"title":"Generate a signed coupon URL","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml get /captive/instances/{instanceId}/coupon-schedules/{scheduleId}/generate_url","href":"/api/en/coupon-schedules/generate-a-signed-coupon-url"}]},{"group":"Auth Integrations","pages":[{"title":"List all auth integrations","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml get /captive/auth-integrations","href":"/api/en/auth-integrations/list-all-auth-integrations"},{"title":"Create an auth integration","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml post /captive/auth-integrations","href":"/api/en/auth-integrations/create-an-auth-integration"},{"title":"Retrieve an auth integration","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml get /captive/auth-integrations/{authIntegrationId}","href":"/api/en/auth-integrations/retrieve-an-auth-integration"},{"title":"Update an auth integration","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml put /captive/auth-integrations/{authIntegrationId}","href":"/api/en/auth-integrations/update-an-auth-integration"},{"title":"Delete an auth integration","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml delete /captive/auth-integrations/{authIntegrationId}","href":"/api/en/auth-integrations/delete-an-auth-integration"}]},{"group":"Walled Garden","pages":[{"title":"List walled garden entries for a site","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml get /captive/walled-garden/{siteId}","href":"/api/en/walled-garden/list-walled-garden-entries-for-a-site"},{"title":"Create a walled garden entry","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml post /captive/walled-garden/{siteId}","href":"/api/en/walled-garden/create-a-walled-garden-entry"},{"title":"Retrieve a walled garden entry","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml get /captive/walled-garden/{siteId}/{walledGardenEntryId}","href":"/api/en/walled-garden/retrieve-a-walled-garden-entry"},{"title":"Update a walled garden entry","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml put /captive/walled-garden/{siteId}/{walledGardenEntryId}","href":"/api/en/walled-garden/update-a-walled-garden-entry"},{"title":"Delete a walled garden entry","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml delete /captive/walled-garden/{siteId}/{walledGardenEntryId}","href":"/api/en/walled-garden/delete-a-walled-garden-entry"}]},{"group":"Public Coupon URLs","pages":[{"title":"Retrieve coupons from a signed URL","deprecated":null,"version":null,"openapi":"/api/en/captive-portal.yaml get /captive/coupons","href":"/api/en/public-coupon-urls/retrieve-coupons-from-a-signed-url"}]}]}]},{"group":"Security \u0026 Threat Management","icon":"lock","expanded":false,"pages":[{"group":"UTM \u0026 IPS","pages":[{"group":"DNS Content Filtering","pages":[{"title":"List DNS Content Filtering Policies","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml get /content/policy","href":"/api/en/dns-content-filtering/list-dns-content-filtering-policies"},{"title":"Create a DNS Content Filtering Policy","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml post /content/policy","href":"/api/en/dns-content-filtering/create-a-dns-content-filtering-policy"},{"title":"Retrieve a DNS Policy","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml get /content/policy/{policyId}","href":"/api/en/dns-content-filtering/retrieve-a-dns-policy"},{"title":"Update a DNS Policy","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml put /content/policy/{policyId}","href":"/api/en/dns-content-filtering/update-a-dns-policy"},{"title":"Delete a DNS Policy","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml delete /content/policy/{policyId}","href":"/api/en/dns-content-filtering/delete-a-dns-policy"},{"title":"List Application Categories","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml get /content/category","href":"/api/en/dns-content-filtering/list-application-categories"},{"title":"List Safe Search Services","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml get /content/category/safe_search","href":"/api/en/dns-content-filtering/list-safe-search-services"}]},{"group":"BGP Threat Intelligence","pages":[{"title":"List BGP Threat Intelligence Policies","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml get /content/bgp/policy","href":"/api/en/bgp-threat-intelligence/list-bgp-threat-intelligence-policies"},{"title":"Create a BGP Threat Intelligence Policy","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml post /content/bgp/policy","href":"/api/en/bgp-threat-intelligence/create-a-bgp-threat-intelligence-policy"},{"title":"Retrieve a BGP Policy","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml get /content/bgp/policy/{policyId}","href":"/api/en/bgp-threat-intelligence/retrieve-a-bgp-policy"},{"title":"Update a BGP Policy","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml put /content/bgp/policy/{policyId}","href":"/api/en/bgp-threat-intelligence/update-a-bgp-policy"},{"title":"Delete a BGP Policy","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml delete /content/bgp/policy/{policyId}","href":"/api/en/bgp-threat-intelligence/delete-a-bgp-policy"},{"title":"List BGP IP Reputation Lists","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml get /content/bgp/category","href":"/api/en/bgp-threat-intelligence/list-bgp-ip-reputation-lists"}]},{"group":"Site Security Configuration","pages":[{"title":"List All Site Security Configurations","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml get /content/tunnel","href":"/api/en/site-security-configuration/list-all-site-security-configurations"},{"title":"Retrieve a Site's Security Configuration","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml get /content/tunnel/{siteId}","href":"/api/en/site-security-configuration/retrieve-a-sites-security-configuration"},{"title":"Attach DNS Policy to a Site","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml post /content/{siteId}","href":"/api/en/site-security-configuration/attach-dns-policy-to-a-site"},{"title":"Detach DNS Policy from a Site","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml delete /content/{siteId}","href":"/api/en/site-security-configuration/detach-dns-policy-from-a-site"},{"title":"Attach BGP Policy to a Site","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml post /content/bgp/{siteId}","href":"/api/en/site-security-configuration/attach-bgp-policy-to-a-site"},{"title":"Detach BGP Policy from a Site","deprecated":null,"version":null,"openapi":"/api/en/utm-ips.yaml delete /content/bgp/{siteId}","href":"/api/en/site-security-configuration/detach-bgp-policy-from-a-site"}]}]},{"group":"Security Groups","pages":[{"group":"Security Groups","pages":[{"title":"List security groups","deprecated":null,"version":null,"openapi":"/api/en/security-groups.yaml get /vpc/security-groups","href":"/api/en/security-groups/list-security-groups"},{"title":"Create a security group","deprecated":null,"version":null,"openapi":"/api/en/security-groups.yaml post /vpc/security-groups","href":"/api/en/security-groups/create-a-security-group"},{"title":"Retrieve a security group","deprecated":null,"version":null,"openapi":"/api/en/security-groups.yaml get /vpc/security-groups/{securityGroupId}","href":"/api/en/security-groups/retrieve-a-security-group"},{"title":"Update a security group","deprecated":null,"version":null,"openapi":"/api/en/security-groups.yaml put /vpc/security-groups/{securityGroupId}","href":"/api/en/security-groups/update-a-security-group"},{"title":"Delete a security group","deprecated":null,"version":null,"openapi":"/api/en/security-groups.yaml delete /vpc/security-groups/{securityGroupId}","href":"/api/en/security-groups/delete-a-security-group"}]},{"group":"Prefix Lists","pages":[{"title":"List prefix lists","deprecated":null,"version":null,"openapi":"/api/en/security-groups.yaml get /vpc/prefix-lists","href":"/api/en/prefix-lists/list-prefix-lists"},{"title":"Create a prefix list","deprecated":null,"version":null,"openapi":"/api/en/security-groups.yaml post /vpc/prefix-lists","href":"/api/en/prefix-lists/create-a-prefix-list"},{"title":"Retrieve a prefix list","deprecated":null,"version":null,"openapi":"/api/en/security-groups.yaml get /vpc/prefix-lists/{prefixListId}","href":"/api/en/prefix-lists/retrieve-a-prefix-list"},{"title":"Update a prefix list","deprecated":null,"version":null,"openapi":"/api/en/security-groups.yaml put /vpc/prefix-lists/{prefixListId}","href":"/api/en/prefix-lists/update-a-prefix-list"},{"title":"Delete a prefix list","deprecated":null,"version":null,"openapi":"/api/en/security-groups.yaml delete /vpc/prefix-lists/{prefixListId}","href":"/api/en/prefix-lists/delete-a-prefix-list"}]},{"group":"Reference Data","pages":[{"title":"List supported protocols","deprecated":null,"version":null,"openapi":"/api/en/security-groups.yaml get /vpc/reference/protocols","href":"/api/en/reference-data/list-supported-protocols"},{"title":"List common services","deprecated":null,"version":null,"openapi":"/api/en/security-groups.yaml get /vpc/reference/services","href":"/api/en/reference-data/list-common-services"}]}]},{"group":"Vulnerability Scans","pages":[{"group":"Scan Schedules","pages":[{"title":"List Scan Schedules","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml get /scans/cve/scheduled","href":"/api/en/scan-schedules/list-scan-schedules"},{"title":"Create Scan Schedule","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml post /scans/cve/scheduled","href":"/api/en/scan-schedules/create-scan-schedule"},{"title":"Retrieve a Scan Schedule","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml get /scans/cve/scheduled/{scanScheduleId}","href":"/api/en/scan-schedules/retrieve-a-scan-schedule"},{"title":"Update a Scan Schedule","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml put /scans/cve/scheduled/{scanScheduleId}","href":"/api/en/scan-schedules/update-a-scan-schedule"},{"title":"Delete a Scan Schedule","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml delete /scans/cve/scheduled/{scanScheduleId}","href":"/api/en/scan-schedules/delete-a-scan-schedule"}]},{"group":"Scan Execution","pages":[{"title":"Start a Scan","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml post /scans/cve/scheduled/{scanScheduleId}/invoke","href":"/api/en/scan-execution/start-a-scan"},{"title":"Stop a Scan","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml delete /scans/cve/scheduled/{scanScheduleId}/invoke","href":"/api/en/scan-execution/stop-a-scan"},{"title":"Start On-Demand Single-IP Scan","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml post /scans/cve/scheduled/single-ip","href":"/api/en/scan-execution/start-on-demand-single-ip-scan"},{"title":"Start On-Demand Multi-IP Scan","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml post /scans/cve/scan/multiple-ips","href":"/api/en/scan-execution/start-on-demand-multi-ip-scan"}]},{"group":"Scan Results","pages":[{"title":"List Scan Reports","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml get /scans/cve","href":"/api/en/scan-results/list-scan-reports"},{"title":"Retrieve a Scan Report","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml get /scans/cve/{scan_id}","href":"/api/en/scan-results/retrieve-a-scan-report"},{"title":"Get Latest Scan Status","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml get /scans/cve/{scanScheduleId}/status","href":"/api/en/scan-results/get-latest-scan-status"}]},{"group":"Vulnerability Intelligence","pages":[{"title":"Get CVEs by MAC Address","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml post /scans/cve/mac-address/cves","href":"/api/en/vulnerability-intelligence/get-cves-by-mac-address"},{"title":"List All Scanned MAC Addresses","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml get /scans/cve/mac-address/cve/list","href":"/api/en/vulnerability-intelligence/list-all-scanned-mac-addresses"},{"title":"Get Mitigation Steps","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml get /scans/cve/mitigation/{cve_id}","href":"/api/en/vulnerability-intelligence/get-mitigation-steps"}]},{"group":"Vulnerability Management","pages":[{"title":"List CVE Statuses","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml get /scans/cve/mac-address/cve/status","href":"/api/en/vulnerability-management/list-cve-statuses"},{"title":"Update CVE Status","deprecated":null,"version":null,"openapi":"/api/en/cve-scans.yaml post /scans/cve/mac-address/cve/status","href":"/api/en/vulnerability-management/update-cve-status"}]}]}]},{"group":"Monitoring \u0026 Analytics","icon":"chart-bar","expanded":false,"pages":[{"group":"Monitoring \u0026 Metrics","pages":[{"group":"Dashboard","pages":[{"title":"Get Network Throughput","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml get /metrics/dashboard/throughput","href":"/api/en/dashboard/get-network-throughput"},{"title":"Get Data Transferred Volume","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml get /metrics/dashboard/data-transferred","href":"/api/en/dashboard/get-data-transferred-volume"}]},{"group":"WAN Tunnels \u0026 Performance","pages":[{"title":"List Site WAN Tunnels","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml get /metrics/wan-tunnels/{siteId}","href":"/api/en/wan-tunnels-\u0026-performance/list-site-wan-tunnels"},{"title":"Get Aggregated Ping Statistics","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml post /metrics/wan/ping-stats","href":"/api/en/wan-tunnels-\u0026-performance/get-aggregated-ping-statistics"},{"title":"Get WAN tunnel ping statistics","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml post /metrics/wan-tunnels/{tunnelId}/ping-stats","href":"/api/en/wan-tunnels-\u0026-performance/get-wan-tunnel-ping-statistics"}]},{"group":"Site Interfaces \u0026 Metrics","pages":[{"title":"List Site Interfaces","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml get /metrics/interfaces/{siteId}","href":"/api/en/site-interfaces-\u0026-metrics/list-site-interfaces"},{"title":"Get Interface Metrics","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml post /metrics/interfaces/{interfaceId}/metrics","href":"/api/en/site-interfaces-\u0026-metrics/get-interface-metrics"}]},{"group":"Device Health \u0026 Status","pages":[{"title":"Get Recent Device Health Stats","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml get /metrics/mikrotik-stats-all/{siteId}","href":"/api/en/device-health-\u0026-status/get-recent-device-health-stats"},{"title":"Get Device Heartbeat History","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml get /metrics/mikrotik-stats/{siteId}","href":"/api/en/device-health-\u0026-status/get-device-heartbeat-history"},{"title":"Get Last Seen Time","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml get /metrics/last-seen/{siteId}","href":"/api/en/device-health-\u0026-status/get-last-seen-time"}]},{"group":"ARP Inventory","pages":[{"title":"Search ARP Entries","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml post /metrics/arps","href":"/api/en/arp-inventory/search-arp-entries"},{"title":"Update ARP Entry","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml put /metrics/arps/{siteId}/{arpEntryId}","href":"/api/en/arp-inventory/update-arp-entry"}]},{"group":"Network Logs","pages":[{"title":"Get Site Syslog Entries","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml get /metrics/syslogs/{siteId}","href":"/api/en/network-logs/get-site-syslog-entries"},{"title":"Get BGP Security Report","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml get /metrics/bgp-report/{siteId}","href":"/api/en/network-logs/get-bgp-security-report"},{"title":"Get DNS Security Report","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml get /metrics/dns-report/{siteId}","href":"/api/en/network-logs/get-dns-security-report"}]},{"group":"Grafana Dashboards","pages":[{"title":"List dashboards","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml get /metrics/dashboards","href":"/api/en/grafana-dashboards/list-dashboards"},{"title":"List dashboards in a folder","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml get /metrics/dashboards/{folderName}","href":"/api/en/grafana-dashboards/list-dashboards-in-a-folder"},{"title":"Query a dashboard","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml post /metrics/dashboards/{dashboardUid}/query","href":"/api/en/grafana-dashboards/query-a-dashboard"},{"title":"Export dashboard panel CSV","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml post /metrics/dashboards/{dashboardUid}/panels/{panelId}/export","href":"/api/en/grafana-dashboards/export-dashboard-panel-csv"}]},{"group":"Prometheus Querying","pages":[{"title":"List metric names","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml get /metrics/metrics","href":"/api/en/prometheus-querying/list-metric-names"},{"title":"List metric labels","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml get /metrics/labels","href":"/api/en/prometheus-querying/list-metric-labels"},{"title":"List label values","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml get /metrics/labels/{labelName}/values","href":"/api/en/prometheus-querying/list-label-values"},{"title":"Execute a Prometheus query","deprecated":null,"version":null,"openapi":"/api/en/monitoring-metrics.yaml post /metrics/query","href":"/api/en/prometheus-querying/execute-a-prometheus-query"}]}]},{"group":"Faults \u0026 Events","pages":[{"group":"Faults","pages":[{"title":"List all faults","deprecated":null,"version":null,"openapi":"/api/en/faults.yaml get /fault","href":"/api/en/faults/list-all-faults"},{"title":"Create a fault","deprecated":null,"version":null,"openapi":"/api/en/faults.yaml post /fault","href":"/api/en/faults/create-a-fault"},{"title":"Retrieve a fault","deprecated":null,"version":null,"openapi":"/api/en/faults.yaml get /fault/{faultId}","href":"/api/en/faults/retrieve-a-fault"},{"title":"Update a fault","deprecated":null,"version":null,"openapi":"/api/en/faults.yaml put /fault/{faultId}","href":"/api/en/faults/update-a-fault"},{"title":"Delete a fault","deprecated":null,"version":null,"openapi":"/api/en/faults.yaml delete /fault/{faultId}","href":"/api/en/faults/delete-a-fault"}]},{"group":"Comments","pages":[{"title":"Add a comment to a fault","deprecated":null,"version":null,"openapi":"/api/en/faults.yaml post /fault/{faultId}/comment","href":"/api/en/comments/add-a-comment-to-a-fault"}]},{"group":"Analytics","pages":[{"title":"Get top faulty resources","deprecated":null,"version":null,"openapi":"/api/en/faults.yaml get /fault/top_faults","href":"/api/en/analytics/get-top-faulty-resources"},{"title":"List faults from the last seven days","deprecated":null,"version":null,"openapi":"/api/en/faults.yaml get /fault/last-7-days","href":"/api/en/analytics/list-faults-from-the-last-seven-days"}]},{"group":"Access Tokens","pages":[{"title":"Generate a temporary access token","deprecated":null,"version":null,"openapi":"/api/en/faults.yaml post /fault/token","href":"/api/en/access-tokens/generate-a-temporary-access-token"},{"title":"Read a shared health dashboard","deprecated":null,"version":null,"openapi":"/api/en/faults.yaml get /fault/token/{id}","href":"/api/en/access-tokens/read-a-shared-health-dashboard"}]}]},{"group":"Reports","pages":[{"group":"SLA Report Schedules","pages":[{"title":"List SLA Report Schedules","deprecated":null,"version":null,"openapi":"/api/en/reports.yaml get /reports/sla/schedules","href":"/api/en/sla-report-schedules/list-sla-report-schedules"},{"title":"Create SLA Report Schedule","deprecated":null,"version":null,"openapi":"/api/en/reports.yaml post /reports/sla/schedules","href":"/api/en/sla-report-schedules/create-sla-report-schedule"},{"title":"Retrieve a Report Schedule","deprecated":null,"version":null,"openapi":"/api/en/reports.yaml get /reports/sla/schedules/{scheduleId}","href":"/api/en/sla-report-schedules/retrieve-a-report-schedule"},{"title":"Update a Report Schedule","deprecated":null,"version":null,"openapi":"/api/en/reports.yaml put /reports/sla/schedules/{scheduleId}","href":"/api/en/sla-report-schedules/update-a-report-schedule"},{"title":"Delete a Report Schedule","deprecated":null,"version":null,"openapi":"/api/en/reports.yaml delete /reports/sla/schedules/{scheduleId}","href":"/api/en/sla-report-schedules/delete-a-report-schedule"},{"title":"Run a Report On-Demand","deprecated":null,"version":null,"openapi":"/api/en/reports.yaml post /reports/sla/schedules/{scheduleId}/run","href":"/api/en/sla-report-schedules/run-a-report-on-demand"}]},{"group":"Generated Reports","pages":[{"title":"List Generated Reports","deprecated":null,"version":null,"openapi":"/api/en/reports.yaml get /reports/sla/reports","href":"/api/en/generated-reports/list-generated-reports"},{"title":"Delete a Generated Report","deprecated":null,"version":null,"openapi":"/api/en/reports.yaml delete /reports/sla/reports/{reportId}","href":"/api/en/generated-reports/delete-a-generated-report"}]}]},{"group":"Notifications","pages":[{"group":"Notification Groups","pages":[{"title":"List Notification Groups","deprecated":null,"version":null,"openapi":"/api/en/notifications.yaml get /notifications","href":"/api/en/notification-groups/list-notification-groups"},{"title":"Create a Notification Group","deprecated":null,"version":null,"openapi":"/api/en/notifications.yaml post /notifications","href":"/api/en/notification-groups/create-a-notification-group"},{"title":"Retrieve a Notification Group","deprecated":null,"version":null,"openapi":"/api/en/notifications.yaml get /notifications/{groupId}","href":"/api/en/notification-groups/retrieve-a-notification-group"},{"title":"Update a Notification Group","deprecated":null,"version":null,"openapi":"/api/en/notifications.yaml put /notifications/{groupId}","href":"/api/en/notification-groups/update-a-notification-group"},{"title":"Delete a Notification Group","deprecated":null,"version":null,"openapi":"/api/en/notifications.yaml delete /notifications/{groupId}","href":"/api/en/notification-groups/delete-a-notification-group"}]},{"group":"Topics","pages":[{"title":"List Available Topics","deprecated":null,"version":null,"openapi":"/api/en/notifications.yaml get /notifications/topics","href":"/api/en/topics/list-available-topics"}]}]}]},{"group":"Core Services \u0026 Utilities","icon":"server","expanded":false,"pages":[{"group":"Search","pages":[{"group":"Entity Search","pages":[{"title":"Search for Platform Entities","deprecated":null,"version":null,"openapi":"/api/en/search.yaml get /search","href":"/api/en/entity-search/search-for-platform-entities"}]},{"group":"Documentation Search","pages":[{"title":"Search Altostrat Documentation","deprecated":null,"version":null,"openapi":"/api/en/search.yaml get /search/docs","href":"/api/en/documentation-search/search-altostrat-documentation"}]}]},{"group":"MikroTik OEM Data","pages":[{"group":"Products","pages":[{"title":"List Products","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-oem-data.yaml get /oem/products","href":"/api/en/products/list-products"},{"title":"Retrieve a Product","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-oem-data.yaml get /oem/product/{slug}","href":"/api/en/products/retrieve-a-product"}]},{"group":"Resellers","pages":[{"title":"List Resellers","deprecated":null,"version":null,"openapi":"/api/en/mikrotik-oem-data.yaml get /oem/mikrotik-resellers","href":"/api/en/resellers/list-resellers"}]}]}]}]}]}]},"basePath":"","title":"API Reference - Altostrat Documentation","buildId":"dpl_6cCEiK8XNNvaLBBkWzcBhdE9QfLC","deploymentId":"dpl_6cCEiK8XNNvaLBBkWzcBhdE9QfLC","dynamics":["10e4515597"],"chunks":["BannerMarkdown-CGuHEvQW.js","dist-B66mVNPp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-BcghKhHb.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js"]}