Platform

Retire the old failover pair

Retire a verified failover pair only after the old service is already Terminated. Requires its positive integer old_service_id, the reviewed digest and confirm: true. Keeps the primary running and recovery copies retained; revokes the old agent and tombstones the old application. Does not terminate billing or erase backups. Manage scope; account credential without 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.

post/platform/failover-cutovers/{id}/retire-pair

Request

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

Path parameters

idstring required

Request body

confirmtrue required
old_service_idinteger required
review_digeststring required

Response

Saved failover state

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.