Automatisez OrbitLab en HTTPS avec des jetons d’API.
L’API OrbitLab donne un accès programmatique à tout ce que vous gérez dans le tableau de bord : services et déploiements, variables d’environnement, journaux et métriques, domaines et DNS, bases de données, fichiers, outils WordPress, organisations, commandes et renouvellements. La CLI repose sur cette API.Retrouvez tous les points d’accès dans la section API reference du menu.
URL de base
https://orbitlab.dev/api/v1
Les requêtes et réponses sont en JSON, sauf mention contraire (les journaux sont en text/plain, les factures en PDF, les envois de fichiers en multipart/form-data).
Authentification
Authentifiez-vous avec un jeton d’API dans l’en-tête Authorization :
Ouvrez Tableau de bord → Paramètres → Jetons d’API.
Cliquez sur Créer un jeton, nommez-le et choisissez :
Portée : toutes vos organisations, ou une seule.
Expiration : 30, 90 ou 365 jours, ou aucune.
Copiez le jeton. Il commence par olab_ et n’est affiché qu’une seule fois.
orbitlab login crée de la même façon un jeton pour la CLI, après votre approbation dans le navigateur. Les jetons créés par la CLI expirent au bout de 90 jours.Un jeton agit avec vos permissions : il peut faire ce que votre rôle autorise dans chaque organisation. OrbitLab ne conserve qu’une empreinte du jeton. Révoquez les jetons inutilisés depuis la même page, ou avec DELETE /v1/tokens/{id}. Un jeton cesse de fonctionner immédiatement lorsqu’il est révoqué, lorsqu’il expire ou lorsque vous quittez l’organisation à laquelle il est limité.
Protégez vos jetons comme des mots de passe : conservez-les dans le coffre à secrets de votre CI, jamais dans votre dépôt.
Actions réservées au tableau de bord
Par sécurité, certaines actions nécessitent une connexion au tableau de bord et ne sont pas possibles avec un jeton : créer des jetons, supprimer votre compte, dissocier une méthode de connexion et installer l’application GitHub.
Organisations
Les ressources appartiennent à des organisations. Les requêtes agissent sur votre première organisation, sauf si vous en choisissez une autre avec l’en-tête X-OrbitLab-Org (identifiant ou slug) :
Un jeton limité à une organisation agit toujours sur celle-ci ; en choisir une autre renvoie 403. Listez vos organisations avec GET /v1/organizations.Certains points d’accès exigent le rôle propriétaire ou administrateur, par exemple pour lire les variables d’environnement et les identifiants de base de données, modifier le DNS ou gérer les membres. La référence de l’API indique le rôle requis pour chaque point d’accès.
Conventions
Les identifiants sont des UUID, sauf ceux des formules (app-1, starter…) et des enregistrements DNS.
Les montants sont des entiers en centimes, accompagnés d’une currency.
Les dates sont des chaînes ISO 8601 en UTC.
Les collections sont renvoyées entières sous une clé nommée, par exemple { "services": [...] }.
Erreurs
Les erreurs renvoient un statut HTTP et un corps JSON contenant un message error :
{ "error": "Service not found" }
Statut
Signification
400
Requête invalide. Les erreurs de validation peuvent renvoyer error sous forme d’objet par champ.
401
Jeton absent, invalide ou expiré.
403
Votre rôle ou votre jeton ne permet pas cette action dans l’organisation.
404
La ressource n’existe pas dans l’organisation sélectionnée.
409
Conflit, par exemple un domaine déjà rattaché ailleurs.
429
Trop de requêtes. Attendez le nombre de secondes indiqué par l’en-tête Retry-After.
502
La plateforme d’hébergement n’a pas pu terminer l’opération ; réessayez plus tard.
Commande idempotente
POST /v1/checkout crée une commande et lance le paiement. Envoyez un en-tête Idempotency-Key unique : une requête relancée renverra la même commande au lieu d’en créer une nouvelle.
Une demande de paiement est envoyée au téléphone. Interrogez GET /v1/orders/{orderId} jusqu’à ce que la commande soit paid. Le paiement par carte est actuellement indisponible ; une commande gratuite ne nécessite pas de numéro.
Connexion par appareil pour vos outils
Les outils qui ne peuvent pas stocker de jeton à l’avance peuvent utiliser la même connexion par appareil que la CLI :
POST /v1/auth/device avec {"clientName": "mon-outil"} renvoie deviceCode, userCode et verificationUriComplete.
Affichez le code et le lien à l’utilisateur, qui approuve la demande dans le tableau de bord.
Interrogez POST /v1/auth/device/token avec {"deviceCode": "…"} toutes les interval secondes. En attendant, la réponse est 400 avec "error": "authorization_pending" ; en cas de "slow_down", ajoutez 5 secondes à l’intervalle. Une fois la demande approuvée, le token est renvoyé une seule fois.
Cette page vous a-t-elle été utile ?
{"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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"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":"fr/api","slug":"/fr/api","pageMetadata":{"title":"API REST","description":"Automatisez OrbitLab en HTTPS avec des jetons d'API.","href":"/fr/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: \"Automatisez OrbitLab en HTTPS avec des jetons d’API.\"\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:[`L’API OrbitLab donne un accès programmatique à tout ce que vous gérez dans le tableau de bord : services et déploiements, variables d’environnement, journaux et métriques, domaines et DNS, bases de données, fichiers, outils WordPress, organisations, commandes et renouvellements. La `,_jsx(_components.a,{href:`/fr/cli`,children:`CLI`}),` repose sur cette API.`]}),`\n`,_jsxs(_components.p,{children:[`Retrouvez tous les points d’accès dans la section `,_jsx(_components.strong,{children:`API reference`}),` du menu.`]}),`\n`,_jsx(Heading,{level:`2`,id:`url-de-base`,children:`URL de base`}),`\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:[`Les requêtes et réponses sont en JSON, sauf mention contraire (les journaux sont en `,_jsx(_components.code,{children:`text/plain`}),`, les factures en PDF, les envois de fichiers en `,_jsx(_components.code,{children:`multipart/form-data`}),`).`]}),`\n`,_jsx(Heading,{level:`2`,id:`authentification`,children:`Authentification`}),`\n`,_jsxs(_components.p,{children:[`Authentifiez-vous avec un jeton d’API dans l’en-tête `,_jsx(_components.code,{children:`Authorization`}),` :`]}),`\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:`créer-un-jeton`,children:`Créer un jeton`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Ouvrez `,_jsx(_components.strong,{children:`Tableau de bord → Paramètres → Jetons d’API`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Cliquez sur `,_jsx(_components.strong,{children:`Créer un jeton`}),`, nommez-le et choisissez :`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Portée`}),` : toutes vos organisations, ou une seule.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Expiration`}),` : 30, 90 ou 365 jours, ou aucune.`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`Copiez le jeton. Il commence par `,_jsx(_components.code,{children:`olab_`}),` et n’est affiché qu’une seule fois.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`orbitlab login`}),` crée de la même façon un jeton pour la CLI, après votre approbation dans le navigateur. Les jetons créés par la CLI expirent au bout de 90 jours.`]}),`\n`,_jsxs(_components.p,{children:[`Un jeton agit avec vos permissions : il peut faire ce que votre rôle autorise dans chaque organisation. OrbitLab ne conserve qu’une empreinte du jeton. Révoquez les jetons inutilisés depuis la même page, ou avec `,_jsx(_components.code,{children:`DELETE /v1/tokens/{id}`}),`. Un jeton cesse de fonctionner immédiatement lorsqu’il est révoqué, lorsqu’il expire ou lorsque vous quittez l’organisation à laquelle il est limité.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Protégez vos jetons comme des mots de passe : conservez-les dans le coffre à secrets de votre CI, jamais dans votre dépôt.`})}),`\n`,_jsx(Heading,{level:`3`,id:`actions-réservées-au-tableau-de-bord`,children:`Actions réservées au tableau de bord`}),`\n`,_jsx(_components.p,{children:`Par sécurité, certaines actions nécessitent une connexion au tableau de bord et ne sont pas possibles avec un jeton : créer des jetons, supprimer votre compte, dissocier une méthode de connexion et installer l’application GitHub.`}),`\n`,_jsx(Heading,{level:`2`,id:`organisations`,children:`Organisations`}),`\n`,_jsxs(_components.p,{children:[`Les ressources appartiennent à des organisations. Les requêtes agissent sur votre première organisation, sauf si vous en choisissez une autre avec l’en-tête `,_jsx(_components.code,{children:`X-OrbitLab-Org`}),` (identifiant ou 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:[`Un jeton limité à une organisation agit toujours sur celle-ci ; en choisir une autre renvoie `,_jsx(_components.code,{children:`403`}),`. Listez vos organisations avec `,_jsx(_components.code,{children:`GET /v1/organizations`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Certains points d’accès exigent le rôle `,_jsx(_components.strong,{children:`propriétaire`}),` ou `,_jsx(_components.strong,{children:`administrateur`}),`, par exemple pour lire les variables d’environnement et les identifiants de base de données, modifier le DNS ou gérer les membres. La référence de l’API indique le rôle requis pour chaque point d’accès.`]}),`\n`,_jsx(Heading,{level:`2`,id:`conventions`,children:`Conventions`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Les identifiants sont des UUID, sauf ceux des formules (`,_jsx(_components.code,{children:`app-1`}),`, `,_jsx(_components.code,{children:`starter`}),`…) et des enregistrements DNS.`]}),`\n`,_jsxs(_components.li,{children:[`Les montants sont des entiers en centimes, accompagnés d’une `,_jsx(_components.code,{children:`currency`}),`.`]}),`\n`,_jsx(_components.li,{children:`Les dates sont des chaînes ISO 8601 en UTC.`}),`\n`,_jsxs(_components.li,{children:[`Les collections sont renvoyées entières sous une clé nommée, par exemple `,_jsx(_components.code,{children:`{ \"services\": [...] }`}),`.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`erreurs`,children:`Erreurs`}),`\n`,_jsxs(_components.p,{children:[`Les erreurs renvoient un statut HTTP et un corps JSON contenant un message `,_jsx(_components.code,{children:`error`}),` :`]}),`\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:`Statut`}),_jsx(_components.th,{children:`Signification`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[`Requête invalide. Les erreurs de validation peuvent renvoyer `,_jsx(_components.code,{children:`error`}),` sous forme d’objet par champ.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:`Jeton absent, invalide ou expiré.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:`Votre rôle ou votre jeton ne permet pas cette action dans l’organisation.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:`La ressource n’existe pas dans l’organisation sélectionnée.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:`Conflit, par exemple un domaine déjà rattaché ailleurs.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`429`})}),_jsxs(_components.td,{children:[`Trop de requêtes. Attendez le nombre de secondes indiqué par l’en-tête `,_jsx(_components.code,{children:`Retry-After`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`502`})}),_jsx(_components.td,{children:`La plateforme d’hébergement n’a pas pu terminer l’opération ; réessayez plus tard.`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`commande-idempotente`,children:`Commande idempotente`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`POST /v1/checkout`}),` crée une commande et lance le paiement. Envoyez un en-tête `,_jsx(_components.code,{children:`Idempotency-Key`}),` unique : une requête relancée renverra la même commande au lieu d’en créer une nouvelle.`]}),`\n`,_jsx(Heading,{level:`2`,id:`exemples`,children:`Exemples`}),`\n`,_jsx(_components.p,{children:`Déployer un service et suivre le déploiement :`}),`\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:`Définir des variables d’environnement :`}),`\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:`Ajouter un enregistrement DNS :`}),`\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:`Commander une application payée par 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:[`Une demande de paiement est envoyée au téléphone. Interrogez `,_jsx(_components.code,{children:`GET /v1/orders/{orderId}`}),` jusqu’à ce que la commande soit `,_jsx(_components.code,{children:`paid`}),`. Le paiement par carte est actuellement indisponible ; une commande gratuite ne nécessite pas de numéro.`]}),`\n`,_jsx(Heading,{level:`2`,id:`connexion-par-appareil-pour-vos-outils`,children:`Connexion par appareil pour vos outils`}),`\n`,_jsx(_components.p,{children:`Les outils qui ne peuvent pas stocker de jeton à l’avance peuvent utiliser la même connexion par appareil que la CLI :`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`POST /v1/auth/device`}),` avec `,_jsx(_components.code,{children:`{\"clientName\": \"mon-outil\"}`}),` renvoie `,_jsx(_components.code,{children:`deviceCode`}),`, `,_jsx(_components.code,{children:`userCode`}),` et `,_jsx(_components.code,{children:`verificationUriComplete`}),`.`]}),`\n`,_jsx(_components.li,{children:`Affichez le code et le lien à l’utilisateur, qui approuve la demande dans le tableau de bord.`}),`\n`,_jsxs(_components.li,{children:[`Interrogez `,_jsx(_components.code,{children:`POST /v1/auth/device/token`}),` avec `,_jsx(_components.code,{children:`{\"deviceCode\": \"…\"}`}),` toutes les `,_jsx(_components.code,{children:`interval`}),` secondes. En attendant, la réponse est `,_jsx(_components.code,{children:`400`}),` avec `,_jsx(_components.code,{children:`\"error\": \"authorization_pending\"`}),` ; en cas de `,_jsx(_components.code,{children:`\"slow_down\"`}),`, ajoutez 5 secondes à l’intervalle. Une fois la demande approuvée, le `,_jsx(_components.code,{children:`token`}),` est renvoyé une seule fois.`]}),`\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":"API REST","description":"Automatisez OrbitLab en HTTPS avec des jetons d'API.","href":"/fr/api"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"URL de base","slug":"url-de-base","depth":2,"children":[]},{"title":"Authentification","slug":"authentification","depth":2,"children":[{"title":"Créer un jeton","slug":"créer-un-jeton","depth":3,"children":[]},{"title":"Actions réservées au tableau de bord","slug":"actions-réservées-au-tableau-de-bord","depth":3,"children":[]}]},{"title":"Organisations","slug":"organisations","depth":2,"children":[]},{"title":"Conventions","slug":"conventions","depth":2,"children":[]},{"title":"Erreurs","slug":"erreurs","depth":2,"children":[]},{"title":"Commande idempotente","slug":"commande-idempotente","depth":2,"children":[]},{"title":"Exemples","slug":"exemples","depth":2,"children":[]},{"title":"Connexion par appareil pour vos outils","slug":"connexion-par-appareil-pour-vos-outils","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"orbitlab","siteName":"OrbitLab","title":"API REST - OrbitLab","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"fr":{"href":"/fr/api","matchLevel":0},"en":{"href":"/api","matchLevel":1}}},"lastModified":"2026-09-13T16:26:01.674Z","originalFileLocation":"fr/api.mdx","locale":"fr"},"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=\"Automatisez OrbitLab en HTTPS avec des jetons d\u0026#x27;API.\">\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=\"API REST - OrbitLab\">\u003cmeta data-mint-head property=\"og:description\" content=\"Automatisez OrbitLab en HTTPS avec des jetons d\u0026#x27;API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OrbitLab\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.orbitlab.dev/fr/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=D%C3%A9veloppeurs\u0026amp;title=API+REST\u0026amp;description=Automatisez+OrbitLab+en+HTTPS+avec+des+jetons+d%27API.\u0026amp;theme=95291add462ffdc9fde53e71\u0026amp;signature=7f9cd1c28d82cf81836919bf515795fb046f87f9ca3e9a7315683403e1a42216\">\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 REST - OrbitLab\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Automatisez OrbitLab en HTTPS avec des jetons d\u0026#x27;API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orbitlab.mintlify.site/_mintlify/api/og/v2?division=D%C3%A9veloppeurs\u0026amp;title=API+REST\u0026amp;description=Automatisez+OrbitLab+en+HTTPS+avec+des+jetons+d%27API.\u0026amp;theme=95291add462ffdc9fde53e71\u0026amp;signature=7f9cd1c28d82cf81836919bf515795fb046f87f9ca3e9a7315683403e1a42216\">\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/fr/api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/fr/api.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.orbitlab.dev/fr/api\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.orbitlab.dev/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/fr/api#webpage\",\"url\":\"https://docs.orbitlab.dev/fr/api\",\"name\":\"API REST\",\"description\":\"Automatisez OrbitLab en HTTPS avec des jetons d'API.\",\"dateModified\":\"2026-09-13T16:26:01.674Z\",\"isPartOf\":{\"@id\":\"https://docs.orbitlab.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.orbitlab.dev/fr/api#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.orbitlab.dev/fr/api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Développeurs\",\"item\":\"https://docs.orbitlab.dev/fr/cli\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API REST\",\"item\":\"https://docs.orbitlab.dev/fr/api\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.orbitlab.dev/fr/api#article\",\"headline\":\"API REST\",\"name\":\"API REST\",\"description\":\"Automatisez OrbitLab en HTTPS avec des jetons d'API.\",\"url\":\"https://docs.orbitlab.dev/fr/api\",\"mainEntityOfPage\":{\"@id\":\"https://docs.orbitlab.dev/fr/api#webpage\"},\"dateModified\":\"2026-09-13T16:26:01.674Z\",\"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":"/fr/api.md","siteName":"OrbitLab","nav":{"global":{"anchors":[{"anchor":"Dashboard","href":"https://orbitlab.dev"}]},"languages":[{"language":"fr","default":true,"groups":[{"group":"Premiers pas","pages":[{"title":"Introduction","href":"/fr/intro"},{"title":"Premiers pas","href":"/fr/getting-started"},{"title":"Tarification","href":"/fr/pricing"}]},{"group":"Services","pages":[{"title":"WordPress Géré","href":"/fr/wordpress"},{"title":"Hébergement d'Applications","href":"/fr/paas"},{"title":"Routage (orbitlab.json)","href":"/fr/routing"},{"title":"Stockage persistant","href":"/fr/storage"},{"title":"Bases de données gérées","href":"/fr/databases"}]},{"group":"Domaines \u0026 DNS","pages":[{"title":"Domaines","href":"/fr/domains"},{"title":"Gestion DNS","href":"/fr/dns"}]},{"group":"Avancé","pages":[{"title":"Accès SFTP","href":"/fr/sftp"},{"title":"Paiements","href":"/fr/payments"}]},{"group":"Développeurs","pages":[{"title":"CLI","description":"Déployez et gérez OrbitLab depuis votre terminal et vos pipelines CI avec la commande `orbitlab`.","href":"/fr/cli"},{"title":"API REST","href":"/fr/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"}]}]}]},{"language":"en","pages":[{"title":"en","href":"/api"}]}]},"basePath":"","title":"API REST - OrbitLab","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":[],"chunks":[]}