Preview a retention change
POST/v1/retention/simulate
Shows which existing backups a policy, or a proposed spec for it, would keep and expire, which are locked, and how much space expiring them would free in the project. plan_id narrows it to one plan. at evaluates it at another time.
Operator only: needs a system-scoped token.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 413
- 415
- 422
- default
OK
Bad Request.
invalid_request: The body is not a single JSON object, names a field this operation does not take, or gives a value of the wrong type.
Unauthorized.
unauthenticated: The token is missing, expired or not valid.
Forbidden.
forbidden: The token's roles do not grant policy:write.
Not Found.
not_found: No policy has policy_id. Or plan_id names no plan of that policy.
Request Entity Too Large.
body_too_large: The body is larger than the service accepts.
Unsupported Media Type.
unsupported_media_type: The body is not sent as application/json.
Unprocessable Entity.
validation_failed: policy_id is missing or not a UUID. plan_id is not a UUID. A field of spec is not valid. The keep ladder of spec retains nothing.
An error, as an RFC 7807 problem document.