Skip to main content
GET
/
v2
/
databases
/
{databaseId}
Get Database Info
curl --request GET \
  --url https://api.squarecloud.app/v2/databases/{databaseId} \
  --header 'Authorization: <authorization>'
{
  "status": "success",
  "response": {
    "name": "my-database",
    "id": "db1234567890",
    "owner": "313397145698959364",
    "cluster": "suki-cluster",
    "ram": 1024,
    "type": "mongodb",
    "port": 27017,
    "created_at": "2023-01-15T10:00:00Z"
  }
}
​
Authorization
string
required
The API key for your account. You can find this in your account settings.
​
databaseId
string
required
The ID of the database. You can find this in the Square Cloud dashboard.

​
Response

​
status
string
Indicates whether the call was successful.. success if successful, error if not.
​
response
object
The contents of the response.
{
  "status": "success",
  "response": {
    "name": "my-database",
    "id": "db1234567890",
    "owner": "313397145698959364",
    "cluster": "suki-cluster",
    "ram": 1024,
    "type": "mongodb",
    "port": 27017,
    "created_at": "2023-01-15T10:00:00Z"
  }
}