Retire a policy. Relaxing a human-confirmed safety gate is refused.

Capability: policies:manage. A DENY or REQUIRE_APPROVAL policy confirmed by a human can only be retired by a human owner/admin in Forbiz — an agent attempt returns 403.

post/policies/{id}/retire

Request

  • Base URL: https://forbiz.io/api/public/agent
  • URL: https://forbiz.io/api/public/agent/policies/{id}/retire
  • Auth: HTTP bearer

Path parameters

idstring required

Headers

Idempotency-Keystring

Recommended on every mutating request. A replay with the same key is NOT applied twice: the server answers { ok, idempotent_replay: true, first_seen_at, status } describing the first attempt.

Request body

reasonstring
status'DISABLED' | 'EXPIRED'

Response

Policy retired

object required

Changes

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