Run a rule now

Base URL: https://{kibana_url}

POST /api/alerting/v2/rules/{id}/_run
POST /s/{space_id}/api/alerting/v2/rules/{id}/_run

Refer to Spaces for more information.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Responses

202

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.

Indicates the rule is disabled and cannot be run.

application/json

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

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/alerting/v2/rules/ID/_run

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/alerting/v2/rules/${ID}/_run" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "code": "RULE_DISABLED",
  "details": {
    "rule_id": "rule-1"
  },
  "error": "Bad Request",
  "message": "Rule with id \u0022rule-1\u0022 is disabled and cannot be run"
}

{
  "code": "UNAUTHORIZED",
  "error": "Unauthorized",
  "message": "Authentication required to access this API."
}

{
  "code": "FORBIDDEN",
  "error": "Forbidden",
  "message": "The current user does not have the required privileges for this request."
}

{
  "code": "RULE_NOT_FOUND",
  "details": {
    "rule_id": "rule-1"
  },
  "error": "Not Found",
  "message": "Rule with id \u0022rule-1\u0022 not found"
}

{
  "code": "RULE_ALREADY_RUNNING",
  "details": {
    "rule_id": "rule-1"
  },
  "error": "Conflict",
  "message": "Rule with id \u0022rule-1\u0022 is already running"
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "error": "Internal Server Error",
  "message": "An unexpected error occurred."
}

{
  "code": "ALERTING_DISABLED",
  "error": "Service Unavailable",
  "message": "Alerting is disabled."
}