---
title: "Get postgres status"
method: GET
path: "/api/projects/{projectName}/postgres/{postgresName}/status"
tags: ["postgres"]
---

# Get postgres status

`GET /api/projects/{projectName}/postgres/{postgresName}/status`

## Request

- Base URL: `https://api.hostim.dev`
- URL: `https://api.hostim.dev/api/projects/{projectName}/postgres/{postgresName}/status`
- Auth: HTTP bearer

## Path parameters

- `projectName` string, required
- `postgresName` string, required

## Response `200`

OK

- PostgresStatus
  - `usedMB` integer, required: The used storage of PostgreSQL database in MB
  - `role` 'standard' | 'cleaner' | 'revoked' | 'reader', required: The role of the PostgreSQL instance
  - `migrationStatus` 'None' | 'Scheduled' | 'InProgress' | 'Succeeded' | 'Failed', nullable: The migration status of the PostgreSQL instance
  - `created` boolean, required: Whether the PostgreSQL database instance is created or not
  - `installedExtensions` string[]: Extensions actually installed in the database, including ones installed outside of the requested list

## Other responses

- `401`: User is not authorized
- `404`: Postgres not found
- `500`: Internal server error

---

[API](https://skmtc.dev/hostim/apis/hostim-api.md) · [All operations](https://skmtc.dev/hostim/apis/hostim-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostim/apis/hostim-api/revisions/37c35e1026a9?raw)