Sign in
policy_engine

Create Policy Attachment

Create a new policy attachment.

Example Request:

curl -X POST "http://localhost:4000/policies/attachments" \
    -H "Authorization: Bearer <your_api_key>" \
    -H "Content-Type: application/json" \
    -d '{
        "policy_name": "global-baseline",
        "scope": "*"
    }'

Example with team-specific attachment:

curl -X POST "http://localhost:4000/policies/attachments" \
    -H "Authorization: Bearer <your_api_key>" \
    -H "Content-Type: application/json" \
    -d '{
        "policy_name": "healthcare-compliance",
        "teams": ["healthcare-team", "medical-research"]
    }'

Example Response:

{
    "attachment_id": "123e4567-e89b-12d3-a456-426614174000",
    "policy_name": "global-baseline",
    "scope": "*",
    "teams": [],
    "keys": [],
    "models": [],
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
}
post/policies/attachments

Request body

keysstring[] nullable

Key aliases or patterns this attachment applies to.

modelsstring[] nullable

Model names or patterns this attachment applies to.

policy_namestring required

Name of the policy to attach.

scopestring nullable

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

tagsstring[] nullable

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

teamsstring[] nullable

Team aliases or patterns this attachment applies to.

Response

Successful Response

attachment_idstring required

Unique ID of the attachment.

created_atstring date-time nullable

When the attachment was created.

created_bystring nullable

Who created the attachment.

definition_location'db' | 'config'

Where this attachment is defined: 'db' (database) or 'config' (config.yaml).

keysstring[]

Key patterns.

modelsstring[]

Model patterns.

policy_namestring required

Name of the attached policy.

scopestring nullable

Scope of the attachment.

tagsstring[]

Tag patterns.

teamsstring[]

Team patterns.

updated_atstring date-time nullable

When the attachment was last updated.

updated_bystring nullable

Who last updated the attachment.

Changes

Changed in 14 of the 42 revisions of this API.31

  • b694deb1e4592See the full diff
    • ○

      api tag policy_engine added

      api-tag-added

    • ○

      api tag Policies removed

      api-tag-removed

  • cfac079bcc042See the full diff
    • ○

      api tag Policies added

      api-tag-added

    • ○

      api tag policy_engine removed

      api-tag-removed

  • a4fccd4bf54d2See the full diff
    • ○

      api tag policy_engine added

      api-tag-added

    • ○

      api tag Policies removed

      api-tag-removed

  • 6246f8d427b72See the full diff
    • ○

      api tag Policies added

      api-tag-added

    • ○

      api tag policy_engine removed

      api-tag-removed

  • c357baf422ab2See the full diff
    • ○

      api tag policy_engine added

      api-tag-added

    • ○

      api tag Policies removed

      api-tag-removed

  • 082b5fabd9095See the full diff
    • ○

      api tag Policies added

      api-tag-added

    • ○

      api tag policy_engine removed

      api-tag-removed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e2f308355e2d2See the full diff
    • ○

      api tag policy_engine added

      api-tag-added

    • ○

      api tag Policies removed

      api-tag-removed

  • 89805a9f84ad2See the full diff
    • ○

      api tag Policies added

      api-tag-added

    • ○

      api tag policy_engine removed

      api-tag-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5c00a227eebf2See the full diff
    • ○

      api tag policy_engine added

      api-tag-added

    • ○

      api tag Policies removed

      api-tag-removed

    This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 404bba17aabe2See the full diff
    • ○

      api tag Policies added

      api-tag-added

    • ○

      api tag policy_engine removed

      api-tag-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog