Skip to main content
POST
Failover replica
Promotes a healthy replica and replaces the failed one. Use this when a replica becomes unavailable.

Authorization

Session cookie set by Sign in: omnistrate_token=<jwt>. Browsers send it automatically; other clients must forward it on every request.

Path parameters

string
required
ID of the resource instance.

Query parameters

string
ID of the subscription that owns the instance.

Body

string
required
Action to take on the failed replica.
string
required
ID of the failed replica to fail over from.

Response

Returns 202 Accepted with an empty body when the operation is queued.

Errors

See Error for the shared error response shape.