Skip to content
Rulebooks

Delete a rulebook

DELETE/api/v1alpha1/rulebooks/{rulebook_id}

Deletes a rulebook this API key owns.

  • Access: an alpha-enabled API key with the MANAGE_RULEBOOKS permission.
  • Templates: shared templates are read-only and answer 403.
  • Not found: a rulebook belonging to somebody else is deliberately indistinguishable from one that does not exist.

Call GET /api/v1alpha1/rulebooks/{rulebook_id}/usage first to see how many workflows and findings still reference it.

AuthorizationBearer <token>

In: header

Path Parameters

rulebook_id*string

Identifier of a rulebook your key can read.

Response Body

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X DELETE "https://example.com/api/v1alpha1/rulebooks/rb_0190b5d4-7e1f-7a2b-9c3d-1234567890ab" \  -H "Authorization: Bearer $DEEPFRAME_API_KEY"
Empty