readiness

Set the completion readiness enforcement mode

Requires org.compliance.manage. BLOCK needs the auditLogs feature: without it the standard plan-gate 402 ({ error, feature, currentPlan, requiredPlan, upgrade }). OFF and WARN are on every plan.

put/readiness/settings

Request

  • Base URL: https://api.onplana.com/api
  • URL: https://api.onplana.com/api/readiness/settings
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Headers

X-Organization-Idstring required

UUID of the active organization. Sets org context for all scoped operations.

Request body

mode'OFF' | 'WARN' | 'BLOCK' required

Response

Updated settings

Changes

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