v1

latestSwagger 2.02026-07-172964242.9 KB

Database

Restart a database instance

Restarts a specific instance within a database. Supports immediate or scheduled restarts.

post/v1/databases/{database_id}/instances/{instance_id}/restart

Path parameters

database_idstring required

A user-specified identifier. Must be 1-36 characters, contain only lower-cased letters and hyphens, start and end with a letter or number, and not contain consecutive hyphens.

instance_idstring required

The ID of the instance to restart.

Request body

scheduled_atstring date-time

The time at which the restart is scheduled.

Example request

{
  "scheduled_at": "2025-06-18T16:52:05Z"
}

Response

OK response.

Example response

{
  "task": {
    "created_at": "2025-06-18T16:52:05Z",
    "database_id": "f2f1cae9-6f37-4609-aa98-d0991bff3493",
    "instance_id": "f2f1cae9-6f37-4609-aa98-d0991bff3493-n1-689qacsi",
    "status": "pending",
    "task_id": "019783f4-75f4-71e7-85a3-c9b96b345d77",
    "type": "restart_instance"
  }
}