Skip to main content
POST
cURL
This endpoint has a rate limit of 10 requests per minute, shared by start, stop and restart.

Authorizations

Authorization
string
header
required

Your CamposCloud API token, sent as Authorization: Bearer <token>.

Path Parameters

databaseId
string
required

ID of the database.

Pattern: ^[a-f0-9]{24}$

Response

The database, with refreshed metrics.

_id
string

ID of the database.

Example:

"64b7f0c2a1b2c3d4e5f60718"

name
string

Display name.

Example:

"main-db"

type
enum<string>
Available options:
mysql,
postgresql,
mongodb,
redis
Example:

"postgresql"

status
enum<string>

creating right after creation, active when ready, rebuilding while the container is rebuilt, error when the last rebuild failed.

Available options:
creating,
active,
rebuilding,
error
Example:

"active"

restartRequired
boolean

Whether a change (memory, or the password of a Redis database) is waiting for the next start, stop or restart to be applied.

Example:

false

userId
string | null

ID of the account that owns the database.

Example:

"64b7f0c2a1b2c3d4e5f60700"

teamId

Team of the database: null for personal databases, otherwise the team ID or an object with the ID and name of the team.

Example:

null

workerNodeId

Server that runs the database: its ID, or an object with the ID and name.

Example:
allocatedMemoryMB
integer

Memory reserved for the database, in MB. It counts towards the memory of the plan.

Example:

512

allocatedVCpu
number

vCPUs available to the database.

Example:

1

diskLimitBytes
integer

Disk limit in bytes.

Example:

10737418240

diskUsageBytes
integer | null

Latest measured disk usage in bytes. null when not measured yet.

Example:

52428800

containerImage
string

Image and version of the database engine.

Example:

"postgres:trixie"

connection
object

How to connect to the database. The password is never returned by the API: it is chosen when the database is created and can only be replaced, not read.

currentResourceMetrics
null | object

Latest metrics. null when none were collected yet.

createdAt
string<date-time>
Example:

"2025-01-01T12:00:00.000Z"

updatedAt
string<date-time>
Example:

"2025-01-01T12:00:00.000Z"