PUT
/
v1
/
databases
/
{id}
Update Database
curl --request PUT \
  --url https://api.vertracloud.app/v1/databases/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "updates": {}
}'
{
  "status": "success",
  "response": {
    "id": "639d9aa35d8b4e559bcd066db4ddcc8c",
    "cluster": 1,
    "type": 1,
    "name": "UpdatedDatabase",
    "description": "Updated description",
    "owner_id": "993591427428790342",
    "owner_plan_id": 1,
    "status": "up",
    "storage": 512,
    "ram": 256,
    "host": "vertra-cloud-redis-639d9aa35d8b4e559bcd066db4ddcc8c.db.vertraweb.app",
    "port": 6379,
    "duration": 30,
    "expires_at": "2025-09-14T19:58:00Z",
    "plan_id": 1,
    "purchased_at": "2025-08-14T19:58:00Z",
    "last_backup": "2025-08-14T19:58:00Z",
    "created_at": "2025-08-14T19:58:00Z",
    "updated_at": "2025-08-14T20:00:00Z"
  }
}
id
string
required
The ID of the database to update.
updates
object
The fields to update for the database.

Response

status
string
Indicates whether the call was successful. success if successful, error if not.
response
object
The updated details of the database.
{
  "status": "success",
  "response": {
    "id": "639d9aa35d8b4e559bcd066db4ddcc8c",
    "cluster": 1,
    "type": 1,
    "name": "UpdatedDatabase",
    "description": "Updated description",
    "owner_id": "993591427428790342",
    "owner_plan_id": 1,
    "status": "up",
    "storage": 512,
    "ram": 256,
    "host": "vertra-cloud-redis-639d9aa35d8b4e559bcd066db4ddcc8c.db.vertraweb.app",
    "port": 6379,
    "duration": 30,
    "expires_at": "2025-09-14T19:58:00Z",
    "plan_id": 1,
    "purchased_at": "2025-08-14T19:58:00Z",
    "last_backup": "2025-08-14T19:58:00Z",
    "created_at": "2025-08-14T19:58:00Z",
    "updated_at": "2025-08-14T20:00:00Z"
  }
}

Error Responses

status
string
Indicates whether the call was successful. error if not successful.
code
string
The error code indicating the reason for failure. Possible values:
  • UNAUTHORIZED: The user is not authenticated or lacks sufficient permissions.
  • DATABASE_NOT_FOUND_OR_FORBIDDEN: The specified database does not exist or the user lacks access.
  • INVALID_NAME: The provided name is invalid.
  • INVALID_DESCRIPTION: The provided description is invalid.
{
  "status": "error",
  "code": "UNAUTHORIZED"
}