Get database

GET/v1/databases/{databaseId}

How to call this endpoint

Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.

Path, query, and header parameters

These parameters control which ACP object the endpoint acts on and how the request is processed.

Path parameters
NameLocationTypeRequiredDescription
databaseIdpathstringYesDatabase ID
Query parameters
None.

Body schema

This endpoint does not require a request body.

None.

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Database detailsapplication/json
FieldTypeRequiredDescription
databaseobjectNo
database.idstringNoUnique identifier.
database.userIdstringNoUser ID.
database.projectIdstringNoProject ID.
database.namestringNoHuman-readable name.
database.descriptionstringNoHuman-readable description.
database.providerfirestoreNo
database.locationstringNo
database.statusactive | provisioning | errorNoCurrent lifecycle status.
database.firestoreNamespacestringNo
database.metadataobjectNoFree-form metadata object.
database.createdAtstringNoISO 8601 timestamp.
database.updatedAtstringNoISO 8601 timestamp.
Get database
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow