Policy

Create Policy

POST
/api/policy/create

Create a new policy and attach it to one or more deployments.

Authorizations

  • Authorizationstringheaderrequired

    API Key required. Format: Bearer wc-your-api-key

Headers

  • whitecircle-versionstringrequired

    API Version

    Example: "2025-12-01"

Body

application/json

  • namestringrequired

  • flagged_contentstringrequired

  • allowed_contentstring | null

  • applies_tonull | enum<string>

    Available options: input, output, any

    Example: "input"

  • content_typenull | enum<string>

    Available options: session, artifact, any

    Example: "session"

  • modenull | enum<string>

    Available options: prod, shadow

    Example: "prod"

  • deployment_idsstring[] | null

  • severity_level_idstring<uuid> | null

  • country_codesstring[] | null

  • rollout_percentageinteger<int32> | null

Response

application/json

Success

  • idstringrequired

  • namestringrequired

  • flagged_contentstringrequired

  • applies_toenum<string>required

    Available options: input, output, any

    Example: "input"

  • content_typeenum<string>required

    Available options: session, artifact, any

    Example: "session"

  • modeenum<string>required

    Available options: prod, shadow

    Example: "prod"

  • deployment_idsstring[]required

  • country_codesstring[]required

  • rollout_percentageinteger<int32>required

    Required range: x >= 0

  • revision_idstringrequired

  • created_atstring<date-time>required

  • allowed_contentstring | null

  • severity_level_idstring<uuid> | null

  • deleted_atstring<date-time> | null