> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vertracloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Database Status by ID

> Retrieves the current status and resource usage of a database by its ID.

<ParamField path="id" type="string" required>
  The ID of the database to retrieve status for. If the database belongs to an workspace, include the workspace\_id in the format `dbId-workspace_id`.
</ParamField>

### Response

<ResponseField name="response" type="object">
  The status and resource usage details of the database.

  <Expandable title="Toggle object">
    <ResponseField name="cpu" type="number">
      The CPU usage percentage.
    </ResponseField>

    <ResponseField name="ram" type="number">
      The RAM usage in MB.
    </ResponseField>

    <ResponseField name="storage" type="number">
      The storage usage in MB.
    </ResponseField>

    <ResponseField name="status" type="string">
      The database’s status (e.g., `running`).
    </ResponseField>

    <ResponseField name="running" type="boolean">
      Indicates whether the database is currently running.
    </ResponseField>

    <ResponseField name="network" type="object">
      Rede usage details.

      <Expandable title="Toggle object">
        <ResponseField name="total" type="string">
          Inbound network traffic.
        </ResponseField>

        <ResponseField name="now" type="string">
          Outbound network traffic.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="uptime" type="number">
      The database’s uptime in seconds.
    </ResponseField>

    <ResponseField name="created_at" type="string" format="date-time">
      The timestamp when the database was created.
    </ResponseField>

    <ResponseField name="updated_at" type="string" format="date-time">
      The timestamp when the database was last updated.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json Response theme={null}
  {
    "response": {
      "cpu": 12.3,
      "ram": 256,
      "storage": 512,
      "status": "running",
      "running": true,
      "network": {
        "total": "320.15KB ↓ 20.10KB ↑",
        "now": "5.00KB ↑ 1.00KB ↓"
      },
      "uptime": 7200,
      "created_at": "2026-03-09T15:51:47.234Z",
      "updated_at": "2026-03-11T15:06:41.449Z"
    }
  }
  ```
</ResponseExample>

### Error Responses

<ResponseField name="code" type="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`: An error occurred while retrieving the status.
</ResponseField>

<ResponseField name="message" type="string">
  A descriptive message providing additional details about the error.
</ResponseField>

<ResponseExample>
  ```json Error Response (404) theme={null}
  {
    "code": "DATABASE_NOT_FOUND"
  }
  ```

  ```json Error Response (401) theme={null}
  {
    "code": "FORBIDDEN"
  }
  ```

  ```json Error Response (500) theme={null}
  {
    "code": "INTERNAL_SERVER_ERROR"
  }
  ```
</ResponseExample>