alerting-v2

Create a rule

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Creates a rule with a server-generated identifier. To create or replace a rule with a client-supplied identifier, use PUT /api/alerting/v2/rules/{id}/.<br/><br/>[Required authorization] Route required privileges: manage_alerting-v2-rules.

post/api/alerting/v2/rules

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. Defaults to @timestamp.

Response

Returns the newly created 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 5 of the 176 revisions of this API.5414

    • ●

      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

  • e2104277117c39See the full diff
    • ▲

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

      request-property-any-of-removed

    • ▲

      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 to the request property anyOf list

      request-property-any-of-added

    • ○

      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

  • 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

  • 118c456bb48713See the full diff
    • ▲

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

      request-property-any-of-removed

    • ○

      added subschema #1 subschema #2 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

    • ○

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

      response-property-any-of-removed

    • ○

      endpoint added

      endpoint-added

Of the 176 revisions, 20 have no diff computed.