Access

Validate a policy without saving it

Changed on

Returns line and column diagnostics and the lockout check for a candidate policy. Requires a signed-in session and the permission saving it would need.

Checked against the guardrail.manage permission for the resource it acts on. See Permissions for the roles and API key permissions that include it.

post/v1/authz/policies/validate

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/authz/policies/validate
  • Auth
    HTTP bearer

Request body

cedarTextstring
descriptionstring
enabledboolean

Defaults to true.

endpointsstring[]
guardrail'key_networks' | 'everyone_networks' | 'model_allowlist'
ipRangesstring[]
kind'guardrail' | 'custom' required
modelsstring[]
namestring required

Response

The validation

lockoutstring[] required

Permissions the saving owner would lose (policy.manage, member.manage); saving is refused while this is non-empty.

validboolean required

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 12b2fcbcc298Revision changes
    • info

      endpoint added