The ID of the database to update.
The fields to update for the database.
Response
Indicates whether the call was successful. success
if successful, error
if not.
The updated details of the database.
The cluster ID where the database is hosted.
The type of the database.
The name of the database.
The description of the database.
The ID of the database owner.
The ID of the owner’s plan.
The status of the database (e.g., up
).
The storage allocated to the database in MB.
The RAM allocated to the database in MB.
The host address of the database.
The port used by the database.
The duration of the database subscription in days.
The timestamp when the database subscription expires.
The ID of the database plan.
The timestamp when the database was purchased.
The timestamp of the last backup, if available.
The timestamp when the database was created.
The timestamp when the database was last updated.
{
"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
Indicates whether the call was successful. error
if not successful.
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"
}