Run a rule now
Spaces method and path for this operation:
<div><span class="operation-verb post">post</span> <span class="operation-path">/s/{space_id}/api/alerting/v2/rules/{id}/_run</span></div>Refer to Spaces for more information.
[Required authorization] Route required privileges: manage_alerting-v2-rules.
Path parameters
The identifier for the rule. Chosen at creation and permanent — it cannot be changed afterwards. Re-using the id of a deleted resource is allowed but discouraged: execution history, change history, and alert episodes recorded under that id are retained and are attributed to the new resource. Ids appear in URLs and logs, so keep them free of sensitive data.
Headers
A required header to protect against CSRF attacks
Response
The run was accepted: the rule is scheduled to run. Requests that arrive before the run starts are collapsed into a single run. Poll the rule execution history to observe the result.
Changes
Changed in 2 of the 176 revisions of this API.12
- ▲
removed the success response with the status
response-success-status-removed
- ○
added the success response with the status
response-success-status-added
- ▲
- ○
endpoint added
endpoint-added
- ○
Of the 176 revisions, 20 have no diff computed.