The OrbitLab API gives programmatic access to everything you manage in the dashboard: services and deployments, environment variables, logs and metrics, domains and DNS, databases, files, WordPress tools, organizations, orders and renewals. The CLI is built on it.Browse every endpoint in the API reference section of the sidebar.
Base URL
https://orbitlab.dev/api/v1
Requests and responses use JSON unless an endpoint says otherwise (logs are text/plain, invoices are PDF, uploads use multipart/form-data).
Authentication
Authenticate with an API token in the Authorization header:
Copy the token. It starts with olab_ and is only shown once.
orbitlab login creates a token for the CLI the same way, after you approve it in the browser. Tokens created by the CLI expire after 90 days.A token acts with your permissions: it can do what your role allows in each organization. OrbitLab only stores a hash of the token. Revoke tokens you no longer use from the same page, or with DELETE /v1/tokens/{id}. Tokens stop working immediately when revoked, when they expire, or when you leave the organization they’re scoped to.
Treat tokens like passwords: store them in your CI’s secret store, never in your repository.
Dashboard-only actions
For security, some actions require signing in to the dashboard and can’t be done with a token: creating tokens, deleting your account, unlinking sign-in methods and installing the GitHub App.
Organizations
Resources belong to organizations. Requests act on your first organization unless you choose another with the X-OrbitLab-Org header (organization id or slug):
Tokens scoped to one organization always act on it; selecting another organization returns 403. List your organizations with GET /v1/organizations.Some endpoints require the owner or admin role, for example reading environment variables and database credentials, editing DNS, or managing members. The API reference lists the role for each endpoint.
Conventions
Ids are UUIDs, except plan ids (app-1, starter…) and DNS record ids.
Amounts are integers in cents, with a currency.
Dates are ISO 8601 strings in UTC.
Collections are returned whole under a named key, for example { "services": [...] }.
Errors
Errors return an HTTP status and a JSON body with an error message:
{ "error": "Service not found" }
Status
Meaning
400
Invalid request. Validation errors may return error as an object of field messages.
401
Missing, invalid or expired token.
403
Your role or token doesn’t allow this action in the organization.
404
The resource doesn’t exist in the selected organization.
409
Conflict, for example a domain already attached elsewhere.
429
Too many requests. Wait for the number of seconds in the Retry-After header.
502
The hosting platform couldn’t complete the operation; retry later.
Idempotent checkout
POST /v1/checkout creates an order and starts a payment. Send a unique Idempotency-Key header so a retried request returns the same order instead of creating another one.
A payment request is sent to the phone. Poll GET /v1/orders/{orderId} until the order is paid. Card payments are currently unavailable; free orders need no phone number.
Device login for your own tools
Tools that can’t store a token ahead of time can use the same device login as the CLI:
POST /v1/auth/device with {"clientName": "my-tool"} returns deviceCode, userCode and verificationUriComplete.
Show the user the code and the link. They approve the request in the dashboard.
Poll POST /v1/auth/device/token with {"deviceCode": "…"} every interval seconds. While waiting, it responds 400 with "error": "authorization_pending"; on "slow_down", add 5 seconds to the interval. Once approved, it returns the token exactly once.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OrbitLab","description":"Deploy from Git, managed hosting, domains, and databases","colors":{"primary":"#0D9488","light":"#0D9488","dark":"#14B8A6"},"favicon":"https://mintcdn.com/orbitlab/vtbYRoG19Tlz5pdP/favicon.svg?fit=max\u0026auto=format\u0026n=vtbYRoG19Tlz5pdP\u0026q=85\u0026s=0b4738606102d79db50aa27c267af5cb","navbar":{"links":[{"href":"https://x.com/orbitlab_dev","label":"X"}],"primary":{"type":"button","label":"Dashboard","href":"https://orbitlab.dev"}},"footer":{"socials":{"x":"https://x.com/orbitlab_dev","linkedin":"https://www.linkedin.com/company/orbitlab-dev","facebook":"https://www.facebook.com/profile.php?id=61587638984246"},"links":[{"header":"Product","items":[{"label":"Dashboard","href":"https://orbitlab.dev"},{"label":"Hosting","href":"https://orbitlab.dev/"},{"label":"Domains","href":"https://orbitlab.dev/domain"}]},{"header":"Company","items":[{"label":"About","href":"https://orbitlab.dev/about"},{"label":"Blog","href":"https://orbitlab.dev/"}]},{"header":"Support","items":[{"label":"Contact","href":"https://orbitlab.dev/"}]},{"header":"Legal","items":[{"label":"Privacy","href":"https://orbitlab.dev/privacy"},{"label":"Terms","href":"https://orbitlab.dev/terms"}]}]},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Dashboard","href":"https://orbitlab.dev"}]},"languages":[{"language":"fr","default":true,"href":"fr/intro"},{"language":"en","href":"intro"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"orbitlab","hasAudioNarration":false,"actualSubdomain":"orbitlab","customDomains":["docs.orbitlab.dev"],"gitSource":{"type":"github","owner":"abijahkaj","repo":"orbitlab","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6adb39f2ba699f216aba2d4a","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API reference","count":107},{"language":"default","tag":"Services","count":17},{"language":"default","tag":"Billing","count":14},{"language":"default","tag":"Domains","count":14},{"language":"default","tag":"Databases","count":12},{"language":"default","tag":"Organizations","count":10},{"language":"default","tag":"Logs \u0026 metrics","count":7},{"language":"default","tag":"Files","count":6},{"language":"en","tag":"Services","count":5},{"language":"fr","tag":"Services","count":5},{"language":"default","tag":"Hostings","count":5},{"language":"default","tag":"Service domains","count":5},{"language":"en","tag":"Getting started","count":3},{"language":"fr","tag":"Premiers pas","count":3},{"language":"en","tag":"Developers","count":2},{"language":"en","tag":"Domains \u0026 DNS","count":2},{"language":"en","tag":"Advanced","count":2},{"language":"fr","tag":"Développeurs","count":2},{"language":"fr","tag":"Domaines \u0026 DNS","count":2},{"language":"fr","tag":"Avancé","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api","slug":"/api","pageMetadata":{"title":"REST API","description":"Automate OrbitLab over HTTPS with API tokens.","href":"/api"},"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: \"Automate OrbitLab over HTTPS with API tokens.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The OrbitLab API gives programmatic access to everything you manage in the dashboard: services and deployments, environment variables, logs and metrics, domains and DNS, databases, files, WordPress tools, organizations, orders and renewals. The `,_jsx(_components.a,{href:`/cli`,children:`CLI`}),` is built on it.`]}),`\n`,_jsxs(_components.p,{children:[`Browse every endpoint in the `,_jsx(_components.strong,{children:`API reference`}),` section of the sidebar.`]}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(CodeBlock,{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://orbitlab.dev/api/v1`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`Requests and responses use JSON unless an endpoint says otherwise (logs are `,_jsx(_components.code,{children:`text/plain`}),`, invoices are PDF, uploads use `,_jsx(_components.code,{children:`multipart/form-data`}),`).`]}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`Authenticate with an API token in the `,_jsx(_components.code,{children:`Authorization`}),` header:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://orbitlab.dev/api/v1/user`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$ORBITLAB_TOKEN`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`create-a-token`,children:`Create a token`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Open `,_jsx(_components.strong,{children:`Dashboard → Settings → API tokens`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Create token`}),`, give it a name, and choose:`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Scope`}),`: all your organizations, or a single one.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Expiration`}),`: 30, 90 or 365 days, or none.`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`Copy the token. It starts with `,_jsx(_components.code,{children:`olab_`}),` and is only shown once.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`orbitlab login`}),` creates a token for the CLI the same way, after you approve it in the browser. Tokens created by the CLI expire after 90 days.`]}),`\n`,_jsxs(_components.p,{children:[`A token acts with your permissions: it can do what your role allows in each organization. OrbitLab only stores a hash of the token. Revoke tokens you no longer use from the same page, or with `,_jsx(_components.code,{children:`DELETE /v1/tokens/{id}`}),`. Tokens stop working immediately when revoked, when they expire, or when you leave the organization they’re scoped to.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Treat tokens like passwords: store them in your CI’s secret store, never in your repository.`})}),`\n`,_jsx(Heading,{level:`3`,id:`dashboard-only-actions`,children:`Dashboard-only actions`}),`\n`,_jsx(_components.p,{children:`For security, some actions require signing in to the dashboard and can’t be done with a token: creating tokens, deleting your account, unlinking sign-in methods and installing the GitHub App.`}),`\n`,_jsx(Heading,{level:`2`,id:`organizations`,children:`Organizations`}),`\n`,_jsxs(_components.p,{children:[`Resources belong to organizations. Requests act on your first organization unless you choose another with the `,_jsx(_components.code,{children:`X-OrbitLab-Org`}),` header (organization id or slug):`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://orbitlab.dev/api/v1/services`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$ORBITLAB_TOKEN`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-OrbitLab-Org: acme\"`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Tokens scoped to one organization always act on it; selecting another organization returns `,_jsx(_components.code,{children:`403`}),`. List your organizations with `,_jsx(_components.code,{children:`GET /v1/organizations`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Some endpoints require the `,_jsx(_components.strong,{children:`owner`}),` or `,_jsx(_components.strong,{children:`admin`}),` role, for example reading environment variables and database credentials, editing DNS, or managing members. The API reference lists the role for each endpoint.`]}),`\n`,_jsx(Heading,{level:`2`,id:`conventions`,children:`Conventions`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Ids are UUIDs, except plan ids (`,_jsx(_components.code,{children:`app-1`}),`, `,_jsx(_components.code,{children:`starter`}),`…) and DNS record ids.`]}),`\n`,_jsxs(_components.li,{children:[`Amounts are integers in cents, with a `,_jsx(_components.code,{children:`currency`}),`.`]}),`\n`,_jsx(_components.li,{children:`Dates are ISO 8601 strings in UTC.`}),`\n`,_jsxs(_components.li,{children:[`Collections are returned whole under a named key, for example `,_jsx(_components.code,{children:`{ \"services\": [...] }`}),`.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(_components.p,{children:[`Errors return an HTTP status and a JSON body with an `,_jsx(_components.code,{children:`error`}),` message:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Service not found\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`]})})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[`Invalid request. Validation errors may return `,_jsx(_components.code,{children:`error`}),` as an object of field messages.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:`Missing, invalid or expired token.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:`Your role or token doesn’t allow this action in the organization.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:`The resource doesn’t exist in the selected organization.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:`Conflict, for example a domain already attached elsewhere.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`429`})}),_jsxs(_components.td,{children:[`Too many requests. Wait for the number of seconds in the `,_jsx(_components.code,{children:`Retry-After`}),` header.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`502`})}),_jsx(_components.td,{children:`The hosting platform couldn’t complete the operation; retry later.`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`idempotent-checkout`,children:`Idempotent checkout`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`POST /v1/checkout`}),` creates an order and starts a payment. Send a unique `,_jsx(_components.code,{children:`Idempotency-Key`}),` header so a retried request returns the same order instead of creating another one.`]}),`\n`,_jsx(Heading,{level:`2`,id:`examples`,children:`Examples`}),`\n`,_jsx(_components.p,{children:`Deploy a service and follow it:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`SERVICE`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`5f0c3a0e-2b9a-4c8e-9a51-1d2f3e4a5b6c`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://orbitlab.dev/api/v1/services/`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$SERVICE`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/deployments`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$ORBITLAB_TOKEN`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://orbitlab.dev/api/v1/services/`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$SERVICE`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/deployments`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$ORBITLAB_TOKEN`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Set environment variables:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` PATCH`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://orbitlab.dev/api/v1/services/`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$SERVICE`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/env`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$ORBITLAB_TOKEN`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"env\": {\"NODE_ENV\": \"production\"}}'`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Add a DNS record:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://orbitlab.dev/api/v1/domains/`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$DOMAIN_ID`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/records`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$ORBITLAB_TOKEN`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"subdomain\": \"www\", \"type\": \"CNAME\", \"value\": \"web.orbitlab.sh\", \"ttl\": 3600}'`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Order an app plan paid with Mobile Money:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://orbitlab.dev/api/v1/checkout`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$ORBITLAB_TOKEN`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Idempotency-Key: $(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`uuidgen`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`)\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"items\": [{\"type\": \"application\", \"planId\": \"app-1\", \"label\": \"api\"}], \"paymentMethod\": \"mobile_money\", \"mobileMoneyPhone\": \"+243812345678\", \"mobileMoneyNetwork\": \"VODACOM_MPESA_COD\"}'`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`A payment request is sent to the phone. Poll `,_jsx(_components.code,{children:`GET /v1/orders/{orderId}`}),` until the order is `,_jsx(_components.code,{children:`paid`}),`. Card payments are currently unavailable; free orders need no phone number.`]}),`\n`,_jsx(Heading,{level:`2`,id:`device-login-for-your-own-tools`,children:`Device login for your own tools`}),`\n`,_jsx(_components.p,{children:`Tools that can’t store a token ahead of time can use the same device login as the CLI:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`POST /v1/auth/device`}),` with `,_jsx(_components.code,{children:`{\"clientName\": \"my-tool\"}`}),` returns `,_jsx(_components.code,{children:`deviceCode`}),`, `,_jsx(_components.code,{children:`userCode`}),` and `,_jsx(_components.code,{children:`verificationUriComplete`}),`.`]}),`\n`,_jsx(_components.li,{children:`Show the user the code and the link. They approve the request in the dashboard.`}),`\n`,_jsxs(_components.li,{children:[`Poll `,_jsx(_components.code,{children:`POST /v1/auth/device/token`}),` with `,_jsx(_components.code,{children:`{\"deviceCode\": \"…\"}`}),` every `,_jsx(_components.code,{children:`interval`}),` seconds. While waiting, it responds `,_jsx(_components.code,{children:`400`}),` with `,_jsx(_components.code,{children:`\"error\": \"authorization_pending\"`}),`; on `,_jsx(_components.code,{children:`\"slow_down\"`}),`, add 5 seconds to the interval. Once approved, it returns the `,_jsx(_components.code,{children:`token`}),` exactly once.`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"REST API","description":"Automate OrbitLab over HTTPS with API tokens.","href":"/api"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base URL","slug":"base-url","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[{"title":"Create a token","slug":"create-a-token","depth":3,"children":[]},{"title":"Dashboard-only actions","slug":"dashboard-only-actions","depth":3,"children":[]}]},{"title":"Organizations","slug":"organizations","depth":2,"children":[]},{"title":"Conventions","slug":"conventions","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]},{"title":"Idempotent checkout","slug":"idempotent-checkout","depth":2,"children":[]},{"title":"Examples","slug":"examples","depth":2,"children":[]},{"title":"Device login for your own tools","slug":"device-login-for-your-own-tools","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"orbitlab","siteName":"OrbitLab","title":"REST API - OrbitLab","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"fr":{"href":"/fr/api","matchLevel":1},"en":{"href":"/api","matchLevel":0}}},"lastModified":"2026-09-13T16:26:01.676Z","originalFileLocation":"api.mdx","locale":"en"},"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=\"Automate OrbitLab over HTTPS with API tokens.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OrbitLab\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orbitlab/uYDIThg-Nq5eLNZz/_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=\"/mintlify-assets/_mintlify/favicons/orbitlab/uYDIThg-Nq5eLNZz/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orbitlab/uYDIThg-Nq5eLNZz/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/orbitlab/uYDIThg-Nq5eLNZz/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/orbitlab/uYDIThg-Nq5eLNZz/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orbitlab/uYDIThg-Nq5eLNZz/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orbitlab/uYDIThg-Nq5eLNZz/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/orbitlab/uYDIThg-Nq5eLNZz/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/orbitlab/uYDIThg-Nq5eLNZz/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"REST API - OrbitLab\">\u003cmeta data-mint-head property=\"og:description\" content=\"Automate OrbitLab over HTTPS with API tokens.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OrbitLab\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.orbitlab.dev/api\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://orbitlab.mintlify.site/_mintlify/api/og/v2?division=Developers\u0026amp;title=REST+API\u0026amp;description=Automate+OrbitLab+over+HTTPS+with+API+tokens.\u0026amp;theme=95291add462ffdc9fde53e71\u0026amp;signature=82d9ed52b16721a97c284616464436e3ad76d4044cf58f4ed58f1261fd192092\">\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=\"REST API - OrbitLab\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Automate OrbitLab over HTTPS with API tokens.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orbitlab.mintlify.site/_mintlify/api/og/v2?division=Developers\u0026amp;title=REST+API\u0026amp;description=Automate+OrbitLab+over+HTTPS+with+API+tokens.\u0026amp;theme=95291add462ffdc9fde53e71\u0026amp;signature=82d9ed52b16721a97c284616464436e3ad76d4044cf58f4ed58f1261fd192092\">\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=\"/mintlify-assets/_mintlify/favicons/orbitlab/uYDIThg-Nq5eLNZz/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OrbitLab\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9488\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.orbitlab.dev/api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.orbitlab.dev/api\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.orbitlab.dev/fr/api\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.orbitlab.dev/fr/api\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.orbitlab.dev/#organization\",\"name\":\"OrbitLab\",\"url\":\"https://docs.orbitlab.dev\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.orbitlab.dev#website\",\"name\":\"OrbitLab\",\"url\":\"https://docs.orbitlab.dev\",\"publisher\":{\"@id\":\"https://docs.orbitlab.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.orbitlab.dev/api#webpage\",\"url\":\"https://docs.orbitlab.dev/api\",\"name\":\"REST API\",\"description\":\"Automate OrbitLab over HTTPS with API tokens.\",\"dateModified\":\"2026-09-13T16:26:01.676Z\",\"isPartOf\":{\"@id\":\"https://docs.orbitlab.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.orbitlab.dev/api#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.orbitlab.dev/api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Developers\",\"item\":\"https://docs.orbitlab.dev/cli\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"REST API\",\"item\":\"https://docs.orbitlab.dev/api\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.orbitlab.dev/api#article\",\"headline\":\"REST API\",\"name\":\"REST API\",\"description\":\"Automate OrbitLab over HTTPS with API tokens.\",\"url\":\"https://docs.orbitlab.dev/api\",\"mainEntityOfPage\":{\"@id\":\"https://docs.orbitlab.dev/api#webpage\"},\"dateModified\":\"2026-09-13T16:26:01.676Z\",\"publisher\":{\"@id\":\"https://docs.orbitlab.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.orbitlab.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OrbitLab\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"OrbitLab\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api.md","siteName":"OrbitLab","nav":{"global":{"anchors":[{"anchor":"Dashboard","href":"https://orbitlab.dev"}]},"languages":[{"language":"fr","default":true,"pages":[{"title":"fr","href":"/fr/api"}]},{"language":"en","groups":[{"group":"Getting started","pages":[{"title":"Introduction","href":"/intro"},{"title":"Getting started","href":"/getting-started"},{"title":"Pricing","href":"/pricing"}]},{"group":"Services","pages":[{"title":"Managed WordPress","href":"/wordpress"},{"title":"Application Hosting","href":"/paas"},{"title":"Routing (orbitlab.json)","href":"/routing"},{"title":"Persistent Storage","href":"/storage"},{"title":"Managed Databases","href":"/databases"}]},{"group":"Domains \u0026 DNS","pages":[{"title":"Domains","href":"/domains"},{"title":"DNS Management","href":"/dns"}]},{"group":"Advanced","pages":[{"title":"SFTP Access","href":"/sftp"},{"title":"Payments","href":"/payments"}]},{"group":"Developers","pages":[{"title":"CLI","description":"Deploy and manage OrbitLab from your terminal and CI pipelines with the `orbitlab` command.","href":"/cli"},{"title":"REST API","href":"/api"}]},{"group":"API reference","pages":[{"group":"Authentication","pages":[{"title":"Start a CLI device login","description":"Returns a `deviceCode` (secret, kept by the client) and a `userCode` the user approves at `verificationUri`. Poll the token endpoint every `interval` seconds.\n\nCLI: `orbitlab login`","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/device","href":"/api-reference/authentication/start-a-cli-device-login"},{"title":"Poll a CLI device login","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/device/token","href":"/api-reference/authentication/poll-a-cli-device-login"},{"title":"Approve or deny a CLI device login","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/auth/device/approve","href":"/api-reference/authentication/approve-or-deny-a-cli-device-login"}]},{"group":"User","pages":[{"title":"Get the authenticated user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/user","href":"/api-reference/user/get-the-authenticated-user"},{"title":"List linked sign-in methods","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/user/accounts","href":"/api-reference/user/list-linked-sign-in-methods"},{"title":"List API tokens","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tokens","href":"/api-reference/user/list-api-tokens"},{"title":"Create an API token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tokens","href":"/api-reference/user/create-an-api-token"},{"title":"Revoke an API token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tokens/{id}","href":"/api-reference/user/revoke-an-api-token"}]},{"group":"Organizations","pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organizations","href":"/api-reference/organizations/list-organizations"},{"title":"Get an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organizations/{id}","href":"/api-reference/organizations/get-an-organization"},{"title":"Rename an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/organizations/{id}","href":"/api-reference/organizations/rename-an-organization"},{"title":"List members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organizations/{id}/members","href":"/api-reference/organizations/list-members"},{"title":"Remove a member or leave","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/organizations/{id}/members/{memberId}","href":"/api-reference/organizations/remove-a-member-or-leave"},{"title":"Change a member's role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/organizations/{id}/members/{memberId}","href":"/api-reference/organizations/change-a-members-role"},{"title":"List pending invitations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organizations/{id}/invitations","href":"/api-reference/organizations/list-pending-invitations"},{"title":"Invite a member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/organizations/{id}/invitations","href":"/api-reference/organizations/invite-a-member"},{"title":"Revoke an invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/organizations/{id}/invitations/{invitationId}","href":"/api-reference/organizations/revoke-an-invitation"},{"title":"Accept an invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/invitations/{token}/accept","href":"/api-reference/organizations/accept-an-invitation"}]},{"group":"Catalog","pages":[{"title":"List plans","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/plans","href":"/api-reference/catalog/list-plans"},{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates","href":"/api-reference/catalog/list-templates"}]},{"group":"Services","pages":[{"title":"List services","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services","href":"/api-reference/services/list-services"},{"title":"Get a service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}","href":"/api-reference/services/get-a-service"},{"title":"Delete a service's project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/services/{id}","href":"/api-reference/services/delete-a-services-project"},{"title":"Connect a repository and deploy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/services/{id}/configure","href":"/api-reference/services/connect-a-repository-and-deploy"},{"title":"Get build and Git settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/settings","href":"/api-reference/services/get-build-and-git-settings"},{"title":"Update build and Git settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/services/{id}/settings","href":"/api-reference/services/update-build-and-git-settings"},{"title":"List environment variables","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/env","href":"/api-reference/services/list-environment-variables"},{"title":"Set environment variables","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/services/{id}/env","href":"/api-reference/services/set-environment-variables"},{"title":"Delete an environment variable","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/services/{id}/env/{key}","href":"/api-reference/services/delete-an-environment-variable"},{"title":"List deployments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/deployments","href":"/api-reference/services/list-deployments"},{"title":"Deploy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/services/{id}/deployments","href":"/api-reference/services/deploy"},{"title":"Get a deployment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/deployments/{deploymentId}","href":"/api-reference/services/get-a-deployment"},{"title":"Delete a deployment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/services/{id}/deployments/{deploymentId}","href":"/api-reference/services/delete-a-deployment"},{"title":"Restart","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/services/{id}/restart","href":"/api-reference/services/restart"},{"title":"Retry provisioning","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/services/{id}/retry-provisioning","href":"/api-reference/services/retry-provisioning"},{"title":"Get firewall rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/firewall","href":"/api-reference/services/get-firewall-rules"},{"title":"Set firewall rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/services/{id}/firewall","href":"/api-reference/services/set-firewall-rules"}]},{"group":"Logs \u0026 metrics","pages":[{"title":"Get build logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/deployments/{deploymentId}/logs","href":"/api-reference/logs-\u0026-metrics/get-build-logs"},{"title":"Get live runtime logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/runtime-logs","href":"/api-reference/logs-\u0026-metrics/get-live-runtime-logs"},{"title":"Search application logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/logs","href":"/api-reference/logs-\u0026-metrics/search-application-logs"},{"title":"Search request logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/requests","href":"/api-reference/logs-\u0026-metrics/search-request-logs"},{"title":"Check log availability","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/telemetry","href":"/api-reference/logs-\u0026-metrics/check-log-availability"},{"title":"Get current resource usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/metrics","href":"/api-reference/logs-\u0026-metrics/get-current-resource-usage"},{"title":"Get resource usage history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/metrics/history","href":"/api-reference/logs-\u0026-metrics/get-resource-usage-history"}]},{"group":"Service domains","pages":[{"title":"List custom domains","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/domains","href":"/api-reference/service-domains/list-custom-domains"},{"title":"Add a custom domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/services/{id}/domains","href":"/api-reference/service-domains/add-a-custom-domain"},{"title":"Remove a custom domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/services/{id}/domains/{domain}","href":"/api-reference/service-domains/remove-a-custom-domain"},{"title":"Verify a custom domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/services/{id}/domains/{domain}/verify","href":"/api-reference/service-domains/verify-a-custom-domain"},{"title":"Move a domain's DNS to OrbitLab","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/services/{id}/domains/{domain}/import","href":"/api-reference/service-domains/move-a-domains-dns-to-orbitlab"}]},{"group":"Databases","pages":[{"title":"List a service's databases","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/databases","href":"/api-reference/databases/list-a-services-databases"},{"title":"Add a database to a service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/services/{id}/databases","href":"/api-reference/databases/add-a-database-to-a-service"},{"title":"Get a service database with credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/databases/{dbId}","href":"/api-reference/databases/get-a-service-database-with-credentials"},{"title":"List databases","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/databases","href":"/api-reference/databases/list-databases"},{"title":"Get a database","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/databases/{id}","href":"/api-reference/databases/get-a-database"},{"title":"Delete a database","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/databases/{id}","href":"/api-reference/databases/delete-a-database"},{"title":"List tables","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/databases/{id}/tables","href":"/api-reference/databases/list-tables"},{"title":"Browse table rows","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/databases/{id}/tables/{tableName}","href":"/api-reference/databases/browse-table-rows"},{"title":"Run a SQL query","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/databases/{id}/query","href":"/api-reference/databases/run-a-sql-query"},{"title":"List read replicas","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/databases/{id}/replicas","href":"/api-reference/databases/list-read-replicas"},{"title":"Create a read replica","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/databases/{id}/replicas","href":"/api-reference/databases/create-a-read-replica"},{"title":"Delete a read replica","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/databases/{id}/replicas/{replicaId}","href":"/api-reference/databases/delete-a-read-replica"}]},{"group":"Files","pages":[{"title":"List a directory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/files","href":"/api-reference/files/list-a-directory"},{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/services/{id}/files","href":"/api-reference/files/upload-a-file"},{"title":"Create a direct upload URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/services/{id}/files/upload-url","href":"/api-reference/files/create-a-direct-upload-url"},{"title":"Download a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/files/content","href":"/api-reference/files/download-a-file"},{"title":"Create a directory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/services/{id}/files/directories","href":"/api-reference/files/create-a-directory"},{"title":"Get SFTP credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/sftp","href":"/api-reference/files/get-sftp-credentials"}]},{"group":"WordPress","pages":[{"title":"List managed actions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/actions","href":"/api-reference/wordpress/list-managed-actions"},{"title":"Run a managed action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/services/{id}/actions","href":"/api-reference/wordpress/run-a-managed-action"},{"title":"Get a job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/services/{id}/jobs/{jobId}","href":"/api-reference/wordpress/get-a-job"},{"title":"Reset the WordPress admin account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/services/{id}/wordpress/reset-admin","href":"/api-reference/wordpress/reset-the-wordpress-admin-account"}]},{"group":"Hostings","pages":[{"title":"List shared hostings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/hostings","href":"/api-reference/hostings/list-shared-hostings"},{"title":"Get a shared hosting","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/hostings/{id}","href":"/api-reference/hostings/get-a-shared-hosting"},{"title":"Add a website","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/hostings/{id}/websites","href":"/api-reference/hostings/add-a-website"},{"title":"Get hosting firewall rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/hostings/{id}/firewall","href":"/api-reference/hostings/get-hosting-firewall-rules"},{"title":"Set hosting firewall rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/hostings/{id}/firewall","href":"/api-reference/hostings/set-hosting-firewall-rules"}]},{"group":"Domains","pages":[{"title":"List domains","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/domains","href":"/api-reference/domains/list-domains"},{"title":"Check availability","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/domains/check","href":"/api-reference/domains/check-availability"},{"title":"Suggest domains","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/domains/search","href":"/api-reference/domains/suggest-domains"},{"title":"Get a domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/domains/{id}","href":"/api-reference/domains/get-a-domain"},{"title":"Update domain settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/domains/{id}","href":"/api-reference/domains/update-domain-settings"},{"title":"Get the transfer (EPP) code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/domains/{id}/auth-code","href":"/api-reference/domains/get-the-transfer-epp-code"},{"title":"List DNS records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/domains/{id}/records","href":"/api-reference/domains/list-dns-records"},{"title":"Create a DNS record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/domains/{id}/records","href":"/api-reference/domains/create-a-dns-record"},{"title":"Delete a DNS record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/domains/{id}/records/{recordId}","href":"/api-reference/domains/delete-a-dns-record"},{"title":"Update a DNS record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/domains/{id}/records/{recordId}","href":"/api-reference/domains/update-a-dns-record"},{"title":"Scan a domain's current DNS","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/domains/import/scan","href":"/api-reference/domains/scan-a-domains-current-dns"},{"title":"Import a domain's DNS","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/domains/import","href":"/api-reference/domains/import-a-domains-dns"},{"title":"Cancel a pending DNS import","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/domains/import","href":"/api-reference/domains/cancel-a-pending-dns-import"},{"title":"Activate an imported domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/domains/{id}/activate","href":"/api-reference/domains/activate-an-imported-domain"}]},{"group":"Billing","pages":[{"title":"Create an order and start payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/checkout","href":"/api-reference/billing/create-an-order-and-start-payment"},{"title":"Preview a promo code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/promo-codes/validate","href":"/api-reference/billing/preview-a-promo-code"},{"title":"List orders","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/orders","href":"/api-reference/billing/list-orders"},{"title":"Get an order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/orders/{orderId}","href":"/api-reference/billing/get-an-order"},{"title":"Retry payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/orders/{orderId}/retry","href":"/api-reference/billing/retry-payment"},{"title":"Set up a paid hosting or VPS order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/orders/{orderId}/provision","href":"/api-reference/billing/set-up-a-paid-hosting-or-vps-order"},{"title":"Download the invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/orders/{orderId}/invoice","href":"/api-reference/billing/download-the-invoice"},{"title":"List subscriptions and domains to renew","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/billing/subscriptions","href":"/api-reference/billing/list-subscriptions-and-domains-to-renew"},{"title":"Get a renewal quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/billing/renewals/{kind}/{id}","href":"/api-reference/billing/get-a-renewal-quote"},{"title":"Get automatic renewal status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/billing/autopay","href":"/api-reference/billing/get-automatic-renewal-status"},{"title":"Disable automatic renewal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/billing/autopay","href":"/api-reference/billing/disable-automatic-renewal"},{"title":"List Mobile Money providers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/payments/mobile-money/providers","href":"/api-reference/billing/list-mobile-money-providers"},{"title":"Detect the Mobile Money provider of a phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/payments/mobile-money/predict-provider","href":"/api-reference/billing/detect-the-mobile-money-provider-of-a-phone-number"},{"title":"Convert a USD amount","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/currency/convert","href":"/api-reference/billing/convert-a-usd-amount"}]},{"group":"GitHub","pages":[{"title":"List GitHub App installations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/github/installations","href":"/api-reference/github/list-github-app-installations"},{"title":"Disconnect GitHub","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/github/installations","href":"/api-reference/github/disconnect-github"},{"title":"List accessible repositories","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/github/repos","href":"/api-reference/github/list-accessible-repositories"}]}]}]}]},"basePath":"","title":"REST API - OrbitLab","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":[],"chunks":[]}