kibana/x-pack/plugins/alerting/docs/openapi/paths/s@{spaceid}@api@alerts@alert@{alertid}@_disable.yaml
Kibana Machine 192f7bd285
[8.6] [DOCS] Add specifications for deprecated alert APIs (#149655) (#150188)
# Backport

This will backport the following commits from `main` to `8.6`:
- [[DOCS] Add specifications for deprecated alert APIs
(#149655)](https://github.com/elastic/kibana/pull/149655)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-02-02T15:21:43Z","message":"[DOCS]
Add specifications for deprecated alert APIs
(#149655)","sha":"59488afa5d7fe30b683d2035d73c1a09f1394b9f","branchLabelMapping":{"^v8.7.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Alerting/RulesManagement","backport:prev-minor","v8.7.0"],"number":149655,"url":"https://github.com/elastic/kibana/pull/149655","mergeCommit":{"message":"[DOCS]
Add specifications for deprecated alert APIs
(#149655)","sha":"59488afa5d7fe30b683d2035d73c1a09f1394b9f"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.7.0","labelRegex":"^v8.7.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/149655","number":149655,"mergeCommit":{"message":"[DOCS]
Add specifications for deprecated alert APIs
(#149655)","sha":"59488afa5d7fe30b683d2035d73c1a09f1394b9f"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2023-02-02 09:55:12 -07:00

30 lines
No EOL
847 B
YAML

post:
summary: Disables an alert.
operationId: legacyDisableAlert
deprecated: true
description: Deprecated in 7.13.0. Use the disable rule API instead.
tags:
- alerting
parameters:
- $ref: ../components/headers/kbn_xsrf.yaml
- $ref: '../components/parameters/space_id.yaml'
- in: path
name: alertId
description: The identifier for the alert.
required: true
schema:
type: string
example: 41893910-6bca-11eb-9e0d-85d233e3ee35
responses:
'204':
description: Indicates a successful call.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601