Returns a domain, including the verificationCode and target you need for its DNS records. The response can include additional fields not listed here. With teamID, you need any permission on the app or bucket.
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Liara OpenAPI Docs","colors":{"primary":"#009689","light":"#00BBA7","dark":"#009689"},"logo":{"light":"https://mintcdn.com/liara/2lAl_CkG1cEAkr-Y/logo.png?fit=max\u0026auto=format\u0026n=2lAl_CkG1cEAkr-Y\u0026q=85\u0026s=90f85cd2b2db4fc0e76ca4cf6fb468b5","dark":"https://mintcdn.com/liara/2lAl_CkG1cEAkr-Y/logo.png?fit=max\u0026auto=format\u0026n=2lAl_CkG1cEAkr-Y\u0026q=85\u0026s=90f85cd2b2db4fc0e76ca4cf6fb468b5"},"favicon":{"light":"https://mintcdn.com/liara/2lAl_CkG1cEAkr-Y/logo.png?fit=max\u0026auto=format\u0026n=2lAl_CkG1cEAkr-Y\u0026q=85\u0026s=90f85cd2b2db4fc0e76ca4cf6fb468b5","dark":"https://mintcdn.com/liara/2lAl_CkG1cEAkr-Y/logo.png?fit=max\u0026auto=format\u0026n=2lAl_CkG1cEAkr-Y\u0026q=85\u0026s=90f85cd2b2db4fc0e76ca4cf6fb468b5"},"navbar":{"links":[{"href":"mailto:info@liara.ir","label":"Support"}],"primary":{"type":"button","label":"Console","href":"https://console.liara.ir"}},"footer":{"socials":{"website":"https://liara.ir","github":"https://github.com/liara-cloud","linkedin":"https://linkedin.com/company/liara-cloud","x":"https://x.com/liara_cloud"}},"icons":{"library":"fontawesome"},"contextual":{"options":["copy","chatgpt","perplexity"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.liara.ir"},{"anchor":"Blog","icon":"newspaper","href":"https://liara.ir/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"liara","hasAudioNarration":false,"actualSubdomain":"liara","customDomains":["developers.liara.ir"],"gitSource":{"type":"github","owner":"liara-cloud","repo":"openapi","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae871d5a8708698b47b2a03","collectionId":"0e90692c-d9b6-4c78-9098-40e11304546a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae871d5a8708698b47b2a03"},"entitlements":{},"buildId":"6ae871d5a8708698b47b2a03","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Endpoints","count":135},{"language":"default","tag":"Platform Core","count":85},{"language":"default","tag":"PaaS","count":78},{"language":"default","tag":"Mail","count":41},{"language":"default","tag":"Apps \u0026 Deployments","count":38},{"language":"default","tag":"AI","count":33},{"language":"default","tag":"Object Storage","count":27},{"language":"default","tag":"DBaaS","count":26},{"language":"default","tag":"Authentication \u0026 Account","count":26},{"language":"default","tag":"Domains \u0026 Disks","count":23}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":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":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"paas-domains-disks/domains/get-a-domain","slug":"/paas-domains-disks/domains/get-a-domain","pageMetadata":{"title":"Get a domain","description":"Returns a domain, including the `verificationCode` and `target` you need for its DNS records. The response can include additional fields not listed here. With `teamID`, you need any permission on the app or bucket.","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml get /v1/domains/{domainName}","href":"/paas-domains-disks/domains/get-a-domain","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns a domain, including the \", _jsx(_components.code, {\n children: \"verificationCode\"\n }), \" and \", _jsx(_components.code, {\n children: \"target\"\n }), \" you need for its DNS records. The response can include additional fields not listed here. With \", _jsx(_components.code, {\n children: \"teamID\"\n }), \", you need any permission on the app or bucket.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a domain","description":"Returns a domain, including the `verificationCode` and `target` you need for its DNS records. The response can include additional fields not listed here. With `teamID`, you need any permission on the app or bucket.","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml get /v1/domains/{domainName}","href":"/paas-domains-disks/domains/get-a-domain","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Domains"],"operationId":"getDomain","summary":"Get a domain","description":"Returns a domain, including the `verificationCode` and `target` you need for its DNS records. The response can include additional fields not listed here. With `teamID`, you need any permission on the app or bucket.","parameters":["2ff3d323-dfdc-4d03-8323-6030a3bf2a18","db8e411e-4001-485b-8fe9-1b9413c4d285"],"responses":{"200":"0f527749-814b-4676-86cb-1fda9ddea5fe","400":"2cd1e97e-5e25-4484-bde0-a83e2a574cbb","401":"6b109bf3-c12b-4220-ad0e-1eb78781739d","403":"7cf56a63-e607-4147-b952-15d7b727a7a6","404":"306f336f-da1a-4ccf-b7a1-2667eb125afb"},"method":"get","type":"path","servers":["bd8bc5e8-6b21-4b52-96da-836fee1554b8"],"security":["4d3a8816-8487-4a6e-b38e-8e2a6022ea01"],"path":"/v1/domains/{domainName}","baseUrlOptions":["https://api.liara.ir"],"title":"Get a domain","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2ff3d323-dfdc-4d03-8323-6030a3bf2a18":{"name":"teamID","in":"query","required":false,"description":"Run the request in the context of a team you belong to, instead of your personal account.","schema":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"Run the request in the context of a team you belong to, instead of your personal account.\n24-character hexadecimal ID.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"example":"000000000000000000000002"},"db8e411e-4001-485b-8fe9-1b9413c4d285":{"name":"domainName","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"example":"www.example.com"}},"responses":{"0f527749-814b-4676-86cb-1fda9ddea5fe":{"description":"The domain.","content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"object","properties":{"_id":{"type":"string","uniqueKey":"domain._id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"domain.name","typeLabel":"string"},"type":{"type":"string","description":"`PROJECT` for an app's domain, `BUCKET` for an object storage bucket's domain.","enum":["PROJECT","BUCKET"],"default":"PROJECT","uniqueKey":"domain.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"`ACTIVE` once ownership is verified, `PENDING` before that.","enum":["PENDING","ACTIVE"],"uniqueKey":"domain.status","typeLabel":"enum\u003cstring>"},"project":{"oneOf":[{"type":"object","description":"The app, for app domains.","properties":{"_id":{"type":"string","uniqueKey":"domain.project.oneOf.0._id","typeLabel":"string"},"project_id":{"type":"string","description":"The app's name.","uniqueKey":"domain.project.oneOf.0.project_id","typeLabel":"string"}},"uniqueKey":"domain.project.oneOf.0","typeLabel":"object"},{"type":"null","description":"The app, for app domains.","properties":{"_id":{"type":"string"},"project_id":{"type":"string","description":"The app's name."}},"uniqueKey":"domain.project.oneOf.1","typeLabel":"null"}],"uniqueKey":"domain.project","typeLabel":"object | null"},"bucket":{"oneOf":[{"type":"object","description":"The bucket, for bucket domains.","properties":{"_id":{"type":"string","uniqueKey":"domain.bucket.oneOf.0._id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"domain.bucket.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"domain.bucket.oneOf.0","typeLabel":"object"},{"type":"null","description":"The bucket, for bucket domains.","properties":{"_id":{"type":"string"},"name":{"type":"string"}},"uniqueKey":"domain.bucket.oneOf.1","typeLabel":"null"}],"uniqueKey":"domain.bucket","typeLabel":"object | null"},"CNameRecord":{"type":"string","description":"Result of the last routing check.","enum":["VALID","INVALID"],"uniqueKey":"domain.CNameRecord","typeLabel":"enum\u003cstring>"},"acmeRecord":{"type":"string","description":"Result of the last check of the `_acme-challenge` record.","enum":["VALID","INVALID"],"uniqueKey":"domain.acmeRecord","typeLabel":"enum\u003cstring>"},"certificatesStatus":{"type":"string","enum":["DEACTIVE","REQUESTING","ACTIVE"],"uniqueKey":"domain.certificatesStatus","typeLabel":"enum\u003cstring>"},"redirectTo":{"type":"string","description":"URL the domain redirects to, or empty.","uniqueKey":"domain.redirectTo","typeLabel":"string"},"redirectStatus":{"type":"integer","enum":[301,302],"uniqueKey":"domain.redirectStatus","typeLabel":"enum\u003cinteger>"},"behindCdn":{"type":"boolean","description":"Whether the domain routes correctly but resolves to a different IP, for example because it's behind a CDN.","uniqueKey":"domain.behindCdn","typeLabel":"boolean"},"isWildcard":{"type":"boolean","uniqueKey":"domain.isWildcard","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","uniqueKey":"domain.created_at","typeLabel":"string\u003cdate-time>"},"verificationCode":{"type":"string","description":"Value for the `liara-challenge` TXT record.","uniqueKey":"domain.verificationCode","typeLabel":"string"},"target":{"type":"string","description":"Host to point the domain's CNAME record at.","uniqueKey":"domain.target","typeLabel":"string"},"isRoot":{"type":"boolean","description":"Whether this is a root domain (for example `example.com`).","uniqueKey":"domain.isRoot","typeLabel":"boolean"},"subdomain":{"type":"string","description":"The subdomain part, for example `www`.","uniqueKey":"domain.subdomain","typeLabel":"string"},"issuedAt":{"type":"string","format":"date-time","description":"When the current certificate was issued.","uniqueKey":"domain.issuedAt","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"domain.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"domain","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"domain":{"_id":"000000000000000000000210","name":"www.example.com","type":"PROJECT","status":"PENDING","project":{"_id":"000000000000000000000050","project_id":"my-app"},"verificationCode":"00000000-0000-0000-0000-000000000000","CNameRecord":"INVALID","acmeRecord":"INVALID","certificatesStatus":"DEACTIVE","redirectTo":"","redirectStatus":302,"behindCdn":false,"isWildcard":false,"isRoot":false,"subdomain":"www","target":"\u003ctarget-host>","created_at":"2026-01-01T08:00:00.000Z","updated_at":"2026-01-01T08:00:00.000Z"}},"examples":{"Example":{"title":"Example","value":{"domain":{"_id":"000000000000000000000210","name":"www.example.com","type":"PROJECT","status":"PENDING","project":{"_id":"000000000000000000000050","project_id":"my-app"},"verificationCode":"00000000-0000-0000-0000-000000000000","CNameRecord":"INVALID","acmeRecord":"INVALID","certificatesStatus":"DEACTIVE","redirectTo":"","redirectStatus":302,"behindCdn":false,"isWildcard":false,"isRoot":false,"subdomain":"www","target":"\u003ctarget-host>","created_at":"2026-01-01T08:00:00.000Z","updated_at":"2026-01-01T08:00:00.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"2cd1e97e-5e25-4484-bde0-a83e2a574cbb":{"description":"`teamID` isn't a valid ID.","content":{"application/json":{"schema":{"type":"object","description":"Standard error body.","properties":{"statusCode":{"type":"integer","uniqueKey":"statusCode","typeLabel":"integer"},"error":{"type":"string","description":"HTTP status text.","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"What went wrong.","uniqueKey":"message","typeLabel":"string"},"data":{"oneOf":[{"type":"object","description":"Extra details. When present, `code` is a stable, machine-readable error code.","properties":{"code":{"type":"string","uniqueKey":"data.oneOf.0.code","typeLabel":"string"}},"uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"null","description":"Extra details. When present, `code` is a stable, machine-readable error code.","properties":{"code":{"type":"string"}},"uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":400,"error":"Bad Request","message":"Invalid team ID.","data":null},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"error":"Bad Request","message":"Invalid team ID.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"6b109bf3-c12b-4220-ad0e-1eb78781739d":{"description":"The API token is missing, invalid or expired.","content":{"application/json":{"schema":{"type":"object","description":"Error body returned when the API token is rejected.","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Unauthorized."},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized."}}},"exampleType":"examples"}},"exampleType":"examples"},"7cf56a63-e607-4147-b952-15d7b727a7a6":{"description":"With `teamID`: you aren't a member of the team (`team_not_found`), or you don't have the required permission (`no_permission`).","content":{"application/json":{"schema":{"type":"object","description":"Standard error body.","properties":{"statusCode":{"type":"integer","uniqueKey":"statusCode","typeLabel":"integer"},"error":{"type":"string","description":"HTTP status text.","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"What went wrong.","uniqueKey":"message","typeLabel":"string"},"data":{"oneOf":[{"type":"object","description":"Extra details. When present, `code` is a stable, machine-readable error code.","properties":{"code":{"type":"string","uniqueKey":"data.oneOf.0.code","typeLabel":"string"}},"uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"null","description":"Extra details. When present, `code` is a stable, machine-readable error code.","properties":{"code":{"type":"string"}},"uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"teamNotFound":{"title":"teamNotFound","value":{"statusCode":403,"error":"Forbidden","message":"Team not found","data":{"code":"team_not_found"}}},"noPermission":{"title":"noPermission","value":{"statusCode":403,"error":"Forbidden","message":"You do not have permission to access this resource.","data":{"code":"no_permission"}}}},"exampleType":"examples"}},"exampleType":"examples"},"306f336f-da1a-4ccf-b7a1-2667eb125afb":{"description":"You have no domain with this name or ID.","content":{"application/json":{"schema":{"type":"object","description":"Standard error body.","properties":{"statusCode":{"type":"integer","uniqueKey":"statusCode","typeLabel":"integer"},"error":{"type":"string","description":"HTTP status text.","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"What went wrong.","uniqueKey":"message","typeLabel":"string"},"data":{"oneOf":[{"type":"object","description":"Extra details. When present, `code` is a stable, machine-readable error code.","properties":{"code":{"type":"string","uniqueKey":"data.oneOf.0.code","typeLabel":"string"}},"uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"null","description":"Extra details. When present, `code` is a stable, machine-readable error code.","properties":{"code":{"type":"string"}},"uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":404,"error":"Not Found","message":"Domain not found.","data":null},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"error":"Not Found","message":"Domain not found.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"4d3a8816-8487-4a6e-b38e-8e2a6022ea01":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Send your API token as `Authorization: Bearer \u003capi-token>`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"bd8bc5e8-6b21-4b52-96da-836fee1554b8":{"url":"https://api.liara.ir"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Send your API token as `Authorization: Bearer \u003capi-token>`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Send your API token as `Authorization: Bearer \u003capi-token>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"spec/paas-domains-disks.yaml"},"subdomain":"liara","siteName":"Liara OpenAPI Docs","title":"Get a domain - Liara OpenAPI Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T11:20:07.326Z","originalFileLocation":"paas-domains-disks/domains/get-a-domain.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns a domain, including the verificationCode and target you need for its DNS records. The response can include additional fields not listed here. With teamID, you need any permission on the app or bucket.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Liara OpenAPI Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/liara/c4FsEB7C_M7o5Gm9/_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/liara/c4FsEB7C_M7o5Gm9/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/liara/c4FsEB7C_M7o5Gm9/_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/liara/c4FsEB7C_M7o5Gm9/_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/liara/c4FsEB7C_M7o5Gm9/_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/liara/c4FsEB7C_M7o5Gm9/_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/liara/c4FsEB7C_M7o5Gm9/_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/liara/c4FsEB7C_M7o5Gm9/_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/liara/c4FsEB7C_M7o5Gm9/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a domain - Liara OpenAPI Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a domain, including the verificationCode and target you need for its DNS records. The response can include additional fields not listed here. With teamID, you need any permission on the app or bucket.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Liara OpenAPI Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.liara.ir/paas-domains-disks/domains/get-a-domain\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://liara.mintlify.app/_mintlify/api/og/v2?division=Domains\u0026amp;title=Get+a+domain\u0026amp;description=Returns+a+domain%2C+including+the+%60verificationCode%60+and+%60target%60+you+need+for+its+DNS+records.+The+response+can+include+additional+fields+not+listed+here.+With+%60\u0026amp;theme=caf04de85467f5bae16b4b9e\u0026amp;signature=1b77d4fb85a6fbaae11e7e878323f30da8b87323bf495773a1a13602a94e7d7b\">\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=\"Get a domain - Liara OpenAPI Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a domain, including the verificationCode and target you need for its DNS records. The response can include additional fields not listed here. With teamID, you need any permission on the app or bucket.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://liara.mintlify.app/_mintlify/api/og/v2?division=Domains\u0026amp;title=Get+a+domain\u0026amp;description=Returns+a+domain%2C+including+the+%60verificationCode%60+and+%60target%60+you+need+for+its+DNS+records.+The+response+can+include+additional+fields+not+listed+here.+With+%60\u0026amp;theme=caf04de85467f5bae16b4b9e\u0026amp;signature=1b77d4fb85a6fbaae11e7e878323f30da8b87323bf495773a1a13602a94e7d7b\">\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/liara/c4FsEB7C_M7o5Gm9/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Liara OpenAPI Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#009689\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.liara.ir/paas-domains-disks/domains/get-a-domain\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/paas-domains-disks/domains/get-a-domain.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.liara.ir/#organization\",\"name\":\"Liara OpenAPI Docs\",\"url\":\"https://developers.liara.ir\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/liara/2lAl_CkG1cEAkr-Y/logo.png?fit=max\u0026auto=format\u0026n=2lAl_CkG1cEAkr-Y\u0026q=85\u0026s=90f85cd2b2db4fc0e76ca4cf6fb468b5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.liara.ir#website\",\"name\":\"Liara OpenAPI Docs\",\"url\":\"https://developers.liara.ir\",\"publisher\":{\"@id\":\"https://developers.liara.ir/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.liara.ir/paas-domains-disks/domains/get-a-domain#webpage\",\"url\":\"https://developers.liara.ir/paas-domains-disks/domains/get-a-domain\",\"name\":\"Get a domain\",\"description\":\"Returns a domain, including the verificationCode and target you need for its DNS records. The response can include additional fields not listed here. With teamID, you need any permission on the app or bucket.\",\"dateModified\":\"2026-11-02T11:20:07.326Z\",\"isPartOf\":{\"@id\":\"https://developers.liara.ir#website\"},\"breadcrumb\":{\"@id\":\"https://developers.liara.ir/paas-domains-disks/domains/get-a-domain#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.liara.ir/paas-domains-disks/domains/get-a-domain#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Domains \u0026 Disks\",\"item\":\"https://developers.liara.ir/paas-domains-disks/domains/list-domains\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Domains\",\"item\":\"https://developers.liara.ir/paas-domains-disks/domains/list-domains\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a domain\",\"item\":\"https://developers.liara.ir/paas-domains-disks/domains/get-a-domain\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.liara.ir/paas-domains-disks/domains/get-a-domain#apireference\",\"headline\":\"Get a domain\",\"name\":\"Get a domain\",\"description\":\"Returns a domain, including the verificationCode and target you need for its DNS records. The response can include additional fields not listed here. With teamID, you need any permission on the app or bucket.\",\"url\":\"https://developers.liara.ir/paas-domains-disks/domains/get-a-domain\",\"mainEntityOfPage\":{\"@id\":\"https://developers.liara.ir/paas-domains-disks/domains/get-a-domain#webpage\"},\"dateModified\":\"2026-11-02T11:20:07.326Z\",\"publisher\":{\"@id\":\"https://developers.liara.ir/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.liara.ir#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Liara OpenAPI Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Liara OpenAPI Docs","nav":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.liara.ir"},{"anchor":"Blog","icon":"newspaper","href":"https://liara.ir/blog"}]},"products":[{"product":"Platform Core","icon":"layer-group","pages":[{"title":"Platform Core","href":"/pages/platform-core"}]},{"product":"PaaS","icon":"cloud","groups":[{"group":"Introduction","icon":"rocket","pages":[{"title":"PaaS API","href":"/pages/paas"}]},{"group":"Apps \u0026 Deployments","icon":"cube","pages":[{"group":"Apps","pages":[{"title":"List apps","deprecated":null,"version":null,"openapi":"/spec/paas.yaml get /v1/projects","href":"/paas/apps/list-apps"},{"title":"Create an app","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects","href":"/paas/apps/create-an-app"},{"title":"Check if an app name is available","deprecated":null,"version":null,"openapi":"/spec/paas.yaml get /v1/projects/{project_id}/check-availability","href":"/paas/apps/check-if-an-app-name-is-available"},{"title":"Get an app","deprecated":null,"version":null,"openapi":"/spec/paas.yaml get /v1/projects/{project_id}","href":"/paas/apps/get-an-app"},{"title":"Delete an app","deprecated":null,"version":null,"openapi":"/spec/paas.yaml delete /v1/projects/{project_id}","href":"/paas/apps/delete-an-app"},{"title":"Unfreeze an app","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/{projectID}/unfreeze","href":"/paas/apps/unfreeze-an-app"},{"title":"Get the npm audit report","deprecated":null,"version":null,"openapi":"/spec/paas.yaml get /v1/projects/{projectID}/npm-audit-report","href":"/paas/apps/get-the-npm-audit-report"}]},{"group":"Configuration","pages":[{"title":"Set environment variables","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/update-envs","href":"/paas/configuration/set-environment-variables"},{"title":"Change the app's port","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/update-port","href":"/paas/configuration/change-the-apps-port"},{"title":"Set custom DNS servers","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/update-dns","href":"/paas/configuration/set-custom-dns-servers"},{"title":"Change the app's plan","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/{project_id}/resize","href":"/paas/configuration/change-the-apps-plan"},{"title":"Change the app's bundle plan","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/{project_id}/resize-bundle-plan","href":"/paas/configuration/change-the-apps-bundle-plan"},{"title":"Turn an app on or off","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/{project_id}/actions/scale","href":"/paas/configuration/turn-an-app-on-or-off"},{"title":"Restart an app","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/{project_id}/actions/restart","href":"/paas/configuration/restart-an-app"}]},{"group":"Settings","pages":[{"title":"Make the filesystem read-only","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/{projectID}/read-only/enable","href":"/paas/settings/make-the-filesystem-read-only"},{"title":"Make the filesystem writable","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/{projectID}/read-only/disable","href":"/paas/settings/make-the-filesystem-writable"},{"title":"Turn on the default subdomain","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/{projectID}/default-subdomain/enable","href":"/paas/settings/turn-on-the-default-subdomain"},{"title":"Turn off the default subdomain","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/{projectID}/default-subdomain/disable","href":"/paas/settings/turn-off-the-default-subdomain"},{"title":"Turn on zero-downtime deployment","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/{projectID}/zero-downtime/enable","href":"/paas/settings/turn-on-zero-downtime-deployment"},{"title":"Turn off zero-downtime deployment","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/{projectID}/zero-downtime/disable","href":"/paas/settings/turn-off-zero-downtime-deployment"},{"title":"Turn on a fixed outbound IP","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/{projectID}/fixed-ip/enable","href":"/paas/settings/turn-on-a-fixed-outbound-ip"},{"title":"Turn off the fixed outbound IP","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/projects/{projectID}/fixed-ip/disable","href":"/paas/settings/turn-off-the-fixed-outbound-ip"}]},{"group":"Deployments","pages":[{"title":"Upload source code","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v2/projects/{project_id}/sources","href":"/paas/deployments/upload-source-code"},{"title":"Deploy a release","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v2/projects/{project_id}/releases","href":"/paas/deployments/deploy-a-release"},{"title":"List releases","deprecated":null,"version":null,"openapi":"/spec/paas.yaml get /v1/projects/{project_id}/releases","href":"/paas/deployments/list-releases"},{"title":"Get the running release","deprecated":null,"version":null,"openapi":"/spec/paas.yaml get /v1/projects/{project_id}/releases/current","href":"/paas/deployments/get-the-running-release"},{"title":"Get a release","deprecated":null,"version":null,"openapi":"/spec/paas.yaml get /v1/releases/{releaseID}","href":"/paas/deployments/get-a-release"},{"title":"Get build logs","deprecated":null,"version":null,"openapi":"/spec/paas.yaml get /v2/releases/{releaseID}/build-logs","href":"/paas/deployments/get-build-logs"},{"title":"Cancel a build","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v2/releases/{releaseID}/cancel","href":"/paas/deployments/cancel-a-build"},{"title":"Roll back to a release","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/releases/{releaseID}/rollback","href":"/paas/deployments/roll-back-to-a-release"},{"title":"Get a release's source code link","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v2/releases/{releaseID}/source","href":"/paas/deployments/get-a-releases-source-code-link"}]},{"group":"Logs, Metrics \u0026 Events","pages":[{"title":"Get app logs","deprecated":null,"version":null,"openapi":"/spec/paas.yaml get /v2/projects/{project_id}/logs","href":"/paas/logs-metrics-\u0026-events/get-app-logs"},{"title":"Get log volume over time","deprecated":null,"version":null,"openapi":"/spec/paas.yaml get /v2/projects/{project_id}/logs/chart","href":"/paas/logs-metrics-\u0026-events/get-log-volume-over-time"},{"title":"Get current resource usage","deprecated":null,"version":null,"openapi":"/spec/paas.yaml get /v1/projects/{project_id}/metrics/summary","href":"/paas/logs-metrics-\u0026-events/get-current-resource-usage"},{"title":"Get resource usage over time","deprecated":null,"version":null,"openapi":"/spec/paas.yaml get /v1/projects/{project_id}/metrics/{stat}","href":"/paas/logs-metrics-\u0026-events/get-resource-usage-over-time"},{"title":"Get app events","deprecated":null,"version":null,"openapi":"/spec/paas.yaml get /v1/projects/{project_id}/events","href":"/paas/logs-metrics-\u0026-events/get-app-events"}]},{"group":"Networks","pages":[{"title":"List networks","deprecated":null,"version":null,"openapi":"/spec/paas.yaml get /v1/networks","href":"/paas/networks/list-networks"},{"title":"Create a network","deprecated":null,"version":null,"openapi":"/spec/paas.yaml post /v1/networks","href":"/paas/networks/create-a-network"}]}]},{"group":"Git Integration \u0026 One-Click Apps","icon":"code-branch","pages":[{"group":"GitHub Account","pages":[{"title":"Start connecting your GitHub account","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml get /v1/git-provider-integration/{provider}","href":"/paas-git-oneclick/github-account/start-connecting-your-github-account"},{"title":"Finish connecting your GitHub account","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml post /v1/git-provider-integration/{provider}","href":"/paas-git-oneclick/github-account/finish-connecting-your-github-account"},{"title":"Disconnect your GitHub account","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml delete /v1/git-provider-integration/{provider}","href":"/paas-git-oneclick/github-account/disconnect-your-github-account"},{"title":"Refresh GitHub account details","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml post /v1/git-integration/{provider}/sync","href":"/paas-git-oneclick/github-account/refresh-github-account-details"}]},{"group":"Repositories","pages":[{"title":"List your GitHub organizations","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml get /v1/git-provider-integration/{provider}/organizations","href":"/paas-git-oneclick/repositories/list-your-github-organizations"},{"title":"Get the GitHub app installation link","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml get /v1/git-repository-integration/{provider}/connect","href":"/paas-git-oneclick/repositories/get-the-github-app-installation-link"},{"title":"List repositories","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml get /v1/git-repository-integration/{provider}/repositories","href":"/paas-git-oneclick/repositories/list-repositories"},{"title":"List a repository's branches","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml get /v1/git-repository-integration/{provider}/show-repository-branches","href":"/paas-git-oneclick/repositories/list-a-repositorys-branches"}]},{"group":"App Repository","pages":[{"title":"Get the app's linked repository","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml get /v1/projects/{projectID}/git-repository-integration/{provider}","href":"/paas-git-oneclick/app-repository/get-the-apps-linked-repository"},{"title":"Change deploy settings","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml put /v1/projects/{projectID}/git-repository-integration/{provider}","href":"/paas-git-oneclick/app-repository/change-deploy-settings"},{"title":"Link a repository to an app","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml post /v1/projects/{projectID}/git-repository-integration/{provider}","href":"/paas-git-oneclick/app-repository/link-a-repository-to-an-app"},{"title":"Unlink the repository","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml delete /v1/projects/{projectID}/git-repository-integration/{provider}","href":"/paas-git-oneclick/app-repository/unlink-the-repository"},{"title":"Deploy the latest commit","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml post /v1/projects/{projectID}/git-repository-integration/{provider}/manual-deploy","href":"/paas-git-oneclick/app-repository/deploy-the-latest-commit"},{"title":"Get a failed automatic deployment","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml get /v1/projects/{project_id}/repository-deployment-failures/{connectedRepositoryID}/{repositoryDeploymentFailureID}","href":"/paas-git-oneclick/app-repository/get-a-failed-automatic-deployment"}]},{"group":"One-Click Apps","pages":[{"title":"List one-click apps","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml get /v1/one-click-apps","href":"/paas-git-oneclick/one-click-apps/list-one-click-apps"},{"title":"Get a one-click app","deprecated":null,"version":null,"openapi":"/spec/paas-git-oneclick.yaml get /v1/one-click-apps/{oneClickAppName}","href":"/paas-git-oneclick/one-click-apps/get-a-one-click-app"}]}]},{"group":"Domains \u0026 Disks","icon":"disk","pages":[{"group":"Domains","pages":[{"title":"List domains","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml get /v1/domains","href":"/paas-domains-disks/domains/list-domains"},{"title":"Add a domain","description":"Adds a domain to an app or a bucket. It's `ACTIVE` right away if its root domain is already active on your account or is a zone in Liara DNS; otherwise it's `PENDING` until you verify it. The number of domains per app depends on the app's bundle plan, and wildcard domains need a bundle plan with unlimited domains. Your account must be verified. With `teamID`, you need `operate` or `manage` on the app or bucket.","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml post /v1/domains","href":"/paas-domains-disks/domains/add-a-domain"},{"title":"Get a domain","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml get /v1/domains/{domainName}","href":"/paas-domains-disks/domains/get-a-domain"},{"title":"Check a domain's DNS records","description":"Checks the domain's ownership, routing and certificate records, saves the results (`status`, `CNameRecord`, `acmeRecord`, `behindCdn`) and returns the updated domain. The response can include additional fields not listed here. With `teamID`, you need any permission on the app or bucket.","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml get /v1/domains/{domainID}/check","href":"/paas-domains-disks/domains/check-a-domains-dns-records"},{"title":"Remove a domain","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml delete /v1/domains/{domainID}","href":"/paas-domains-disks/domains/remove-a-domain"}]},{"group":"Domain SSL \u0026 Redirects","pages":[{"title":"Request an SSL certificate","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml post /v1/domains/provision-ssl-certs","href":"/paas-domains-disks/domain-ssl-\u0026-redirects/request-an-ssl-certificate"},{"title":"Turn off SSL","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml post /v1/domains/{domainID}/ssl/disable","href":"/paas-domains-disks/domain-ssl-\u0026-redirects/turn-off-ssl"},{"title":"Get certificate history","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml get /v1/domains/{domainName}/certs-history","href":"/paas-domains-disks/domain-ssl-\u0026-redirects/get-certificate-history"},{"title":"Redirect a domain","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml post /v1/domains/{domainID}/set-redirect","href":"/paas-domains-disks/domain-ssl-\u0026-redirects/redirect-a-domain"}]},{"group":"Disks","pages":[{"title":"List an app's disks","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml get /v1/projects/{projectID}/disks","href":"/paas-domains-disks/disks/list-an-apps-disks"},{"title":"Create a disk","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml post /v1/projects/{project_id}/disks","href":"/paas-domains-disks/disks/create-a-disk"},{"title":"Get a disk","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml get /v1/projects/{project_id}/disks/{name}","href":"/paas-domains-disks/disks/get-a-disk"},{"title":"Delete a disk","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml delete /v1/projects/{projectID}/disks/{name}","href":"/paas-domains-disks/disks/delete-a-disk"},{"title":"Grow a disk","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml post /v1/projects/{project_id}/disks/{name}/resize","href":"/paas-domains-disks/disks/grow-a-disk"},{"title":"Get disk usage","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml get /v1/projects/{projectID}/disks/{name}/metrics","href":"/paas-domains-disks/disks/get-disk-usage"}]},{"group":"Disk Backups","pages":[{"title":"List disk backups","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml get /v1/projects/{projectID}/disks/{name}/backups","href":"/paas-domains-disks/disk-backups/list-disk-backups"},{"title":"Back up a disk now","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml post /v1/projects/{projectID}/disks/{name}/backups","href":"/paas-domains-disks/disk-backups/back-up-a-disk-now"},{"title":"Get a backup download link","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml post /v1/projects/{projectID}/disks/{name}/backups/{interval}/{backup}/download","href":"/paas-domains-disks/disk-backups/get-a-backup-download-link"},{"title":"Restore a disk backup","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml post /v2/projects/{projectID}/disks/{name}/restore","href":"/paas-domains-disks/disk-backups/restore-a-disk-backup"}]},{"group":"FTP Access","pages":[{"title":"List a disk's FTP accounts","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml get /v1/projects/{project_id}/disks/{diskName}/ftp","href":"/paas-domains-disks/ftp-access/list-a-disks-ftp-accounts"},{"title":"Create an FTP account","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml post /v1/projects/{project_id}/disks/{diskName}/ftp","href":"/paas-domains-disks/ftp-access/create-an-ftp-account"},{"title":"Delete an FTP account","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml delete /v1/ftp/{username}","href":"/paas-domains-disks/ftp-access/delete-an-ftp-account"},{"title":"Check if an FTP username is available","deprecated":null,"version":null,"openapi":"/spec/paas-domains-disks.yaml get /v1/ftp/{username}/check-availability","href":"/paas-domains-disks/ftp-access/check-if-an-ftp-username-is-available"}]}]}]},{"product":"DBaaS","icon":"database","pages":[{"title":"DBaaS","href":"/pages/dbaas"}]},{"product":"Object Storage","icon":"bucket","pages":[{"title":"Object Storage","href":"/pages/object-storage"}]},{"product":"DNS","icon":"globe","pages":[{"title":"DNS","href":"/pages/dns"}]},{"product":"Mail","icon":"envelope","pages":[{"title":"Mail","href":"/pages/mail"}]},{"product":"File Browser","icon":"folder","pages":[{"title":"File Browser","href":"/pages/file-browser"}]},{"product":"IaaS","icon":"server","pages":[{"title":"IaaS","href":"/pages/iaas"}]},{"product":"AI","icon":"brain","pages":[{"title":"AI","href":"/pages/ai"}]},{"product":"Billing","icon":"credit-card","pages":[{"title":"Billing","href":"/billing/billing/get-current-user-billing-information"}]},{"product":"Account","icon":"user","pages":[{"title":"Account","href":"/account/user/get-current-user-and-console-information"}]}]},"basePath":"","title":"Get a domain - Liara OpenAPI Docs","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}