readiness

Completion readiness enforcement mode

Returns { mode, effectiveMode, blockAvailable }. mode is OFF (the default: the gate does nothing), WARN (completion goes through and the verdict is returned) or BLOCK (completion with a required gap is refused with 409 READINESS_GAPS). BLOCK needs the auditLogs feature; without it a stored BLOCK is enforced as WARN. Any org member.

get/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.

Response

Readiness settings

Changes

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