Returns a database with its connection details and settings. The password is included once the database has been deployed. The response can include additional fields not listed here. Team permission: view, operate or manage.
{"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":"dbaas/databases/get-a-database","slug":"/dbaas/databases/get-a-database","pageMetadata":{"title":"Get a database","description":"Returns a database with its connection details and settings. The password is included once the database has been deployed. The response can include additional fields not listed here. Team permission: `view`, `operate` or `manage`.","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml get /v1/databases/{databaseID}","href":"/dbaas/databases/get-a-database","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 database with its connection details and settings. The password is included once the database has been deployed. The response can include additional fields not listed here. Team permission: \", _jsx(_components.code, {\n children: \"view\"\n }), \", \", _jsx(_components.code, {\n children: \"operate\"\n }), \" or \", _jsx(_components.code, {\n children: \"manage\"\n }), \".\"]\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 database","description":"Returns a database with its connection details and settings. The password is included once the database has been deployed. The response can include additional fields not listed here. Team permission: `view`, `operate` or `manage`.","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml get /v1/databases/{databaseID}","href":"/dbaas/databases/get-a-database","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Databases"],"operationId":"getDatabase","summary":"Get a database","description":"Returns a database with its connection details and settings. The password is included once the database has been deployed. The response can include additional fields not listed here. Team permission: `view`, `operate` or `manage`.","parameters":["5e551d9f-80d2-4507-b6d1-69924271daf7","2b2eed97-4344-411e-a20c-e4a7a6634961"],"responses":{"200":"7a540bfe-5630-411a-94ce-1f0a7079c31f","400":"2023872f-850f-4a23-887c-42cc07f2b6b0","401":"05d3587e-0948-4235-a78b-29973d1bc542","403":"1ed0d014-56d1-415e-a232-79c568adc7d7","404":"d1812fe5-ede1-4ad5-9ebb-c9d75ea1461b"},"method":"get","type":"path","servers":["41f86e5c-108b-430d-bfc9-23addddff199"],"security":["3e603956-8263-4558-90c1-b0f1412a43df"],"path":"/v1/databases/{databaseID}","baseUrlOptions":["https://api.liara.ir"],"title":"Get a database","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5e551d9f-80d2-4507-b6d1-69924271daf7":{"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"},"2b2eed97-4344-411e-a20c-e4a7a6634961":{"name":"databaseID","in":"path","required":true,"description":"The database's `_id`.","schema":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"The database's `_id`.\n24-character hexadecimal ID.","isRequired":true,"uniqueKey":"","typeLabel":"string"},"example":"000000000000000000000300"}},"responses":{"7a540bfe-5630-411a-94ce-1f0a7079c31f":{"description":"The database.","content":{"application/json":{"schema":{"type":"object","properties":{"database":{"type":"object","properties":{"_id":{"type":"string","uniqueKey":"database._id","typeLabel":"string"},"hostname":{"type":"string","uniqueKey":"database.hostname","typeLabel":"string"},"type":{"type":"string","enum":["mysql","mariadb","postgres","mongodb","redis","mssql","elasticsearch","rabbitmq","clickhouse"],"uniqueKey":"database.type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"`STARTED` and `DEPLOYED`: being created. `RUNNING`: running normally. `FROZEN`: stopped, for example because the balance ran out. `FAILED`: creation failed. `CRASH_LOOP`: keeps crashing on start. `SUSPENDED`: suspended by Liara.","enum":["STARTED","DEPLOYED","RUNNING","FROZEN","FAILED","CRASH_LOOP","SUSPENDED"],"uniqueKey":"database.status","typeLabel":"enum\u003cstring>"},"planID":{"type":"string","uniqueKey":"database.planID","typeLabel":"string"},"bundlePlanID":{"type":"string","uniqueKey":"database.bundlePlanID","typeLabel":"string"},"scale":{"type":"integer","description":"`1` if the database is on, `0` if it's off.","uniqueKey":"database.scale","typeLabel":"integer"},"publicNetwork":{"type":"boolean","uniqueKey":"database.publicNetwork","typeLabel":"boolean"},"network":{"type":"object","properties":{"_id":{"type":"string","uniqueKey":"database.network._id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"database.network.name","typeLabel":"string"},"node":{"type":"object","properties":{"host":{"type":"string","description":"Host for connecting over the public network.","uniqueKey":"database.network.node.host","typeLabel":"string"}},"uniqueKey":"database.network.node","typeLabel":"object"}},"uniqueKey":"database.network","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","uniqueKey":"database.created_at","typeLabel":"string\u003cdate-time>"},"version":{"type":"string","uniqueKey":"database.version","typeLabel":"string"},"port":{"type":"integer","description":"Port for connecting over the public network.","uniqueKey":"database.port","typeLabel":"integer"},"internalPort":{"type":"integer","description":"Port for connecting from the database's network.","uniqueKey":"database.internalPort","typeLabel":"integer"},"username":{"oneOf":[{"type":"string","description":"User name to connect with (`null` for `redis`).","uniqueKey":"database.username.oneOf.0","typeLabel":"string"},{"type":"null","description":"User name to connect with (`null` for `redis`).","uniqueKey":"database.username.oneOf.1","typeLabel":"null"}],"uniqueKey":"database.username","typeLabel":"string | null"},"root_password":{"type":"string","description":"Password. Only returned once the database has been deployed.","uniqueKey":"database.root_password","typeLabel":"string"},"dbName":{"type":"string","description":"Default database name, if one was set.","uniqueKey":"database.dbName","typeLabel":"string"},"volumeSize":{"type":"number","description":"Disk size in GB.","uniqueKey":"database.volumeSize","typeLabel":"number"},"metaData":{"type":"object","description":"Options and settings set on the database.","uniqueKey":"database.metaData","typeLabel":"object"},"hourlyPrice":{"type":"number","description":"Hourly cost of the database's plan.","uniqueKey":"database.hourlyPrice","typeLabel":"number"},"bundleHourlyPrice":{"type":"number","description":"Hourly cost of the bundle plan.","uniqueKey":"database.bundleHourlyPrice","typeLabel":"number"},"controlPanelSatus":{"oneOf":[{"type":"string","description":"State of the web control panel: `no-control-panel`, or the state of its deployment (for example `DEPLOYING` or `READY`).","uniqueKey":"database.controlPanelSatus.oneOf.0","typeLabel":"string"},{"type":"null","description":"State of the web control panel: `no-control-panel`, or the state of its deployment (for example `DEPLOYING` or `READY`).","uniqueKey":"database.controlPanelSatus.oneOf.1","typeLabel":"null"}],"uniqueKey":"database.controlPanelSatus","typeLabel":"string | null"}},"uniqueKey":"database","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"database":{"_id":"000000000000000000000300","hostname":"my-db","type":"postgres","version":"17.10","status":"RUNNING","planID":"small-g2","bundlePlanID":"standard","scale":1,"publicNetwork":true,"port":30000,"internalPort":5432,"username":"root","root_password":"\u003cpassword>","dbName":"postgres","volumeSize":5,"network":{"_id":"000000000000000000000160","name":"my-network","node":{"host":"\u003cpublic-host>"}},"metaData":{"pgvector":true},"hourlyPrice":100,"bundleHourlyPrice":50,"controlPanelSatus":"no-control-panel","created_at":"2026-01-01T08:00:00.000Z"}},"examples":{"Example":{"title":"Example","value":{"database":{"_id":"000000000000000000000300","hostname":"my-db","type":"postgres","version":"17.10","status":"RUNNING","planID":"small-g2","bundlePlanID":"standard","scale":1,"publicNetwork":true,"port":30000,"internalPort":5432,"username":"root","root_password":"\u003cpassword>","dbName":"postgres","volumeSize":5,"network":{"_id":"000000000000000000000160","name":"my-network","node":{"host":"\u003cpublic-host>"}},"metaData":{"pgvector":true},"hourlyPrice":100,"bundleHourlyPrice":50,"controlPanelSatus":"no-control-panel","created_at":"2026-01-01T08:00:00.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"2023872f-850f-4a23-887c-42cc07f2b6b0":{"description":"The body or a parameter is invalid (`message` says which), or `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"},"examples":{"validation":{"title":"validation","value":{"statusCode":400,"error":"Bad Request","message":"Invalid id"}},"invalidTeamID":{"title":"invalidTeamID","value":{"statusCode":400,"error":"Bad Request","message":"Invalid team ID.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"05d3587e-0948-4235-a78b-29973d1bc542":{"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"},"1ed0d014-56d1-415e-a232-79c568adc7d7":{"description":"With `teamID`: you aren't a member of the team (`team_not_found`), or you don't have the required permission on this database (`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"},"d1812fe5-ede1-4ad5-9ebb-c9d75ea1461b":{"description":"The database doesn't exist.","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":"Database not found.","data":null},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"error":"Not Found","message":"Database not found.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"3e603956-8263-4558-90c1-b0f1412a43df":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Send your API token as `Authorization: Bearer \u003capi-token>`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"41f86e5c-108b-430d-bfc9-23addddff199":{"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/dbaas.yaml"},"subdomain":"liara","siteName":"Liara OpenAPI Docs","title":"Get a database - Liara OpenAPI Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T11:20:07.590Z","originalFileLocation":"dbaas/databases/get-a-database.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 database with its connection details and settings. The password is included once the database has been deployed. The response can include additional fields not listed here. Team permission: view, operate or manage.\">\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 database - Liara OpenAPI Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a database with its connection details and settings. The password is included once the database has been deployed. The response can include additional fields not listed here. Team permission: view, operate or manage.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Liara OpenAPI Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.liara.ir/dbaas/databases/get-a-database\">\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=Databases\u0026amp;title=Get+a+database\u0026amp;description=Returns+a+database+with+its+connection+details+and+settings.+The+password+is+included+once+the+database+has+been+deployed.+The+response+can+include+additional+f\u0026amp;theme=caf04de85467f5bae16b4b9e\u0026amp;signature=50931b683449f5dfec3fa018ee1349d74b39061daaf1cef6b3f59d3615baefe7\">\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 database - Liara OpenAPI Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a database with its connection details and settings. The password is included once the database has been deployed. The response can include additional fields not listed here. Team permission: view, operate or manage.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://liara.mintlify.app/_mintlify/api/og/v2?division=Databases\u0026amp;title=Get+a+database\u0026amp;description=Returns+a+database+with+its+connection+details+and+settings.+The+password+is+included+once+the+database+has+been+deployed.+The+response+can+include+additional+f\u0026amp;theme=caf04de85467f5bae16b4b9e\u0026amp;signature=50931b683449f5dfec3fa018ee1349d74b39061daaf1cef6b3f59d3615baefe7\">\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/dbaas/databases/get-a-database\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/dbaas/databases/get-a-database.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/dbaas/databases/get-a-database#webpage\",\"url\":\"https://developers.liara.ir/dbaas/databases/get-a-database\",\"name\":\"Get a database\",\"description\":\"Returns a database with its connection details and settings. The password is included once the database has been deployed. The response can include additional fields not listed here. Team permission: view, operate or manage.\",\"dateModified\":\"2026-11-02T11:20:07.590Z\",\"isPartOf\":{\"@id\":\"https://developers.liara.ir#website\"},\"breadcrumb\":{\"@id\":\"https://developers.liara.ir/dbaas/databases/get-a-database#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.liara.ir/dbaas/databases/get-a-database#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Endpoints\",\"item\":\"https://developers.liara.ir/dbaas/databases/list-databases\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Databases\",\"item\":\"https://developers.liara.ir/dbaas/databases/list-databases\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a database\",\"item\":\"https://developers.liara.ir/dbaas/databases/get-a-database\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.liara.ir/dbaas/databases/get-a-database#apireference\",\"headline\":\"Get a database\",\"name\":\"Get a database\",\"description\":\"Returns a database with its connection details and settings. The password is included once the database has been deployed. The response can include additional fields not listed here. Team permission: view, operate or manage.\",\"url\":\"https://developers.liara.ir/dbaas/databases/get-a-database\",\"mainEntityOfPage\":{\"@id\":\"https://developers.liara.ir/dbaas/databases/get-a-database#webpage\"},\"dateModified\":\"2026-11-02T11:20:07.590Z\",\"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","pages":[{"title":"PaaS","href":"/pages/paas"}]},{"product":"DBaaS","icon":"database","groups":[{"group":"Introduction","icon":"rocket","pages":[{"title":"DBaaS API","href":"/pages/dbaas"}]},{"group":"API Endpoints","icon":"file-code","pages":[{"group":"Databases","pages":[{"title":"List databases","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml get /v1/databases","href":"/dbaas/databases/list-databases"},{"title":"Create a database","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml post /v1/databases","href":"/dbaas/databases/create-a-database"},{"title":"List database versions","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml get /v1/databases/versions","href":"/dbaas/databases/list-database-versions"},{"title":"Check if a hostname is available","description":"Checks whether a hostname can be used for a new database.","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml get /v1/databases/{hostname}/check-availability","href":"/dbaas/databases/check-if-a-hostname-is-available"},{"title":"Get a database","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml get /v1/databases/{databaseID}","href":"/dbaas/databases/get-a-database"},{"title":"Delete a database","description":"Deletes a database. Only running, frozen or failed databases can be deleted. Team permission: `manage`.","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml delete /v1/databases/{databaseID}","href":"/dbaas/databases/delete-a-database"},{"title":"Unfreeze a database","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml post /v1/databases/{databaseID}/unfreeze","href":"/dbaas/databases/unfreeze-a-database"}]},{"group":"Configuration","pages":[{"title":"Change the database's plan","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml post /v1/databases/{databaseID}/resize","href":"/dbaas/configuration/change-the-databases-plan"},{"title":"Change the database's bundle plan","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml post /v1/databases/{databaseID}/resize-bundle-plan","href":"/dbaas/configuration/change-the-databases-bundle-plan"},{"title":"Turn a database on or off","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml post /v1/databases/{databaseID}/actions/scale","href":"/dbaas/configuration/turn-a-database-on-or-off"},{"title":"Change database settings","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml patch /v1/databases/{databaseID}/settings","href":"/dbaas/configuration/change-database-settings"},{"title":"Turn on public network access","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml patch /v1/databases/{databaseID}/public-network/enable","href":"/dbaas/configuration/turn-on-public-network-access"},{"title":"Turn off public network access","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml patch /v1/databases/{databaseID}/public-network/disable","href":"/dbaas/configuration/turn-off-public-network-access"},{"title":"Reset the database password","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml patch /v2/databases/{databaseID}/reset-password","href":"/dbaas/configuration/reset-the-database-password"},{"title":"Switch MongoDB between standalone and replica set","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml patch /v2/databases/{databaseID}/switch-mongo-mode","href":"/dbaas/configuration/switch-mongodb-between-standalone-and-replica-set"},{"title":"Turn on the web control panel","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml post /v1/databases/{databaseID}/control-panel/enable","href":"/dbaas/configuration/turn-on-the-web-control-panel"}]},{"group":"Backups","pages":[{"title":"List backups","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml get /v1/databases/{databaseID}/backups","href":"/dbaas/backups/list-backups"},{"title":"Back up a database now","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml post /v1/databases/{databaseID}/backups","href":"/dbaas/backups/back-up-a-database-now"},{"title":"Get a backup download link","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml post /v1/databases/{databaseID}/backups/{interval}/{backup}/download","href":"/dbaas/backups/get-a-backup-download-link"},{"title":"Import a SQL Server backup file","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml post /v1/databases/{databaseID}/mssql-bak","href":"/dbaas/backups/import-a-sql-server-backup-file"},{"title":"Import a ClickHouse backup file","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml post /v1/databases/{databaseID}/clickhouse-bak","href":"/dbaas/backups/import-a-clickhouse-backup-file"}]},{"group":"Metrics \u0026 Events","pages":[{"title":"List background operations","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml get /v2/databases/{databaseID}/operations-status","href":"/dbaas/metrics-\u0026-events/list-background-operations"},{"title":"Get current resource usage","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml get /v1/databases/{databaseID}/metrics/summary","href":"/dbaas/metrics-\u0026-events/get-current-resource-usage"},{"title":"Get resource usage over time","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml get /v1/databases/{databaseID}/metrics/{stat}","href":"/dbaas/metrics-\u0026-events/get-resource-usage-over-time"},{"title":"Get database events","deprecated":null,"version":null,"openapi":"/spec/dbaas.yaml get /v1/databases/{databaseID}/events","href":"/dbaas/metrics-\u0026-events/get-database-events"}]}]}]},{"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 database - 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"]}