Run a rule now

Auth

Required privileges

id string · min length: 1 · max length: 150 required: The identifier for the rule.

kbn-xsrf string required: A required header to protect against CSRF attacks

202

The rule run was triggered successfully.

Indicates the rule is disabled and cannot be run.

application/json

code string required: Stable error code you can branch on, for example INVALID_SCHEDULE or RULE_ALREADY_EXISTS.
details map string to object: Optional extra information about the error, for example field validation issues or the rule_id when that ID already exists.
error string required: A short human-readable summary of the error category (e.g., "Not Found", "Bad Request"). Subject to change without notice. Do not parse or rely on its content.
message string required: A readable explanation of the error. The wording can change without notice. Do not parse this field.

Indicates the request was not authenticated.

application/json

Indicates the user does not have the required privileges to perform the request.

application/json

Indicates a rule with the given ID does not exist.

application/json

Indicates the rule is already running or the run request conflicted.

application/json

Indicates an unexpected server-side error.

application/json

Indicates the alerting engine is disabled by the alerting:v2:enabled advanced setting.

application/json