Rule templates

Save a scope's rules as a new template

Captures the rules currently in a scope (machine public_id, or empty for global) as a new personal template. Disabled rules are captured too, since a template item has no enabled flag. A rule's match_on is not captured, so a rule made from an event becomes a broader item that matches on its pattern alone. Subject to the same 50-template and 200-item ceilings as create. Cookie callers must pass CSRF.

This is a write: a read-only API key is refused with 403.

post/api/rule_templates/snapshot/

Request

  • Base URL: https://eyalsec.com
  • URL: https://eyalsec.com/api/rule_templates/snapshot/
  • Auth: one of:
    • API key in header X-API-Key
    • API key in cookie __Host-es2session

Request body

namestring required

Template name (unique per owner).

descriptionstring

Free-text description.

machinestring

Machine public_id, or empty for global rules.

Response

Created.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.