Skip to main content
GET
Get Database Status by ID
string
required
The ID of the database to retrieve status for. If the database belongs to a workspace, pass its ID in the workspace_id query parameter.
string
If the database belongs to a workspace, the workspace’s ID. Required for workspace members acting on a database they don’t own.
A stopped database answers 200, not an error. The container of a stopped database does not exist — it is removed on stop — and that is a normal state, not a failure. The API returns 200 with status: "stopped", running: false and every metric zeroed. Only a genuine failure to read the status returns 500.

Response

object
The status and resource usage details of the database.

Error Responses

string
The error code indicating the reason for failure. Possible values:
  • DATABASE_NOT_FOUND: The specified database does not exist.
  • FORBIDDEN: The user does not have permission to access the database.
  • INTERNAL_SERVER_ERROR: The status could not be read. A stopped database is not this case — see the note above.
string
A descriptive message providing additional details about the error.