Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/elastic/kibana into alert…
Browse files Browse the repository at this point in the history
…ing/doc-template
  • Loading branch information
ymao1 committed Mar 1, 2021
2 parents 0f5e5c0 + a55d8b6 commit 0987b59
Show file tree
Hide file tree
Showing 363 changed files with 7,144 additions and 4,147,469 deletions.
9 changes: 0 additions & 9 deletions .telemetryrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,6 @@
{
"output": "src/plugins/telemetry/schema/oss_plugins.json",
"root": "src/plugins/",
"exclude": [
"src/plugins/kibana_react/",
"src/plugins/testbed/",
"src/plugins/kibana_utils/"
]
},
{
"output": "src/plugins/telemetry/schema/legacy_plugins.json",
"root": "src/legacy/server/",
"exclude": []
}
]
10 changes: 9 additions & 1 deletion docs/api/actions-and-connectors/create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -67,4 +75,4 @@ The API returns the following:
},
"isPreconfigured": false
}
--------------------------------------------------
--------------------------------------------------
6 changes: 5 additions & 1 deletion docs/api/actions-and-connectors/delete.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

7 changes: 6 additions & 1 deletion docs/api/actions-and-connectors/execute.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -80,4 +85,4 @@ The API returns the following:
},
"actionId": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad"
}
--------------------------------------------------
--------------------------------------------------
5 changes: 5 additions & 0 deletions docs/api/actions-and-connectors/get.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 8 additions & 0 deletions docs/api/actions-and-connectors/get_all.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 8 additions & 0 deletions docs/api/actions-and-connectors/list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/api/actions-and-connectors/update.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/api/alerts/create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/api/alerts/delete.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/api/alerts/disable.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/api/alerts/enable.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 8 additions & 0 deletions docs/api/alerts/find.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ change. Use the find API for traditional paginated results, but avoid using it t

`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

Expand Down
5 changes: 5 additions & 0 deletions docs/api/alerts/get.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 8 additions & 0 deletions docs/api/alerts/health.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 8 additions & 0 deletions docs/api/alerts/list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/api/alerts/mute.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/api/alerts/mute_all.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/api/alerts/unmute.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/api/alerts/unmute_all.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/api/alerts/update.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
:blog-ref: https://www.elastic.co/blog/
:wikipedia: https://en.wikipedia.org/wiki

include::{docs-root}/shared/versions/stack/7.10.asciidoc[]
include::{docs-root}/shared/versions/stack/{source_branch}.asciidoc[]

:docker-repo: docker.elastic.co/kibana/kibana
:docker-image: docker.elastic.co/kibana/kibana:{version}
Expand Down
Loading

0 comments on commit 0987b59

Please sign in to comment.