Skip to main content

Retire a protection group's superseded recovery

POST 
/v1/protection-groups/:id/retire

Removes what a superseded recovery left here once the other region has taken the workload back: the stopped, locked servers a recover built, the ports and floating addresses it gave them. Their volumes are never deleted: each is kept when its server is deleted and then released from the block storage service, leaving the underlying image where it is, named in the run's resources as an unmanaged_volume for an operator to remove. Runs only once this region has read the other region's record of recovering the group at the custody epoch held here or above; a record of another region is otherwise never a reason to remove anything.

The group's custody here becomes standby first, which is the run's point of no return, and nothing is undone after it; a run that stops is resumed. With dry_run=true the request answers 200 with the plan and starts nothing.

Any member of the project the token is scoped to.

Request​

Responses​

OK.

With dry_run=true, the plan the run would follow. Nothing was started.