Policies

Estimate Attachment Impact

Changed on

Estimate how many keys and teams would be affected by a policy attachment.

Use this before creating an attachment to preview the blast radius.

Example Request:

curl -X POST "http://localhost:4000/policies/attachments/estimate-impact" \
    -H "Authorization: Bearer <your_api_key>" \
    -H "Content-Type: application/json" \
    -d '{
        "policy_name": "hipaa-compliance",
        "tags": ["healthcare", "health-*"]
    }'
post/policies/attachments/estimate-impact

Request

  • Base URL
    https://api.flock.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.flock.io/policies/attachments/estimate-impact
  • Auth
    API key in header x-litellm-api-key

Request body

policy_namestring required

Name of the policy to attach.

scopestring nullable

Use '*' for global scope (applies to all requests).

teamsstring[] nullable

Team aliases or patterns this attachment applies to.

keysstring[] nullable

Key aliases or patterns this attachment applies to.

modelsstring[] nullable

Model names or patterns this attachment applies to.

tagsstring[] nullable

Tag patterns this attachment applies to. Supports wildcards (e.g., health-*).

priorityinteger nullable

Explicit execution order, lower runs first. Prioritised attachments run before those without one.

Response

Successful Response

affected_keys_countinteger

Number of keys that would be affected (named + unnamed).

affected_teams_countinteger

Number of teams that would be affected (named + unnamed).

unnamed_keys_countinteger

Number of affected keys without an alias.

unnamed_teams_countinteger

Number of affected teams without an alias.

sample_keysstring[]

Sample of affected key aliases (up to 10).

sample_teamsstring[]

Sample of affected team aliases (up to 10).

Changes

  • 896e6cebdda0Revision changes
    • info

      api operation id estimate_attachment_impact_policies_attachments_estimate_impact_post_2 removed and replaced with estimate_attachment_impact_policies_attachments_estimate_impact_post

    • info

      api tag Policies added

    • info

      api tag policy_resolve removed

  • 5dd1e481abc6Revision changes
    • info

      api operation id estimate_attachment_impact_policies_attachments_estimate_impact_post removed and replaced with estimate_attachment_impact_policies_attachments_estimate_impact_post_2

    • info

      api tag policy_resolve added

    • info

      api tag Policies removed