Platform

prepare failover

Create a 15-minute review for a planned failover. Deploy scope. Does not stop apps or switch traffic. Inspect source, target, hostname, countries, backup age and interruption risk before asking the user to confirm. Backup age is not a promise of zero loss. Hosted MCP requires an account credential without resource confinement. Available only when the failover_enabled feature gate is enabled. Resources must belong to the authenticated account; confined credentials are rejected. A disabled gate returns 404. Review validity, same-account pairing and current state are checked again by the server. Compatibility alias of /platform/deployments/custom/{id}/prepare-failover.

post/platform/deployments/{id}/prepare-failover

Request

Base URL: https://api.imprezahost.com/v1
URL: https://api.imprezahost.com/v1/platform/deployments/{id}/prepare-failover
Auth: API key in header X-API-Key and API key in header X-API-Secret

Path parameters

idstring required

Request body

FailoverPrepareFailoverInput required

Response

Pair or review prepared; no automatic traffic switch.

successtrue required

Example response

{
  "meta": {
    "request_id": "req_a1b2c3d4e5f6g7h8",
    "timestamp": "2026-03-30T14:05:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.