Databases
Get database
Returns the database with the given ID.
GET
/v1/databases/{databaseId}Returns the database with the given ID.
AuthorizationBearer <token>
OAuth2 authentication
In: header
Scope: workspace:admin, offline_access
Path Parameters
databaseId*string
Match
^(db_)?([cC][^\s-]{8,}|[a-z0-9]+)$Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/databases/string"{ "data": { "id": "string", "type": "database", "url": "http://example.com", "name": "string", "status": "failure", "createdAt": "2019-08-24T14:15:22Z", "isDefault": true, "defaultConnectionId": "string", "connections": [ { "id": "string", "type": "connection", "url": "http://example.com", "name": "string", "createdAt": "2019-08-24T14:15:22Z", "kind": "postgres", "endpoints": { "direct": { "host": "string", "port": 0 }, "pooled": { "host": "string", "port": 0 }, "accelerate": { "host": "string", "port": 0 } }, "directConnection": { "host": "string", "pass": "string", "user": "string" }, "database": { "id": "string", "url": "http://example.com", "name": "string" } } ], "project": { "id": "string", "url": "http://example.com", "name": "string" }, "region": { "id": "string", "name": "string" }, "source": { "type": "empty" }, "branchId": "string" }}