alerting-v2

Get a rule

Changed on

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/alerting/v2/rules/{id}</span></div>

Refer to Spaces for more information.

[Required authorization] Route required privileges: read_alerting-v2-rules.

get/api/alerting/v2/rules/{id}

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/alerting/v2/rules/{id}
  • Auth
    • API key in header Authorization
    • or HTTP basic

Path parameters

idstring required

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 alerts 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.

Response

Returns the requested rule.

created_atstring date-time required

ISO timestamp when the rule was created.

enabledboolean required

Whether the rule is enabled.

idstring required

Unique rule identifier.

time_fieldstring

Document field Kibana uses with schedule.lookback to time-filter query.base.

updated_atstring date-time required

ISO timestamp when the rule was last updated.

versioninteger required

Monotonically increasing integer number representing a rule configuration version, incremented on every change. Used on generated rule events as rule.version.

Changes

  • e2104277117cRevision changes
    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 subschema #3 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 to the response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 from the response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the response property anyOf list for the response status

  • 93e11b266872Revision changes
    • breaking

      the response property ///// became optional for the status