{
  "opencollection": "1.0.0",
  "info": {
    "name": "Kibana APIs Actions alerting API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "alerting",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the alerting framework health",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{kibana_url}/api/alerting/_health"
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb get\">get</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/_health</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nYou must have `read` privileges for the **Management > Stack Rules** feature or for at least one of the **Analytics > Discover**, **Analytics > Machine Learning**, **Observability**, or **Security** features.\n"
        },
        {
          "info": {
            "name": "Get the rule types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{kibana_url}/api/alerting/rule_types"
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb get\">get</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rule_types</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nIf you have `read` privileges for one or more Kibana features, the API response contains information about the appropriate rule types. For example, there are rule types associated with the **Management > Stack Rules** f"
        },
        {
          "info": {
            "name": "Get rule details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{kibana_url}/api/alerting/rule/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The identifier for the rule."
              }
            ]
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb get\">get</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rule/{id}</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Create a rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{kibana_url}/api/alerting/rule/:id",
            "headers": [
              {
                "name": "kbn-xsrf",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The identifier for the rule. If it is omitted, an ID is randomly generated."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb post\">post</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rule/{id}</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Update a rule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{kibana_url}/api/alerting/rule/:id",
            "headers": [
              {
                "name": "kbn-xsrf",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The identifier for the rule."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb put\">put</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rule/{id}</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Delete a rule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{kibana_url}/api/alerting/rule/:id",
            "headers": [
              {
                "name": "kbn-xsrf",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The identifier for the rule."
              }
            ]
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb delete\">delete</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rule/{id}</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Disable a rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{kibana_url}/api/alerting/rule/:id/_disable",
            "headers": [
              {
                "name": "kbn-xsrf",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The identifier for the rule."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb post\">post</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rule/{id}/_disable</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Enable a rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{kibana_url}/api/alerting/rule/:id/_enable",
            "headers": [
              {
                "name": "kbn-xsrf",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The identifier for the rule."
              }
            ]
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb post\">post</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rule/{id}/_enable</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Mute all alerts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{kibana_url}/api/alerting/rule/:id/_mute_all",
            "headers": [
              {
                "name": "kbn-xsrf",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The identifier for the rule."
              }
            ]
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb post\">post</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rule/{id}/_mute_all</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Unmute all alerts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{kibana_url}/api/alerting/rule/:id/_unmute_all",
            "headers": [
              {
                "name": "kbn-xsrf",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The identifier for the rule."
              }
            ]
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb post\">post</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rule/{id}/_unmute_all</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Update the API key for a rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{kibana_url}/api/alerting/rule/:id/_update_api_key",
            "headers": [
              {
                "name": "kbn-xsrf",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The identifier for the rule."
              }
            ]
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb post\">post</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rule/{id}/_update_api_key</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Schedule a snooze for the rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{kibana_url}/api/alerting/rule/:id/snooze_schedule",
            "headers": [
              {
                "name": "kbn-xsrf",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier of the rule."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb post\">post</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rule/{id}/snooze_schedule</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nWhen you snooze a rule, the rule checks continue to run but alerts will not generate actions. You can snooze for a specified period of time and schedule single or recurring downtimes."
        },
        {
          "info": {
            "name": "Mute an alert",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{kibana_url}/api/alerting/rule/:rule_id/alert/:alert_id/_mute",
            "headers": [
              {
                "name": "kbn-xsrf",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "rule_id",
                "value": "",
                "type": "path",
                "description": "The identifier for the rule."
              },
              {
                "name": "alert_id",
                "value": "",
                "type": "path",
                "description": "The identifier for the alert."
              },
              {
                "name": "validate_alerts_existence",
                "value": "",
                "type": "query",
                "description": "Whether to validate the existence of the alert."
              }
            ]
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb post\">post</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rule/{rule_id}/alert/{alert_id}/_mute</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Unmute an alert",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{kibana_url}/api/alerting/rule/:rule_id/alert/:alert_id/_unmute",
            "headers": [
              {
                "name": "kbn-xsrf",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "rule_id",
                "value": "",
                "type": "path",
                "description": "The identifier for the rule."
              },
              {
                "name": "alert_id",
                "value": "",
                "type": "path",
                "description": "The identifier for the alert."
              }
            ]
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb post\">post</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Delete a snooze schedule for a rule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{kibana_url}/api/alerting/rule/:ruleId/snooze_schedule/:scheduleId",
            "headers": [
              {
                "name": "kbn-xsrf",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "ruleId",
                "value": "",
                "type": "path",
                "description": "The identifier for the rule."
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path",
                "description": "The identifier for the snooze schedule."
              }
            ]
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb delete\">delete</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rule/{ruleId}/snooze_schedule/{scheduleId}</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Get information about rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{kibana_url}/api/alerting/rules/_find",
            "params": [
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "The number of rules to return per page."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page number to return."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "An Elasticsearch simple_query_string query that filters the objects in the response."
              },
              {
                "name": "default_search_operator",
                "value": "",
                "type": "query",
                "description": "The default operator to use for the simple_query_string."
              },
              {
                "name": "search_fields",
                "value": "",
                "type": "query",
                "description": "The fields to perform the simple_query_string parsed query against."
              },
              {
                "name": "sort_field",
                "value": "",
                "type": "query",
                "description": "Determines which field is used to sort the results. The field must exist in the `attributes` key of the response."
              },
              {
                "name": "sort_order",
                "value": "",
                "type": "query",
                "description": "Determines the sort order."
              },
              {
                "name": "has_reference",
                "value": "",
                "type": "query",
                "description": "Filters the rules that have a relation with the reference objects with a specific type and identifier."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "The fields to return in the `attributes` key of the response."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "A KQL string that you filter with an attribute from your saved object. It should look like `savedObjectType.attributes.title: \"myTitle\"`. However, if you used a direct attribute of a saved object, such as `updatedAt`, you must define your filter, for example, `savedObjectType.updatedAt > 2018-12-22`."
              },
              {
                "name": "filter_consumers",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb get\">get</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rules/_find</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Find backfills for rules",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{kibana_url}/api/alerting/rules/backfill/_find",
            "headers": [
              {
                "name": "kbn-xsrf",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "end",
                "value": "",
                "type": "query",
                "description": "The end date for filtering backfills."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page number to return."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "The number of backfills to return per page."
              },
              {
                "name": "rule_ids",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of rule identifiers."
              },
              {
                "name": "initiator",
                "value": "",
                "type": "query",
                "description": "The initiator of the backfill, either `user` for manual backfills or `system` for automatic gap fills."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "The start date for filtering backfills."
              },
              {
                "name": "sort_field",
                "value": "",
                "type": "query",
                "description": "The field to sort backfills by."
              },
              {
                "name": "sort_order",
                "value": "",
                "type": "query",
                "description": "The sort order."
              }
            ]
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb post\">post</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rules/backfill/_find</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Schedule a backfill for rules",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{kibana_url}/api/alerting/rules/backfill/_schedule",
            "headers": [
              {
                "name": "kbn-xsrf",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb post\">post</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rules/backfill/_schedule</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Get a backfill by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{kibana_url}/api/alerting/rules/backfill/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The identifier for the backfill."
              }
            ]
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb get\">get</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rules/backfill/{id}</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        },
        {
          "info": {
            "name": "Delete a backfill by ID",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{kibana_url}/api/alerting/rules/backfill/:id",
            "headers": [
              {
                "name": "kbn-xsrf",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The identifier for the backfill."
              }
            ]
          },
          "docs": "**Spaces method and path for this operation:**\n\n<div><span class=\"operation-verb delete\">delete</span>&nbsp;<span class=\"operation-path\">/s/{space_id}/api/alerting/rules/backfill/{id}</span></div>\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information."
        }
      ]
    }
  ],
  "bundled": true
}