Sign in
alerting-v2

Update a rule

Spaces method and path for this operation:

<div><span class="operation-verb patch">patch</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: manage_alerting-v2-rules.

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

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

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

time_fieldstring

Document field used as the event time when applying the lookback window. If omitted, the existing value is kept.

versionstring

The current version of the rule, used for optimistic concurrency control.

Response

Returns the updated 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 used as the event time when applying the lookback window. Defaults to @timestamp.

updated_atstring date-time required

ISO timestamp when the rule was last updated.

versionstring

The saved object version token of the rule, used for optimistic concurrency control.

Changes

Changed in 6 of the 176 revisions of this API.3413

  • 883cd57e9ac74See the full diff
    • ●

      the / request property's maxLength was set to 32

      request-property-max-length-set

    • ●

      the / request property's maxLength was set to 32

      request-property-max-length-set

    • ●

      the // request property's maxLength was set to 32

      request-property-max-length-set

    • ●

      the // request property's maxLength was set to 32

      request-property-max-length-set

  • e2104277117c28See the full diff
    • ▲

      removed subschema #1 subschema #2 subschema #3 from the request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the request property anyOf list

      request-property-any-of-removed

    • ○

      added subschema #1 subschema #2 subschema #3 to the request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #1 subschema #2 subschema #3 subschema #4 to the request property anyOf list

      request-property-any-of-added

    • ○

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

      response-property-any-of-added

    • ○

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

      response-property-any-of-added

    • ○

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

      response-property-any-of-added

    • ○

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

      response-property-any-of-removed

    • ○

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

      response-property-any-of-removed

    • ○

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

      response-property-any-of-removed

  • 4f657467ab211See the full diff
    • ○

      the request property / became nullable

      request-property-became-nullable

  • 93e11b26687211See the full diff
    • ▲

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

      response-property-became-optional

    • ○

      the request property ///// became optional

      request-property-became-optional

  • 118c456bb4872See the full diff
    • ○

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

      response-property-any-of-added

    • ○

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

      response-property-any-of-removed

  • e9badbb5da991See the full diff
    • ○

      endpoint added

      endpoint-added

Of the 176 revisions, 20 have no diff computed.