[Alerting][Docs] Fixed Kibana API does not consistently refer to Kibana Spaces Requests for Alarms and Connectors. (#92948) (#93100)

* [Alerting][Docs] Fixed Kibana API does not consistently refer to Kibana Spaces Requests for Alarms and Connectors.

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
This commit is contained in:
Yuliia Naumenko 2021-03-01 12:15:14 -08:00 committed by GitHub
parent e9c9a6365e
commit 4fd4f72542
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
20 changed files with 120 additions and 3 deletions

View file

@ -11,6 +11,14 @@ Creates an action.
`POST <kibana host>:<port>/api/actions/action`
`POST <kibana host>:<port>/s/<space_id>/api/actions/action`
[[actions-and-connectors-api-create-path-params]]
==== Path parameters
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[actions-and-connectors-api-create-request-body]]
==== Request body
@ -67,4 +75,4 @@ The API returns the following:
},
"isPreconfigured": false
}
--------------------------------------------------
--------------------------------------------------

View file

@ -13,12 +13,17 @@ WARNING: When you delete an action, _it cannot be recovered_.
`DELETE <kibana host>:<port>/api/actions/action/<id>`
`DELETE <kibana host>:<port>/s/<space_id>/api/actions/action/<id>`
[[actions-and-connectors-api-delete-path-params]]
==== Path parameters
`id`::
(Required, string) The ID of the action.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[actions-and-connectors-api-delete-response-codes]]
==== Response code
@ -32,4 +37,3 @@ WARNING: When you delete an action, _it cannot be recovered_.
$ curl -X DELETE api/actions/action/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad
--------------------------------------------------
// KIBANA

View file

@ -11,12 +11,17 @@ Executes an action by ID.
`POST <kibana host>:<port>/api/actions/action/<id>/_execute`
`POST <kibana host>:<port>/s/<space_id>/api/actions/action/<id>/_execute`
[[actions-and-connectors-api-execute-params]]
==== Path parameters
`id`::
(Required, string) The ID of the action.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[actions-and-connectors-api-execute-request-body]]
==== Request body
@ -80,4 +85,4 @@ The API returns the following:
},
"actionId": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad"
}
--------------------------------------------------
--------------------------------------------------

View file

@ -11,12 +11,17 @@ Retrieves an action by ID.
`GET <kibana host>:<port>/api/actions/action/<id>`
`GET <kibana host>:<port>/s/<space_id>/api/actions/action/<id>`
[[actions-and-connectors-api-get-params]]
==== Path parameters
`id`::
(Required, string) The ID of the action.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[actions-and-connectors-api-get-codes]]
==== Response code

View file

@ -11,6 +11,14 @@ Retrieves all actions.
`GET <kibana host>:<port>/api/actions`
`GET <kibana host>:<port>/s/<space_id>/api/actions`
[[actions-and-connectors-api-get-all-path-params]]
==== Path parameters
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[actions-and-connectors-api-get-all-codes]]
==== Response code

View file

@ -11,6 +11,14 @@ Retrieves a list of all action types.
`GET <kibana host>:<port>/api/actions/list_action_types`
`GET <kibana host>:<port>/s/<space_id>/api/actions/list_action_types`
[[actions-and-connectors-api-list-path-params]]
==== Path parameters
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[actions-and-connectors-api-list-codes]]
==== Response code

View file

@ -11,12 +11,17 @@ Updates the attributes for an existing action.
`PUT <kibana host>:<port>/api/actions/action/<id>`
`PUT <kibana host>:<port>/s/<space_id>/api/actions/action/<id>`
[[actions-and-connectors-api-update-params]]
==== Path parameters
`id`::
(Required, string) The ID of the action.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[actions-and-connectors-api-update-request-body]]
==== Request body

View file

@ -11,12 +11,17 @@ Create {kib} alerts.
`POST <kibana host>:<port>/api/alerts/alert/<id>`
`POST <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>`
[[alerts-api-create-path-params]]
==== Path parameters
`<id>`::
(Optional, string) Specifies a UUID v1 or v4 to use instead of a randomly generated ID.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[alerts-api-create-request-body]]
==== Request body

View file

@ -13,12 +13,17 @@ WARNING: Once you delete an alert, you cannot recover it.
`DELETE <kibana host>:<port>/api/alerts/alert/<id>`
`DELETE <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>`
[[alerts-api-delete-path-params]]
==== Path parameters
`id`::
(Required, string) The ID of the alert that you want to remove.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[alerts-api-delete-response-codes]]
==== Response code

View file

@ -11,12 +11,17 @@ Disable an alert.
`POST <kibana host>:<port>/api/alerts/alert/<id>/_disable`
`POST <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>/_disable`
[[alerts-api-disable-path-params]]
==== Path parameters
`id`::
(Required, string) The ID of the alert that you want to disable.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[alerts-api-disable-response-codes]]
==== Response code

View file

@ -11,12 +11,17 @@ Enable an alert.
`POST <kibana host>:<port>/api/alerts/alert/<id>/_enable`
`POST <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>/_enable`
[[alerts-api-enable-path-params]]
==== Path parameters
`id`::
(Required, string) The ID of the alert that you want to enable.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[alerts-api-enable-response-codes]]
==== Response code

View file

@ -11,6 +11,14 @@ Retrieve a paginated set of alerts based on condition.
`GET <kibana host>:<port>/api/alerts/_find`
`GET <kibana host>:<port>/s/<space_id>/api/alerts/_find`
[[alerts-api-find-path-params]]
==== Path parameters
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[alerts-api-find-query-params]]
==== Query Parameters

View file

@ -11,12 +11,17 @@ Retrieve an alert by ID.
`GET <kibana host>:<port>/api/alerts/alert/<id>`
`GET <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>`
[[alerts-api-get-params]]
==== Path parameters
`id`::
(Required, string) The ID of the alert to retrieve.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[alerts-api-get-codes]]
==== Response code

View file

@ -11,6 +11,14 @@ Retrieve the health status of the Alerting framework.
`GET <kibana host>:<port>/api/alerts/_health`
`GET <kibana host>:<port>/s/<space_id>/api/alerts/_health`
[[alerts-api-health-params]]
==== Path parameters
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[alerts-api-health-codes]]
==== Response code

View file

@ -11,6 +11,14 @@ Retrieve a list of all alert types.
`GET <kibana host>:<port>/api/alerts/list_alert_types`
`GET <kibana host>:<port>/s/<space_id>/api/alerts/list_alert_types`
[[alerts-api-list-params]]
==== Path parameters
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[alerts-api-list-codes]]
==== Response code

View file

@ -11,6 +11,8 @@ Mute an alert instance.
`POST <kibana host>:<port>/api/alerts/alert/<id>/alert_instance/<alert_instance_id>/_mute`
`POST <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>/alert_instance/<alert_instance_id>/_mute`
[[alerts-api-mute-path-params]]
==== Path parameters
@ -20,6 +22,9 @@ Mute an alert instance.
`alert_instance_id`::
(Required, string) The ID of the alert instance that you want to mute.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[alerts-api-mute-response-codes]]
==== Response code

View file

@ -11,12 +11,17 @@ Mute all alert instances.
`POST <kibana host>:<port>/api/alerts/alert/<id>/_mute_all`
`POST <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>/_mute_all`
[[alerts-api-mute-all-path-params]]
==== Path parameters
`id`::
(Required, string) The ID of the alert whose instances you want to mute.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[alerts-api-mute-all-response-codes]]
==== Response code

View file

@ -11,6 +11,8 @@ Unmute an alert instance.
`POST <kibana host>:<port>/api/alerts/alert/<id>/alert_instance/<alert_instance_id>/_unmute`
`POST <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>/alert_instance/<alert_instance_id>/_unmute`
[[alerts-api-unmute-path-params]]
==== Path parameters
@ -20,6 +22,9 @@ Unmute an alert instance.
`alert_instance_id`::
(Required, string) The ID of the alert instance that you want to unmute.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[alerts-api-unmute-response-codes]]
==== Response code

View file

@ -11,12 +11,17 @@ Unmute all alert instances.
`POST <kibana host>:<port>/api/alerts/alert/<id>/_unmute_all`
`POST <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>/_unmute_all`
[[alerts-api-unmute-all-path-params]]
==== Path parameters
`id`::
(Required, string) The ID of the alert whose instances you want to unmute.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[alerts-api-unmute-all-response-codes]]
==== Response code

View file

@ -11,12 +11,17 @@ Update the attributes for an existing alert.
`PUT <kibana host>:<port>/api/alerts/alert/<id>`
`PUT <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>`
[[alerts-api-update-path-params]]
==== Path parameters
`id`::
(Required, string) The ID of the alert that you want to update.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[alerts-api-update-request-body]]
==== Request body