Portabase Logo
Portabase DashboardAPIDatabases

Get database by ID

GET
/databases/{id}

Authorization

apiKeyAuth
x-api-key<token>

API key generated from the Portabase dashboard. Pass as the x-api-key header.

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/databases/123e4567-e89b-12d3-a456-426614174000"
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "agentDatabaseId": "78f4c143-eccc-413e-8e8a-868364d45b73",
    "name": "string",
    "dbms": "postgresql",
    "description": "string",
    "backupPolicy": "string",
    "isWaitingForBackup": true,
    "backupToRestore": "string",
    "healthErrorCount": -2147483648,
    "agentId": "bc309ecf-5f66-4057-93c5-6611cc9cb7b2",
    "lastContact": "2019-08-24T14:15:22Z",
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "updatedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z"
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}