v1

latestSwagger 2.02026-07-172964242.9 KB

Database

Failover database node

Performs a failover for a node to a replica candidate.

post/v1/databases/{database_id}/nodes/{node_name}/failover

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.

node_namestring required

Name of the node to initiate the failover from.

Request body

candidate_instance_idstring

Optional instance_id of the replica to promote. If omitted, a candidate will be selected.

skip_validationboolean

If true, skip the health validations that prevent running failover on a healthy cluster.

Example request

{
  "candidate_instance_id": "68f50878-44d2-4524-a823-e31bd478706d-n1-689qacsi",
  "skip_validation": true
}

Response

OK response.

Example response

{
  "task": {
    "created_at": "2025-06-18T17:54:28Z",
    "database_id": "storefront",
    "status": "pending",
    "task_id": "0197842d-9082-7496-b787-77bd2e11809f",
    "type": "failover"
  }
}