From 108564a0ad9b08fd1582d00734238c6985ffbcc2 Mon Sep 17 00:00:00 2001 From: Ying Mao Date: Mon, 8 Feb 2021 11:21:38 -0500 Subject: [PATCH 1/8] Stubbing out asciidocs --- docs/api/actions.asciidoc | 28 ++++++++ docs/api/actions/create.asciidoc | 114 ++++++++++++++++++++++++++++++ docs/api/actions/delete.asciidoc | 114 ++++++++++++++++++++++++++++++ docs/api/actions/execute.asciidoc | 114 ++++++++++++++++++++++++++++++ docs/api/actions/get.asciidoc | 114 ++++++++++++++++++++++++++++++ docs/api/actions/get_all.asciidoc | 114 ++++++++++++++++++++++++++++++ docs/api/actions/list.asciidoc | 114 ++++++++++++++++++++++++++++++ docs/api/actions/update.asciidoc | 114 ++++++++++++++++++++++++++++++ 8 files changed, 826 insertions(+) create mode 100644 docs/api/actions.asciidoc create mode 100644 docs/api/actions/create.asciidoc create mode 100644 docs/api/actions/delete.asciidoc create mode 100644 docs/api/actions/execute.asciidoc create mode 100644 docs/api/actions/get.asciidoc create mode 100644 docs/api/actions/get_all.asciidoc create mode 100644 docs/api/actions/list.asciidoc create mode 100644 docs/api/actions/update.asciidoc diff --git a/docs/api/actions.asciidoc b/docs/api/actions.asciidoc new file mode 100644 index 0000000000000..bddc53477c502 --- /dev/null +++ b/docs/api/actions.asciidoc @@ -0,0 +1,28 @@ +[[actions-api]] +== Actions and Connectors APIs + +Manage your {kib} actions. + +The following {kib} actions APIs are available: + +* <> to retrieve a single {kib} action by ID + +* <> to retrieve all {kib} actions + +* <> to retrieve a list of all {kib} action types + +* <> to create {kib} action + +* <> to update the attributes for an existing {kib} action + +* <> to execute a {kib} action by ID + +* <> to remove {kib} action by ID + +include::actions/get.asciidoc[] +include::actions/get_all.asciidoc[] +include::actions/list.asciidoc[] +include::actions/create.asciidoc[] +include::actions/update.asciidoc[] +include::actions/execute.asciidoc[] +include::actions/delete.asciidoc[] diff --git a/docs/api/actions/create.asciidoc b/docs/api/actions/create.asciidoc new file mode 100644 index 0000000000000..a9f6ff3ede6aa --- /dev/null +++ b/docs/api/actions/create.asciidoc @@ -0,0 +1,114 @@ +[[actions-api-create]] +// === Get object API +// ++++ +// Get object +// ++++ + +// experimental[] Retrieve a single {kib} saved object by ID. + +// [[saved-objects-api-get-request]] +// ==== Request + +// `GET :/api/saved_objects//` + +// `GET :/s//api/saved_objects//` + +// [[saved-objects-api-get-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. + + +// `type`:: +// (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. + +// `id`:: +// (Required, string) The ID of the object to retrieve. + +// [[saved-objects-api-get-codes]] +// ==== Response code + +// `200`:: +// Indicates a successful call. + +// [[saved-objects-api-get-example]] +// ==== Example + +// Retrieve the index pattern object with the `my-pattern` ID: + +// [source,sh] +// -------------------------------------------------- +// $ curl -X GET api/saved_objects/index-pattern/my-pattern +// -------------------------------------------------- +// // KIBANA + +// The API returns the following: + +// [source,sh] +// -------------------------------------------------- +// { +// "id": "my-pattern", +// "type": "index-pattern", +// "version": 1, +// "attributes": { +// "title": "my-pattern-*" +// } +// } +// -------------------------------------------------- + +// Retrieve a dashboard object in the `testspace` by ID: + +// [source,sh] +// -------------------------------------------------- +// $ curl -X GET s/testspace/api/saved_objects/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d +// -------------------------------------------------- +// // KIBANA + +// The API returns the following: + +// [source,sh] +// -------------------------------------------------- +// { +// "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", +// "type": "dashboard", +// "updated_at": "2019-07-23T00:11:07.059Z", +// "version": "WzQ0LDFd", +// "attributes": { +// "title": "[Flights] Global Flight Dashboard", +// "hits": 0, +// "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", +// "panelsJSON": "[ . . . ]", +// "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", +// "version": 1, +// "timeRestore": true, +// "timeTo": "now", +// "timeFrom": "now-24h", +// "refreshInterval": { +// "display": "15 minutes", +// "pause": false, +// "section": 2, +// "value": 900000 +// }, +// "kibanaSavedObjectMeta": { +// "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" +// } +// }, +// "references": [ +// { +// "name": "panel_0", +// "type": "visualization", +// "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" +// }, +// . . . +// { +// "name": "panel_18", +// "type": "visualization", +// "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" +// } +// ], +// "migrationVersion": { +// "dashboard": "7.0.0" +// } +// } +// -------------------------------------------------- diff --git a/docs/api/actions/delete.asciidoc b/docs/api/actions/delete.asciidoc new file mode 100644 index 0000000000000..f52ad659c1e14 --- /dev/null +++ b/docs/api/actions/delete.asciidoc @@ -0,0 +1,114 @@ +[[actions-api-delete]] +// === Get object API +// ++++ +// Get object +// ++++ + +// experimental[] Retrieve a single {kib} saved object by ID. + +// [[saved-objects-api-get-request]] +// ==== Request + +// `GET :/api/saved_objects//` + +// `GET :/s//api/saved_objects//` + +// [[saved-objects-api-get-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. + + +// `type`:: +// (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. + +// `id`:: +// (Required, string) The ID of the object to retrieve. + +// [[saved-objects-api-get-codes]] +// ==== Response code + +// `200`:: +// Indicates a successful call. + +// [[saved-objects-api-get-example]] +// ==== Example + +// Retrieve the index pattern object with the `my-pattern` ID: + +// [source,sh] +// -------------------------------------------------- +// $ curl -X GET api/saved_objects/index-pattern/my-pattern +// -------------------------------------------------- +// // KIBANA + +// The API returns the following: + +// [source,sh] +// -------------------------------------------------- +// { +// "id": "my-pattern", +// "type": "index-pattern", +// "version": 1, +// "attributes": { +// "title": "my-pattern-*" +// } +// } +// -------------------------------------------------- + +// Retrieve a dashboard object in the `testspace` by ID: + +// [source,sh] +// -------------------------------------------------- +// $ curl -X GET s/testspace/api/saved_objects/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d +// -------------------------------------------------- +// // KIBANA + +// The API returns the following: + +// [source,sh] +// -------------------------------------------------- +// { +// "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", +// "type": "dashboard", +// "updated_at": "2019-07-23T00:11:07.059Z", +// "version": "WzQ0LDFd", +// "attributes": { +// "title": "[Flights] Global Flight Dashboard", +// "hits": 0, +// "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", +// "panelsJSON": "[ . . . ]", +// "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", +// "version": 1, +// "timeRestore": true, +// "timeTo": "now", +// "timeFrom": "now-24h", +// "refreshInterval": { +// "display": "15 minutes", +// "pause": false, +// "section": 2, +// "value": 900000 +// }, +// "kibanaSavedObjectMeta": { +// "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" +// } +// }, +// "references": [ +// { +// "name": "panel_0", +// "type": "visualization", +// "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" +// }, +// . . . +// { +// "name": "panel_18", +// "type": "visualization", +// "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" +// } +// ], +// "migrationVersion": { +// "dashboard": "7.0.0" +// } +// } +// -------------------------------------------------- diff --git a/docs/api/actions/execute.asciidoc b/docs/api/actions/execute.asciidoc new file mode 100644 index 0000000000000..b807384692b98 --- /dev/null +++ b/docs/api/actions/execute.asciidoc @@ -0,0 +1,114 @@ +[[actions-api-execute]] +// === Get object API +// ++++ +// Get object +// ++++ + +// experimental[] Retrieve a single {kib} saved object by ID. + +// [[saved-objects-api-get-request]] +// ==== Request + +// `GET :/api/saved_objects//` + +// `GET :/s//api/saved_objects//` + +// [[saved-objects-api-get-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. + + +// `type`:: +// (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. + +// `id`:: +// (Required, string) The ID of the object to retrieve. + +// [[saved-objects-api-get-codes]] +// ==== Response code + +// `200`:: +// Indicates a successful call. + +// [[saved-objects-api-get-example]] +// ==== Example + +// Retrieve the index pattern object with the `my-pattern` ID: + +// [source,sh] +// -------------------------------------------------- +// $ curl -X GET api/saved_objects/index-pattern/my-pattern +// -------------------------------------------------- +// // KIBANA + +// The API returns the following: + +// [source,sh] +// -------------------------------------------------- +// { +// "id": "my-pattern", +// "type": "index-pattern", +// "version": 1, +// "attributes": { +// "title": "my-pattern-*" +// } +// } +// -------------------------------------------------- + +// Retrieve a dashboard object in the `testspace` by ID: + +// [source,sh] +// -------------------------------------------------- +// $ curl -X GET s/testspace/api/saved_objects/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d +// -------------------------------------------------- +// // KIBANA + +// The API returns the following: + +// [source,sh] +// -------------------------------------------------- +// { +// "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", +// "type": "dashboard", +// "updated_at": "2019-07-23T00:11:07.059Z", +// "version": "WzQ0LDFd", +// "attributes": { +// "title": "[Flights] Global Flight Dashboard", +// "hits": 0, +// "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", +// "panelsJSON": "[ . . . ]", +// "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", +// "version": 1, +// "timeRestore": true, +// "timeTo": "now", +// "timeFrom": "now-24h", +// "refreshInterval": { +// "display": "15 minutes", +// "pause": false, +// "section": 2, +// "value": 900000 +// }, +// "kibanaSavedObjectMeta": { +// "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" +// } +// }, +// "references": [ +// { +// "name": "panel_0", +// "type": "visualization", +// "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" +// }, +// . . . +// { +// "name": "panel_18", +// "type": "visualization", +// "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" +// } +// ], +// "migrationVersion": { +// "dashboard": "7.0.0" +// } +// } +// -------------------------------------------------- diff --git a/docs/api/actions/get.asciidoc b/docs/api/actions/get.asciidoc new file mode 100644 index 0000000000000..96205561b6a13 --- /dev/null +++ b/docs/api/actions/get.asciidoc @@ -0,0 +1,114 @@ +[[actions-api-get]] +// === Get object API +// ++++ +// Get object +// ++++ + +// experimental[] Retrieve a single {kib} saved object by ID. + +// [[saved-objects-api-get-request]] +// ==== Request + +// `GET :/api/saved_objects//` + +// `GET :/s//api/saved_objects//` + +// [[saved-objects-api-get-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. + + +// `type`:: +// (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. + +// `id`:: +// (Required, string) The ID of the object to retrieve. + +// [[saved-objects-api-get-codes]] +// ==== Response code + +// `200`:: +// Indicates a successful call. + +// [[saved-objects-api-get-example]] +// ==== Example + +// Retrieve the index pattern object with the `my-pattern` ID: + +// [source,sh] +// -------------------------------------------------- +// $ curl -X GET api/saved_objects/index-pattern/my-pattern +// -------------------------------------------------- +// // KIBANA + +// The API returns the following: + +// [source,sh] +// -------------------------------------------------- +// { +// "id": "my-pattern", +// "type": "index-pattern", +// "version": 1, +// "attributes": { +// "title": "my-pattern-*" +// } +// } +// -------------------------------------------------- + +// Retrieve a dashboard object in the `testspace` by ID: + +// [source,sh] +// -------------------------------------------------- +// $ curl -X GET s/testspace/api/saved_objects/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d +// -------------------------------------------------- +// // KIBANA + +// The API returns the following: + +// [source,sh] +// -------------------------------------------------- +// { +// "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", +// "type": "dashboard", +// "updated_at": "2019-07-23T00:11:07.059Z", +// "version": "WzQ0LDFd", +// "attributes": { +// "title": "[Flights] Global Flight Dashboard", +// "hits": 0, +// "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", +// "panelsJSON": "[ . . . ]", +// "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", +// "version": 1, +// "timeRestore": true, +// "timeTo": "now", +// "timeFrom": "now-24h", +// "refreshInterval": { +// "display": "15 minutes", +// "pause": false, +// "section": 2, +// "value": 900000 +// }, +// "kibanaSavedObjectMeta": { +// "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" +// } +// }, +// "references": [ +// { +// "name": "panel_0", +// "type": "visualization", +// "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" +// }, +// . . . +// { +// "name": "panel_18", +// "type": "visualization", +// "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" +// } +// ], +// "migrationVersion": { +// "dashboard": "7.0.0" +// } +// } +// -------------------------------------------------- diff --git a/docs/api/actions/get_all.asciidoc b/docs/api/actions/get_all.asciidoc new file mode 100644 index 0000000000000..070954472b2a2 --- /dev/null +++ b/docs/api/actions/get_all.asciidoc @@ -0,0 +1,114 @@ +[[actions-api-get_all]] +// === Get object API +// ++++ +// Get object +// ++++ + +// experimental[] Retrieve a single {kib} saved object by ID. + +// [[saved-objects-api-get-request]] +// ==== Request + +// `GET :/api/saved_objects//` + +// `GET :/s//api/saved_objects//` + +// [[saved-objects-api-get-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. + + +// `type`:: +// (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. + +// `id`:: +// (Required, string) The ID of the object to retrieve. + +// [[saved-objects-api-get-codes]] +// ==== Response code + +// `200`:: +// Indicates a successful call. + +// [[saved-objects-api-get-example]] +// ==== Example + +// Retrieve the index pattern object with the `my-pattern` ID: + +// [source,sh] +// -------------------------------------------------- +// $ curl -X GET api/saved_objects/index-pattern/my-pattern +// -------------------------------------------------- +// // KIBANA + +// The API returns the following: + +// [source,sh] +// -------------------------------------------------- +// { +// "id": "my-pattern", +// "type": "index-pattern", +// "version": 1, +// "attributes": { +// "title": "my-pattern-*" +// } +// } +// -------------------------------------------------- + +// Retrieve a dashboard object in the `testspace` by ID: + +// [source,sh] +// -------------------------------------------------- +// $ curl -X GET s/testspace/api/saved_objects/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d +// -------------------------------------------------- +// // KIBANA + +// The API returns the following: + +// [source,sh] +// -------------------------------------------------- +// { +// "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", +// "type": "dashboard", +// "updated_at": "2019-07-23T00:11:07.059Z", +// "version": "WzQ0LDFd", +// "attributes": { +// "title": "[Flights] Global Flight Dashboard", +// "hits": 0, +// "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", +// "panelsJSON": "[ . . . ]", +// "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", +// "version": 1, +// "timeRestore": true, +// "timeTo": "now", +// "timeFrom": "now-24h", +// "refreshInterval": { +// "display": "15 minutes", +// "pause": false, +// "section": 2, +// "value": 900000 +// }, +// "kibanaSavedObjectMeta": { +// "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" +// } +// }, +// "references": [ +// { +// "name": "panel_0", +// "type": "visualization", +// "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" +// }, +// . . . +// { +// "name": "panel_18", +// "type": "visualization", +// "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" +// } +// ], +// "migrationVersion": { +// "dashboard": "7.0.0" +// } +// } +// -------------------------------------------------- diff --git a/docs/api/actions/list.asciidoc b/docs/api/actions/list.asciidoc new file mode 100644 index 0000000000000..be62bd9401f76 --- /dev/null +++ b/docs/api/actions/list.asciidoc @@ -0,0 +1,114 @@ +[[actions-api-list]] +// === Get object API +// ++++ +// Get object +// ++++ + +// experimental[] Retrieve a single {kib} saved object by ID. + +// [[saved-objects-api-get-request]] +// ==== Request + +// `GET :/api/saved_objects//` + +// `GET :/s//api/saved_objects//` + +// [[saved-objects-api-get-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. + + +// `type`:: +// (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. + +// `id`:: +// (Required, string) The ID of the object to retrieve. + +// [[saved-objects-api-get-codes]] +// ==== Response code + +// `200`:: +// Indicates a successful call. + +// [[saved-objects-api-get-example]] +// ==== Example + +// Retrieve the index pattern object with the `my-pattern` ID: + +// [source,sh] +// -------------------------------------------------- +// $ curl -X GET api/saved_objects/index-pattern/my-pattern +// -------------------------------------------------- +// // KIBANA + +// The API returns the following: + +// [source,sh] +// -------------------------------------------------- +// { +// "id": "my-pattern", +// "type": "index-pattern", +// "version": 1, +// "attributes": { +// "title": "my-pattern-*" +// } +// } +// -------------------------------------------------- + +// Retrieve a dashboard object in the `testspace` by ID: + +// [source,sh] +// -------------------------------------------------- +// $ curl -X GET s/testspace/api/saved_objects/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d +// -------------------------------------------------- +// // KIBANA + +// The API returns the following: + +// [source,sh] +// -------------------------------------------------- +// { +// "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", +// "type": "dashboard", +// "updated_at": "2019-07-23T00:11:07.059Z", +// "version": "WzQ0LDFd", +// "attributes": { +// "title": "[Flights] Global Flight Dashboard", +// "hits": 0, +// "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", +// "panelsJSON": "[ . . . ]", +// "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", +// "version": 1, +// "timeRestore": true, +// "timeTo": "now", +// "timeFrom": "now-24h", +// "refreshInterval": { +// "display": "15 minutes", +// "pause": false, +// "section": 2, +// "value": 900000 +// }, +// "kibanaSavedObjectMeta": { +// "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" +// } +// }, +// "references": [ +// { +// "name": "panel_0", +// "type": "visualization", +// "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" +// }, +// . . . +// { +// "name": "panel_18", +// "type": "visualization", +// "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" +// } +// ], +// "migrationVersion": { +// "dashboard": "7.0.0" +// } +// } +// -------------------------------------------------- diff --git a/docs/api/actions/update.asciidoc b/docs/api/actions/update.asciidoc new file mode 100644 index 0000000000000..3caa3aebfe6e0 --- /dev/null +++ b/docs/api/actions/update.asciidoc @@ -0,0 +1,114 @@ +[[actions-api-update]] +// === Get object API +// ++++ +// Get object +// ++++ + +// experimental[] Retrieve a single {kib} saved object by ID. + +// [[saved-objects-api-get-request]] +// ==== Request + +// `GET :/api/saved_objects//` + +// `GET :/s//api/saved_objects//` + +// [[saved-objects-api-get-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. + + +// `type`:: +// (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. + +// `id`:: +// (Required, string) The ID of the object to retrieve. + +// [[saved-objects-api-get-codes]] +// ==== Response code + +// `200`:: +// Indicates a successful call. + +// [[saved-objects-api-get-example]] +// ==== Example + +// Retrieve the index pattern object with the `my-pattern` ID: + +// [source,sh] +// -------------------------------------------------- +// $ curl -X GET api/saved_objects/index-pattern/my-pattern +// -------------------------------------------------- +// // KIBANA + +// The API returns the following: + +// [source,sh] +// -------------------------------------------------- +// { +// "id": "my-pattern", +// "type": "index-pattern", +// "version": 1, +// "attributes": { +// "title": "my-pattern-*" +// } +// } +// -------------------------------------------------- + +// Retrieve a dashboard object in the `testspace` by ID: + +// [source,sh] +// -------------------------------------------------- +// $ curl -X GET s/testspace/api/saved_objects/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d +// -------------------------------------------------- +// // KIBANA + +// The API returns the following: + +// [source,sh] +// -------------------------------------------------- +// { +// "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", +// "type": "dashboard", +// "updated_at": "2019-07-23T00:11:07.059Z", +// "version": "WzQ0LDFd", +// "attributes": { +// "title": "[Flights] Global Flight Dashboard", +// "hits": 0, +// "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", +// "panelsJSON": "[ . . . ]", +// "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", +// "version": 1, +// "timeRestore": true, +// "timeTo": "now", +// "timeFrom": "now-24h", +// "refreshInterval": { +// "display": "15 minutes", +// "pause": false, +// "section": 2, +// "value": 900000 +// }, +// "kibanaSavedObjectMeta": { +// "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" +// } +// }, +// "references": [ +// { +// "name": "panel_0", +// "type": "visualization", +// "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" +// }, +// . . . +// { +// "name": "panel_18", +// "type": "visualization", +// "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" +// } +// ], +// "migrationVersion": { +// "dashboard": "7.0.0" +// } +// } +// -------------------------------------------------- From 89fa96ab2237aed0d4cffc9a87fdb4de973bc53a Mon Sep 17 00:00:00 2001 From: Ying Mao Date: Tue, 9 Feb 2021 07:36:40 -0500 Subject: [PATCH 2/8] wip --- docs/api/actions-and-connectors.asciidoc | 83 +++++++++++++ .../actions-and-connectors/create.asciidoc | 52 ++++++++ .../delete.asciidoc | 10 +- .../execute.asciidoc | 10 +- .../get.asciidoc | 18 +-- .../get_all.asciidoc | 10 +- docs/api/actions-and-connectors/list.asciidoc | 82 +++++++++++++ .../update.asciidoc | 10 +- docs/api/actions.asciidoc | 28 ----- docs/api/actions/create.asciidoc | 114 ------------------ docs/api/actions/list.asciidoc | 114 ------------------ .../user/alerting/action-types/email.asciidoc | 1 + .../user/alerting/action-types/index.asciidoc | 1 + docs/user/alerting/action-types/jira.asciidoc | 1 + .../alerting/action-types/pagerduty.asciidoc | 1 + .../alerting/action-types/resilient.asciidoc | 1 + .../alerting/action-types/servicenow.asciidoc | 1 + .../user/alerting/action-types/slack.asciidoc | 1 + .../user/alerting/action-types/teams.asciidoc | 1 + .../alerting/action-types/webhook.asciidoc | 1 + docs/user/api.asciidoc | 1 + 21 files changed, 256 insertions(+), 285 deletions(-) create mode 100644 docs/api/actions-and-connectors.asciidoc create mode 100644 docs/api/actions-and-connectors/create.asciidoc rename docs/api/{actions => actions-and-connectors}/delete.asciidoc (96%) rename docs/api/{actions => actions-and-connectors}/execute.asciidoc (96%) rename docs/api/{actions => actions-and-connectors}/get.asciidoc (91%) rename docs/api/{actions => actions-and-connectors}/get_all.asciidoc (96%) create mode 100644 docs/api/actions-and-connectors/list.asciidoc rename docs/api/{actions => actions-and-connectors}/update.asciidoc (96%) delete mode 100644 docs/api/actions.asciidoc delete mode 100644 docs/api/actions/create.asciidoc delete mode 100644 docs/api/actions/list.asciidoc diff --git a/docs/api/actions-and-connectors.asciidoc b/docs/api/actions-and-connectors.asciidoc new file mode 100644 index 0000000000000..36db02d53c7ba --- /dev/null +++ b/docs/api/actions-and-connectors.asciidoc @@ -0,0 +1,83 @@ +[[actions-and-connectors-api]] +== Actions and Connectors APIs + +Manage your {kib} actions and connectors. + +The following {kib} actions APIs are available: + +* <> to retrieve a single {kib} action by ID + +* <> to retrieve all {kib} actions + +* <> to retrieve a list of all {kib} action types + +* <> to create {kib} action + +* <> to update the attributes for an existing {kib} action + +* <> to execute a {kib} action by ID + +* <> to remove {kib} action by ID + +=== Action types + +{kib} ships with a set of built-in action types: + +[options="header"] +|=== + +| Type | Id | Description + +| Server log +| `.server-log` +| Logs messages to the {kib} log using {kib}'s logger + +| Email +| `.email` +| Sends an email using SMTP + +| Slack +| `.slack` +| Posts a message to a Slack channel + +| Microsoft Teams +| `.teams` +| Posts a message to a Microsoft Teams channel + +| Index +| `.index` +| Indexes document(s) into Elasticsearch + +| Webhook +| `.webhook` +| Sends a payload to a web service using `HTTP POST` or `PUT` + +| PagerDuty +| `.pagerduty` +| Triggers, resolves or acknowledges an incident to a PagerDuty service + +| ServiceNow ITSM +| `.servicenow` +| Creates or updates an incident to a ServiceNow ITSM instance + +| ServiceNow SIR +| `.servicenow-sir` +| Creates or updates an incident to a ServiceNow SIR instance + +| Jira +| `.jira` +| Creates or updates an issue to a Jira instance + +| IBM Resilient +| `.resilient` +| Creates or updates an incident to an IBM Resilient instance + +|=== + +include::actions-and-connectors/get.asciidoc[] +include::actions-and-connectors/get_all.asciidoc[] +include::actions-and-connectors/list.asciidoc[] +include::actions-and-connectors/create.asciidoc[] +include::actions-and-connectors/update.asciidoc[] +include::actions-and-connectors/execute.asciidoc[] +include::actions-and-connectors/delete.asciidoc[] diff --git a/docs/api/actions-and-connectors/create.asciidoc b/docs/api/actions-and-connectors/create.asciidoc new file mode 100644 index 0000000000000..a5d322ce15b7e --- /dev/null +++ b/docs/api/actions-and-connectors/create.asciidoc @@ -0,0 +1,52 @@ +[[actions-and-connectors-api-create]] +=== Create action API +++++ +Create actions and connectors +++++ + +Create {kib} actions and connectors. + +[[actions-and-connectors-api-create-request]] +==== Request + +`POST :/api/actions/action` + +[[actions-and-connectors-api-create-request-body]] +==== Request body + +`name`:: + (Required, string) The display name for the action. + +`actionTypeId`:: + (Required, string) The action type for the action. + +`config`:: + (Required, object) The action configuration. Expected configuration varies depending on + the action type. See the specific action type to determine configuration definition. + +`secrets`:: + (Required, object) The secrets configuration for the action. Expected configuration varies + depending on the action type. See the specific ation type to determine secrets definition. + +[[actions-and-connectors-api-create-request-codes]] +==== Response code + +`200`:: + Indicates a successful call. + +[[actions-and-connectors-api-create-example]] +==== Example + +[source,sh] +-------------------------------------------------- +$ curl -X POST api/actions/action -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d ' +{ + "name": "my-action", + "actionTypeId": ".index", + "config": { + "index": "test-index" + } +}' +-------------------------------------------------- +// KIBANA + diff --git a/docs/api/actions/delete.asciidoc b/docs/api/actions-and-connectors/delete.asciidoc similarity index 96% rename from docs/api/actions/delete.asciidoc rename to docs/api/actions-and-connectors/delete.asciidoc index f52ad659c1e14..8d32f7717f5aa 100644 --- a/docs/api/actions/delete.asciidoc +++ b/docs/api/actions-and-connectors/delete.asciidoc @@ -1,8 +1,8 @@ -[[actions-api-delete]] -// === Get object API -// ++++ -// Get object -// ++++ +[[actions-and-connectors-api-delete]] +=== Delete action API +++++ +Delete action +++++ // experimental[] Retrieve a single {kib} saved object by ID. diff --git a/docs/api/actions/execute.asciidoc b/docs/api/actions-and-connectors/execute.asciidoc similarity index 96% rename from docs/api/actions/execute.asciidoc rename to docs/api/actions-and-connectors/execute.asciidoc index b807384692b98..c7e8e430d85af 100644 --- a/docs/api/actions/execute.asciidoc +++ b/docs/api/actions-and-connectors/execute.asciidoc @@ -1,8 +1,8 @@ -[[actions-api-execute]] -// === Get object API -// ++++ -// Get object -// ++++ +[[actions-and-connectors-api-execute]] +=== Execute action API +++++ +Execute action +++++ // experimental[] Retrieve a single {kib} saved object by ID. diff --git a/docs/api/actions/get.asciidoc b/docs/api/actions-and-connectors/get.asciidoc similarity index 91% rename from docs/api/actions/get.asciidoc rename to docs/api/actions-and-connectors/get.asciidoc index 96205561b6a13..e7fbf072d00d0 100644 --- a/docs/api/actions/get.asciidoc +++ b/docs/api/actions-and-connectors/get.asciidoc @@ -1,15 +1,15 @@ -[[actions-api-get]] -// === Get object API -// ++++ -// Get object -// ++++ +[[actions-and-connectors-api-get]] +=== Get action API +++++ +Get action +++++ -// experimental[] Retrieve a single {kib} saved object by ID. +Retrieve a single {kib} action by ID. -// [[saved-objects-api-get-request]] -// ==== Request +[[actions-and-connectors-api-get-request]] +==== Request -// `GET :/api/saved_objects//` +`GET :/api/actions/action/` // `GET :/s//api/saved_objects//` diff --git a/docs/api/actions/get_all.asciidoc b/docs/api/actions-and-connectors/get_all.asciidoc similarity index 96% rename from docs/api/actions/get_all.asciidoc rename to docs/api/actions-and-connectors/get_all.asciidoc index 070954472b2a2..e67b1cb33f4f6 100644 --- a/docs/api/actions/get_all.asciidoc +++ b/docs/api/actions-and-connectors/get_all.asciidoc @@ -1,8 +1,8 @@ -[[actions-api-get_all]] -// === Get object API -// ++++ -// Get object -// ++++ +[[actions-and-connectors-api-get-all]] +=== Get all actions API +++++ +Get all actions +++++ // experimental[] Retrieve a single {kib} saved object by ID. diff --git a/docs/api/actions-and-connectors/list.asciidoc b/docs/api/actions-and-connectors/list.asciidoc new file mode 100644 index 0000000000000..7133aa381c181 --- /dev/null +++ b/docs/api/actions-and-connectors/list.asciidoc @@ -0,0 +1,82 @@ +[[actions-and-connectors-api-list]] +=== List action types API +++++ +List action types +++++ + +experimental[] Retrieve a list of all {kib} action types. + +[[actions-and-connectors-api-list-request]] +==== Request + +`GET :/api/actions/list_action_types` + +[[actions-and-connectors-api-list-codes]] +==== Response code + +`200`:: + Indicates a successful call. + +[[actions-and-connectors-api-list-example]] +==== Example + +[source,sh] +-------------------------------------------------- +$ curl -X GET api/actions/list_action_types +-------------------------------------------------- +// KIBANA + +==== Action types + +{kib} ships with a set of built-in action types: + +[options="header"] +|=== + +| Type | Id | Config + +| Email +| `.email` +| <> + +| IBM Resilient +| `.resilient` +| <> + +| Index +| `.index` +| <> + +| Jira +| `.jira` +| <> + +| Microsoft Teams +| `.teams` +| <> + +| PagerDuty +| `.pagerduty` +| <> + +| Server log +| `.server-log` +| <> + +| ServiceNow ITSM +| `.servicenow` +| <> + +| ServiceNow SIR +| `.servicenow-sir` +| <> + +| Slack +| `.slack` +| <> + +| Webhook +| `.webhook` +| <> + +|=== \ No newline at end of file diff --git a/docs/api/actions/update.asciidoc b/docs/api/actions-and-connectors/update.asciidoc similarity index 96% rename from docs/api/actions/update.asciidoc rename to docs/api/actions-and-connectors/update.asciidoc index 3caa3aebfe6e0..0002a6507ccbc 100644 --- a/docs/api/actions/update.asciidoc +++ b/docs/api/actions-and-connectors/update.asciidoc @@ -1,8 +1,8 @@ -[[actions-api-update]] -// === Get object API -// ++++ -// Get object -// ++++ +[[actions-and-connectors-api-update]] +=== Update action API +++++ +Update action +++++ // experimental[] Retrieve a single {kib} saved object by ID. diff --git a/docs/api/actions.asciidoc b/docs/api/actions.asciidoc deleted file mode 100644 index bddc53477c502..0000000000000 --- a/docs/api/actions.asciidoc +++ /dev/null @@ -1,28 +0,0 @@ -[[actions-api]] -== Actions and Connectors APIs - -Manage your {kib} actions. - -The following {kib} actions APIs are available: - -* <> to retrieve a single {kib} action by ID - -* <> to retrieve all {kib} actions - -* <> to retrieve a list of all {kib} action types - -* <> to create {kib} action - -* <> to update the attributes for an existing {kib} action - -* <> to execute a {kib} action by ID - -* <> to remove {kib} action by ID - -include::actions/get.asciidoc[] -include::actions/get_all.asciidoc[] -include::actions/list.asciidoc[] -include::actions/create.asciidoc[] -include::actions/update.asciidoc[] -include::actions/execute.asciidoc[] -include::actions/delete.asciidoc[] diff --git a/docs/api/actions/create.asciidoc b/docs/api/actions/create.asciidoc deleted file mode 100644 index a9f6ff3ede6aa..0000000000000 --- a/docs/api/actions/create.asciidoc +++ /dev/null @@ -1,114 +0,0 @@ -[[actions-api-create]] -// === Get object API -// ++++ -// Get object -// ++++ - -// experimental[] Retrieve a single {kib} saved object by ID. - -// [[saved-objects-api-get-request]] -// ==== Request - -// `GET :/api/saved_objects//` - -// `GET :/s//api/saved_objects//` - -// [[saved-objects-api-get-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. - - -// `type`:: -// (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. - -// `id`:: -// (Required, string) The ID of the object to retrieve. - -// [[saved-objects-api-get-codes]] -// ==== Response code - -// `200`:: -// Indicates a successful call. - -// [[saved-objects-api-get-example]] -// ==== Example - -// Retrieve the index pattern object with the `my-pattern` ID: - -// [source,sh] -// -------------------------------------------------- -// $ curl -X GET api/saved_objects/index-pattern/my-pattern -// -------------------------------------------------- -// // KIBANA - -// The API returns the following: - -// [source,sh] -// -------------------------------------------------- -// { -// "id": "my-pattern", -// "type": "index-pattern", -// "version": 1, -// "attributes": { -// "title": "my-pattern-*" -// } -// } -// -------------------------------------------------- - -// Retrieve a dashboard object in the `testspace` by ID: - -// [source,sh] -// -------------------------------------------------- -// $ curl -X GET s/testspace/api/saved_objects/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d -// -------------------------------------------------- -// // KIBANA - -// The API returns the following: - -// [source,sh] -// -------------------------------------------------- -// { -// "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", -// "type": "dashboard", -// "updated_at": "2019-07-23T00:11:07.059Z", -// "version": "WzQ0LDFd", -// "attributes": { -// "title": "[Flights] Global Flight Dashboard", -// "hits": 0, -// "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", -// "panelsJSON": "[ . . . ]", -// "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", -// "version": 1, -// "timeRestore": true, -// "timeTo": "now", -// "timeFrom": "now-24h", -// "refreshInterval": { -// "display": "15 minutes", -// "pause": false, -// "section": 2, -// "value": 900000 -// }, -// "kibanaSavedObjectMeta": { -// "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" -// } -// }, -// "references": [ -// { -// "name": "panel_0", -// "type": "visualization", -// "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" -// }, -// . . . -// { -// "name": "panel_18", -// "type": "visualization", -// "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" -// } -// ], -// "migrationVersion": { -// "dashboard": "7.0.0" -// } -// } -// -------------------------------------------------- diff --git a/docs/api/actions/list.asciidoc b/docs/api/actions/list.asciidoc deleted file mode 100644 index be62bd9401f76..0000000000000 --- a/docs/api/actions/list.asciidoc +++ /dev/null @@ -1,114 +0,0 @@ -[[actions-api-list]] -// === Get object API -// ++++ -// Get object -// ++++ - -// experimental[] Retrieve a single {kib} saved object by ID. - -// [[saved-objects-api-get-request]] -// ==== Request - -// `GET :/api/saved_objects//` - -// `GET :/s//api/saved_objects//` - -// [[saved-objects-api-get-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. - - -// `type`:: -// (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. - -// `id`:: -// (Required, string) The ID of the object to retrieve. - -// [[saved-objects-api-get-codes]] -// ==== Response code - -// `200`:: -// Indicates a successful call. - -// [[saved-objects-api-get-example]] -// ==== Example - -// Retrieve the index pattern object with the `my-pattern` ID: - -// [source,sh] -// -------------------------------------------------- -// $ curl -X GET api/saved_objects/index-pattern/my-pattern -// -------------------------------------------------- -// // KIBANA - -// The API returns the following: - -// [source,sh] -// -------------------------------------------------- -// { -// "id": "my-pattern", -// "type": "index-pattern", -// "version": 1, -// "attributes": { -// "title": "my-pattern-*" -// } -// } -// -------------------------------------------------- - -// Retrieve a dashboard object in the `testspace` by ID: - -// [source,sh] -// -------------------------------------------------- -// $ curl -X GET s/testspace/api/saved_objects/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d -// -------------------------------------------------- -// // KIBANA - -// The API returns the following: - -// [source,sh] -// -------------------------------------------------- -// { -// "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", -// "type": "dashboard", -// "updated_at": "2019-07-23T00:11:07.059Z", -// "version": "WzQ0LDFd", -// "attributes": { -// "title": "[Flights] Global Flight Dashboard", -// "hits": 0, -// "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", -// "panelsJSON": "[ . . . ]", -// "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", -// "version": 1, -// "timeRestore": true, -// "timeTo": "now", -// "timeFrom": "now-24h", -// "refreshInterval": { -// "display": "15 minutes", -// "pause": false, -// "section": 2, -// "value": 900000 -// }, -// "kibanaSavedObjectMeta": { -// "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" -// } -// }, -// "references": [ -// { -// "name": "panel_0", -// "type": "visualization", -// "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" -// }, -// . . . -// { -// "name": "panel_18", -// "type": "visualization", -// "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" -// } -// ], -// "migrationVersion": { -// "dashboard": "7.0.0" -// } -// } -// -------------------------------------------------- diff --git a/docs/user/alerting/action-types/email.asciidoc b/docs/user/alerting/action-types/email.asciidoc index d7a9373a6e2a9..3562be1e405f6 100644 --- a/docs/user/alerting/action-types/email.asciidoc +++ b/docs/user/alerting/action-types/email.asciidoc @@ -37,6 +37,7 @@ Password:: password for 'login' type authentication. password: passwordkeystorevalue -- +[[email-connector-config-properties]] `config` defines the action type specific to the configuration and contains the following properties: [cols="2*<"] diff --git a/docs/user/alerting/action-types/index.asciidoc b/docs/user/alerting/action-types/index.asciidoc index 2c6da7c7c3026..2f459edea28f1 100644 --- a/docs/user/alerting/action-types/index.asciidoc +++ b/docs/user/alerting/action-types/index.asciidoc @@ -30,6 +30,7 @@ Execution time field:: This field will be automatically set to the time the ale executionTimeField: somedate -- +[[index-connector-config-properties]] `config` defines the action type specific to the configuration and contains the following properties: [cols="2*<"] diff --git a/docs/user/alerting/action-types/jira.asciidoc b/docs/user/alerting/action-types/jira.asciidoc index 65e5ee4fc4a01..6e47d5618d598 100644 --- a/docs/user/alerting/action-types/jira.asciidoc +++ b/docs/user/alerting/action-types/jira.asciidoc @@ -33,6 +33,7 @@ API token (or password):: Jira API authentication token (or password) for HTTP apiToken: tokenkeystorevalue -- +[[jira-connector-config-properties]] `config` defines the action type specific to the configuration and contains the following properties: [cols="2*<"] diff --git a/docs/user/alerting/action-types/pagerduty.asciidoc b/docs/user/alerting/action-types/pagerduty.asciidoc index aad192dbddb30..e1078a55ddd0d 100644 --- a/docs/user/alerting/action-types/pagerduty.asciidoc +++ b/docs/user/alerting/action-types/pagerduty.asciidoc @@ -150,6 +150,7 @@ Integration Key:: A 32 character PagerDuty Integration Key for an integration routingKey: testroutingkey -- +[[pagerduty-connector-config-properties]] `config` defines the action type specific to the configuration. `config` contains `apiURL`, a string that corresponds to *API URL*. diff --git a/docs/user/alerting/action-types/resilient.asciidoc b/docs/user/alerting/action-types/resilient.asciidoc index b5ddb76d49b0c..112246ab91162 100644 --- a/docs/user/alerting/action-types/resilient.asciidoc +++ b/docs/user/alerting/action-types/resilient.asciidoc @@ -33,6 +33,7 @@ API key secret:: The authentication key secret for HTTP Basic authentication. apiKeySecret: tokenkeystorevalue -- +[[resilient-connector-config-properties]] `config` defines the action type specific to the configuration and contains the following properties: [cols="2*<"] diff --git a/docs/user/alerting/action-types/servicenow.asciidoc b/docs/user/alerting/action-types/servicenow.asciidoc index 0acb92bcdb5ee..5d8782c14e581 100644 --- a/docs/user/alerting/action-types/servicenow.asciidoc +++ b/docs/user/alerting/action-types/servicenow.asciidoc @@ -31,6 +31,7 @@ Password:: Password for HTTP Basic authentication. password: passwordkeystorevalue -- +[[servicenow-connector-config-properties]] `config` defines the action type specific to the configuration and contains the following properties: [cols="2*<"] diff --git a/docs/user/alerting/action-types/slack.asciidoc b/docs/user/alerting/action-types/slack.asciidoc index a1fe7a2521b22..6a38e5c827ab2 100644 --- a/docs/user/alerting/action-types/slack.asciidoc +++ b/docs/user/alerting/action-types/slack.asciidoc @@ -26,6 +26,7 @@ Webhook URL:: The URL of the incoming webhook. See https://api.slack.com/messa webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz' -- +[[slack-connector-config-properties]] `config` defines the action type specific to the configuration. `config` contains `webhookUrl`, a string that corresponds to *Webhook URL*. diff --git a/docs/user/alerting/action-types/teams.asciidoc b/docs/user/alerting/action-types/teams.asciidoc index 6706dd2e5643f..e1ce91fc0c123 100644 --- a/docs/user/alerting/action-types/teams.asciidoc +++ b/docs/user/alerting/action-types/teams.asciidoc @@ -26,6 +26,7 @@ Webhook URL:: The URL of the incoming webhook. See https://docs.microsoft.com/ webhookUrl: 'https://outlook.office.com/webhook/abcd@0123456/IncomingWebhook/abcdefgh/ijklmnopqrstuvwxyz' -- +[[teams-connector-config-properties]] `config` defines the action type specific to the configuration. `config` contains `webhookUrl`, a string that corresponds to *Webhook URL*. diff --git a/docs/user/alerting/action-types/webhook.asciidoc b/docs/user/alerting/action-types/webhook.asciidoc index fff6814325ea4..2d626d53d1c77 100644 --- a/docs/user/alerting/action-types/webhook.asciidoc +++ b/docs/user/alerting/action-types/webhook.asciidoc @@ -36,6 +36,7 @@ Password:: An optional password. If set, HTTP basic authentication is used. Cur password: passwordkeystorevalue -- +[[webhook-connector-config-properties]] `config` defines the action type specific to the configuration and contains the following properties: [cols="2*<"] diff --git a/docs/user/api.asciidoc b/docs/user/api.asciidoc index 20f1fc89367f2..2ae83bee1e06c 100644 --- a/docs/user/api.asciidoc +++ b/docs/user/api.asciidoc @@ -36,6 +36,7 @@ include::{kib-repo-dir}/api/features.asciidoc[] include::{kib-repo-dir}/api/spaces-management.asciidoc[] include::{kib-repo-dir}/api/role-management.asciidoc[] include::{kib-repo-dir}/api/saved-objects.asciidoc[] +include::{kib-repo-dir}/api/actions-and-connectors.asciidoc[] include::{kib-repo-dir}/api/dashboard-api.asciidoc[] include::{kib-repo-dir}/api/logstash-configuration-management.asciidoc[] include::{kib-repo-dir}/api/url-shortening.asciidoc[] From ef71fd9168300851b725a2a88e5ba3990f4eb4e5 Mon Sep 17 00:00:00 2001 From: Ying Mao Date: Wed, 10 Feb 2021 11:07:56 -0500 Subject: [PATCH 3/8] Finishing connector API docs --- docs/api/actions-and-connectors.asciidoc | 4 +- .../actions-and-connectors/create.asciidoc | 83 +++++- .../actions-and-connectors/delete.asciidoc | 119 ++------- .../actions-and-connectors/execute.asciidoc | 240 ++++++++++-------- docs/api/actions-and-connectors/get.asciidoc | 142 +++-------- .../actions-and-connectors/get_all.asciidoc | 156 ++++-------- docs/api/actions-and-connectors/list.asciidoc | 84 +++--- .../actions-and-connectors/update.asciidoc | 144 ++++------- 8 files changed, 403 insertions(+), 569 deletions(-) diff --git a/docs/api/actions-and-connectors.asciidoc b/docs/api/actions-and-connectors.asciidoc index 36db02d53c7ba..586aecc5cdf7c 100644 --- a/docs/api/actions-and-connectors.asciidoc +++ b/docs/api/actions-and-connectors.asciidoc @@ -11,13 +11,13 @@ The following {kib} actions APIs are available: * <> to retrieve a list of all {kib} action types -* <> to create {kib} action +* <> to create {kib} actions * <> to update the attributes for an existing {kib} action * <> to execute a {kib} action by ID -* <> to remove {kib} action by ID +* <> to remove a {kib} action by ID === Action types diff --git a/docs/api/actions-and-connectors/create.asciidoc b/docs/api/actions-and-connectors/create.asciidoc index a5d322ce15b7e..766f2646a360d 100644 --- a/docs/api/actions-and-connectors/create.asciidoc +++ b/docs/api/actions-and-connectors/create.asciidoc @@ -1,10 +1,10 @@ [[actions-and-connectors-api-create]] === Create action API ++++ -Create actions and connectors +Create action API ++++ -Create {kib} actions and connectors. +experimental[] Create {kib} actions. [[actions-and-connectors-api-create-request]] ==== Request @@ -18,15 +18,15 @@ Create {kib} actions and connectors. (Required, string) The display name for the action. `actionTypeId`:: - (Required, string) The action type for the action. + (Required, string) The action type ID for the action. `config`:: - (Required, object) The action configuration. Expected configuration varies depending on - the action type. See the specific action type to determine configuration definition. + (Required, object) The action configuration. Configuration properties vary depending on + the action type. Some action types will have no configuration properties. See the specific action type to determine required fields. `secrets`:: - (Required, object) The secrets configuration for the action. Expected configuration varies - depending on the action type. See the specific ation type to determine secrets definition. + (Required, object) The secrets configuration for the action. Secrets properties vary + depending on the action type. Some action types will have no secrets properties. See the specific ation type to determine required fields. [[actions-and-connectors-api-create-request-codes]] ==== Response code @@ -50,3 +50,72 @@ $ curl -X POST api/actions/action -H 'kbn-xsrf: true' -H 'Content-Type: applica -------------------------------------------------- // KIBANA +The API returns the following: + +[source,sh] +-------------------------------------------------- +{ + "id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad", + "actionTypeId": ".index", + "name": "my-action", + "config": { + "index": "test-index", + "refresh": false, + "executionTimeField": null + }, + "isPreconfigured": false +} +-------------------------------------------------- + +==== Action type configuration and secrets + +[options="header"] +|=== + +| Type | Id | Config + +| Email +| `.email` +| <> + +| Index +| `.index` +| <> + +| Jira +| `.jira` +| <> + +| PagerDuty +| `.pagerduty` +| <> + +| IBM Resilient +| `.resilient` +| <> + +| Server log +| `.server-log` +| <> + +| ServiceNow ITSM +| `.servicenow` +| <> + +| ServiceNow SecOps +| `.servicenow-sir` +| <> + +| Slack +| `.slack` +| <> + +| Microsoft Teams +| `.teams` +| <> + +| Webhook +| `.webhook` +| <> + +|=== \ No newline at end of file diff --git a/docs/api/actions-and-connectors/delete.asciidoc b/docs/api/actions-and-connectors/delete.asciidoc index 8d32f7717f5aa..d9b24e7a260e4 100644 --- a/docs/api/actions-and-connectors/delete.asciidoc +++ b/docs/api/actions-and-connectors/delete.asciidoc @@ -1,114 +1,35 @@ [[actions-and-connectors-api-delete]] === Delete action API ++++ -Delete action +Delete action API ++++ -// experimental[] Retrieve a single {kib} saved object by ID. +experimental[] Remove a {kib} action by ID -// [[saved-objects-api-get-request]] -// ==== Request +WARNING: Once you delete an action, _it cannot be recovered_. -// `GET :/api/saved_objects//` +[[actions-and-connectors-api-delete-request]] +==== Request -// `GET :/s//api/saved_objects//` +`DELETE :/api/actions/action/` -// [[saved-objects-api-get-params]] -// ==== Path parameters +[[actions-and-connectors-api-delete-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. +`id`:: + (Required, string) The ID of the action to remove. +[[actions-and-connectors-api-delete-response-codes]] +==== Response code -// `type`:: -// (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. +`200`:: + Indicates a successful call. -// `id`:: -// (Required, string) The ID of the object to retrieve. +==== Example -// [[saved-objects-api-get-codes]] -// ==== Response code +[source,sh] +-------------------------------------------------- +$ curl -X DELETE api/actions/action/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad +-------------------------------------------------- +// KIBANA -// `200`:: -// Indicates a successful call. - -// [[saved-objects-api-get-example]] -// ==== Example - -// Retrieve the index pattern object with the `my-pattern` ID: - -// [source,sh] -// -------------------------------------------------- -// $ curl -X GET api/saved_objects/index-pattern/my-pattern -// -------------------------------------------------- -// // KIBANA - -// The API returns the following: - -// [source,sh] -// -------------------------------------------------- -// { -// "id": "my-pattern", -// "type": "index-pattern", -// "version": 1, -// "attributes": { -// "title": "my-pattern-*" -// } -// } -// -------------------------------------------------- - -// Retrieve a dashboard object in the `testspace` by ID: - -// [source,sh] -// -------------------------------------------------- -// $ curl -X GET s/testspace/api/saved_objects/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d -// -------------------------------------------------- -// // KIBANA - -// The API returns the following: - -// [source,sh] -// -------------------------------------------------- -// { -// "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", -// "type": "dashboard", -// "updated_at": "2019-07-23T00:11:07.059Z", -// "version": "WzQ0LDFd", -// "attributes": { -// "title": "[Flights] Global Flight Dashboard", -// "hits": 0, -// "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", -// "panelsJSON": "[ . . . ]", -// "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", -// "version": 1, -// "timeRestore": true, -// "timeTo": "now", -// "timeFrom": "now-24h", -// "refreshInterval": { -// "display": "15 minutes", -// "pause": false, -// "section": 2, -// "value": 900000 -// }, -// "kibanaSavedObjectMeta": { -// "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" -// } -// }, -// "references": [ -// { -// "name": "panel_0", -// "type": "visualization", -// "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" -// }, -// . . . -// { -// "name": "panel_18", -// "type": "visualization", -// "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" -// } -// ], -// "migrationVersion": { -// "dashboard": "7.0.0" -// } -// } -// -------------------------------------------------- diff --git a/docs/api/actions-and-connectors/execute.asciidoc b/docs/api/actions-and-connectors/execute.asciidoc index c7e8e430d85af..2911242e17110 100644 --- a/docs/api/actions-and-connectors/execute.asciidoc +++ b/docs/api/actions-and-connectors/execute.asciidoc @@ -1,114 +1,136 @@ [[actions-and-connectors-api-execute]] === Execute action API ++++ -Execute action +Execute action API ++++ -// experimental[] Retrieve a single {kib} saved object by ID. - -// [[saved-objects-api-get-request]] -// ==== Request - -// `GET :/api/saved_objects//` - -// `GET :/s//api/saved_objects//` - -// [[saved-objects-api-get-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. - - -// `type`:: -// (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. - -// `id`:: -// (Required, string) The ID of the object to retrieve. - -// [[saved-objects-api-get-codes]] -// ==== Response code - -// `200`:: -// Indicates a successful call. - -// [[saved-objects-api-get-example]] -// ==== Example - -// Retrieve the index pattern object with the `my-pattern` ID: - -// [source,sh] -// -------------------------------------------------- -// $ curl -X GET api/saved_objects/index-pattern/my-pattern -// -------------------------------------------------- -// // KIBANA - -// The API returns the following: - -// [source,sh] -// -------------------------------------------------- -// { -// "id": "my-pattern", -// "type": "index-pattern", -// "version": 1, -// "attributes": { -// "title": "my-pattern-*" -// } -// } -// -------------------------------------------------- - -// Retrieve a dashboard object in the `testspace` by ID: - -// [source,sh] -// -------------------------------------------------- -// $ curl -X GET s/testspace/api/saved_objects/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d -// -------------------------------------------------- -// // KIBANA - -// The API returns the following: - -// [source,sh] -// -------------------------------------------------- -// { -// "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", -// "type": "dashboard", -// "updated_at": "2019-07-23T00:11:07.059Z", -// "version": "WzQ0LDFd", -// "attributes": { -// "title": "[Flights] Global Flight Dashboard", -// "hits": 0, -// "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", -// "panelsJSON": "[ . . . ]", -// "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", -// "version": 1, -// "timeRestore": true, -// "timeTo": "now", -// "timeFrom": "now-24h", -// "refreshInterval": { -// "display": "15 minutes", -// "pause": false, -// "section": 2, -// "value": 900000 -// }, -// "kibanaSavedObjectMeta": { -// "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" -// } -// }, -// "references": [ -// { -// "name": "panel_0", -// "type": "visualization", -// "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" -// }, -// . . . -// { -// "name": "panel_18", -// "type": "visualization", -// "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" -// } -// ], -// "migrationVersion": { -// "dashboard": "7.0.0" -// } -// } -// -------------------------------------------------- +experimental[] Execute a {kib} action by ID + +[[actions-and-connectors-api-execute-request]] +==== Request + +`POST :/api/actions/action//_execute` + +[[actions-and-connectors-api-execute-params]] +==== Path parameters + +`id`:: + (Required, string) The ID of the action to execute. + +[[actions-and-connectors-api-execute-request-body]] +==== Request body + +`params`:: + (Required, object) The action parameters. Parameter properties vary depending on + the action type. See the specific action type to determine required fields. + +[[actions-and-connectors-api-execute-codes]] +==== Response code + +`200`:: + Indicates a successful call. + +[[actions-and-connectors-api-execute-example]] +==== Example + +[source,sh] +-------------------------------------------------- +$ curl -X POST api/actions/action/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad/_execute -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d ' +{ + "params": { + "documents": [ + { + "id": "test_doc_id", + "name": "test_doc_name", + "message": "hello, world" + } + ] + } +}' +-------------------------------------------------- +// KIBANA + +The API returns the following: + +[source,sh] +-------------------------------------------------- +{ + "status": "ok", + "data": { + "took": 197, + "errors": false, + "items": [ + { + "index": { + "_index": "updated-index", + "_id": "iKyijHcBKCsmXNFrQe3T", + "_version": 1, + "result": "created", + "_shards": { + "total": 2, + "successful": 1, + "failed": 0 + }, + "_seq_no": 0, + "_primary_term": 1, + "status": 201 + } + } + ] + }, + "actionId": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad" +} +-------------------------------------------------- + +==== Action type execution parameters + +[options="header"] +|=== + +| Type | Id | Params + +| Email +| `.email` +| <> + +| Index +| `.index` +| <> + +| Jira +| `.jira` +| <> + +| PagerDuty +| `.pagerduty` +| <> + +| IBM Resilient +| `.resilient` +| <> + +| Server log +| `.server-log` +| <> + +| ServiceNow ITSM +| `.servicenow` +| <> + +| ServiceNow SecOps +| `.servicenow-sir` +| <> + +| Slack +| `.slack` +| <> + +| Microsoft Teams +| `.teams` +| <> + +| Webhook +| `.webhook` +| <> + +|=== \ No newline at end of file diff --git a/docs/api/actions-and-connectors/get.asciidoc b/docs/api/actions-and-connectors/get.asciidoc index e7fbf072d00d0..b054876457264 100644 --- a/docs/api/actions-and-connectors/get.asciidoc +++ b/docs/api/actions-and-connectors/get.asciidoc @@ -1,114 +1,50 @@ [[actions-and-connectors-api-get]] === Get action API ++++ -Get action +Get action API ++++ -Retrieve a single {kib} action by ID. +experimental[] Retrieve a single {kib} action by ID. [[actions-and-connectors-api-get-request]] ==== Request `GET :/api/actions/action/` -// `GET :/s//api/saved_objects//` - -// [[saved-objects-api-get-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. - - -// `type`:: -// (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. - -// `id`:: -// (Required, string) The ID of the object to retrieve. - -// [[saved-objects-api-get-codes]] -// ==== Response code - -// `200`:: -// Indicates a successful call. - -// [[saved-objects-api-get-example]] -// ==== Example - -// Retrieve the index pattern object with the `my-pattern` ID: - -// [source,sh] -// -------------------------------------------------- -// $ curl -X GET api/saved_objects/index-pattern/my-pattern -// -------------------------------------------------- -// // KIBANA - -// The API returns the following: - -// [source,sh] -// -------------------------------------------------- -// { -// "id": "my-pattern", -// "type": "index-pattern", -// "version": 1, -// "attributes": { -// "title": "my-pattern-*" -// } -// } -// -------------------------------------------------- - -// Retrieve a dashboard object in the `testspace` by ID: - -// [source,sh] -// -------------------------------------------------- -// $ curl -X GET s/testspace/api/saved_objects/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d -// -------------------------------------------------- -// // KIBANA - -// The API returns the following: - -// [source,sh] -// -------------------------------------------------- -// { -// "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", -// "type": "dashboard", -// "updated_at": "2019-07-23T00:11:07.059Z", -// "version": "WzQ0LDFd", -// "attributes": { -// "title": "[Flights] Global Flight Dashboard", -// "hits": 0, -// "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", -// "panelsJSON": "[ . . . ]", -// "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", -// "version": 1, -// "timeRestore": true, -// "timeTo": "now", -// "timeFrom": "now-24h", -// "refreshInterval": { -// "display": "15 minutes", -// "pause": false, -// "section": 2, -// "value": 900000 -// }, -// "kibanaSavedObjectMeta": { -// "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" -// } -// }, -// "references": [ -// { -// "name": "panel_0", -// "type": "visualization", -// "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" -// }, -// . . . -// { -// "name": "panel_18", -// "type": "visualization", -// "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" -// } -// ], -// "migrationVersion": { -// "dashboard": "7.0.0" -// } -// } -// -------------------------------------------------- +[[actions-and-connectors-api-get-params]] +==== Path parameters + +`id`:: + (Required, string) The ID of the action to retrieve. + +[[actions-and-connectors-api-get-codes]] +==== Response code + +`200`:: + Indicates a successful call. + +[[actions-and-connectors-api-get-example]] +==== Example + +[source,sh] +-------------------------------------------------- +$ curl -X GET api/actions/action/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad +-------------------------------------------------- +// KIBANA + +The API returns the following: + +[source,sh] +-------------------------------------------------- +{ + "id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad", + "actionTypeId": ".index", + "name": "my-action", + "config": { + "index": "test-index", + "refresh": false, + "executionTimeField": null + }, + "isPreconfigured": false +} +-------------------------------------------------- diff --git a/docs/api/actions-and-connectors/get_all.asciidoc b/docs/api/actions-and-connectors/get_all.asciidoc index e67b1cb33f4f6..10be62be13c0f 100644 --- a/docs/api/actions-and-connectors/get_all.asciidoc +++ b/docs/api/actions-and-connectors/get_all.asciidoc @@ -1,114 +1,52 @@ [[actions-and-connectors-api-get-all]] === Get all actions API ++++ -Get all actions +Get all actions API ++++ -// experimental[] Retrieve a single {kib} saved object by ID. - -// [[saved-objects-api-get-request]] -// ==== Request - -// `GET :/api/saved_objects//` - -// `GET :/s//api/saved_objects//` - -// [[saved-objects-api-get-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. - - -// `type`:: -// (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. - -// `id`:: -// (Required, string) The ID of the object to retrieve. - -// [[saved-objects-api-get-codes]] -// ==== Response code - -// `200`:: -// Indicates a successful call. - -// [[saved-objects-api-get-example]] -// ==== Example - -// Retrieve the index pattern object with the `my-pattern` ID: - -// [source,sh] -// -------------------------------------------------- -// $ curl -X GET api/saved_objects/index-pattern/my-pattern -// -------------------------------------------------- -// // KIBANA - -// The API returns the following: - -// [source,sh] -// -------------------------------------------------- -// { -// "id": "my-pattern", -// "type": "index-pattern", -// "version": 1, -// "attributes": { -// "title": "my-pattern-*" -// } -// } -// -------------------------------------------------- - -// Retrieve a dashboard object in the `testspace` by ID: - -// [source,sh] -// -------------------------------------------------- -// $ curl -X GET s/testspace/api/saved_objects/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d -// -------------------------------------------------- -// // KIBANA - -// The API returns the following: - -// [source,sh] -// -------------------------------------------------- -// { -// "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", -// "type": "dashboard", -// "updated_at": "2019-07-23T00:11:07.059Z", -// "version": "WzQ0LDFd", -// "attributes": { -// "title": "[Flights] Global Flight Dashboard", -// "hits": 0, -// "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", -// "panelsJSON": "[ . . . ]", -// "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", -// "version": 1, -// "timeRestore": true, -// "timeTo": "now", -// "timeFrom": "now-24h", -// "refreshInterval": { -// "display": "15 minutes", -// "pause": false, -// "section": 2, -// "value": 900000 -// }, -// "kibanaSavedObjectMeta": { -// "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" -// } -// }, -// "references": [ -// { -// "name": "panel_0", -// "type": "visualization", -// "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" -// }, -// . . . -// { -// "name": "panel_18", -// "type": "visualization", -// "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" -// } -// ], -// "migrationVersion": { -// "dashboard": "7.0.0" -// } -// } -// -------------------------------------------------- +experimental[] Retrieve all {kib} actions + +[[actions-and-connectors-api-get-all-request]] +==== Request + +`GET :/api/actions` + +[[actions-and-connectors-api-get-all-codes]] +==== Response code + +`200`:: + Indicates a successful call. + +[[actions-and-connectors-api-get-all-example]] +==== Example + +[source,sh] +-------------------------------------------------- +$ curl -X GET api/actions +-------------------------------------------------- +// KIBANA + +The API returns the following: + +[source,sh] +-------------------------------------------------- +[ + { + "id": "preconfigured-mail-action", + "actionTypeId": ".email", + "name": "email: preconfigured-mail-action", + "isPreconfigured": true + }, + { + "id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad", + "actionTypeId": ".index", + "name": "my-action", + "config": { + "index": "test-index", + "refresh": false, + "executionTimeField": null + }, + "isPreconfigured": false + } +] +-------------------------------------------------- diff --git a/docs/api/actions-and-connectors/list.asciidoc b/docs/api/actions-and-connectors/list.asciidoc index 7133aa381c181..687512e50da5f 100644 --- a/docs/api/actions-and-connectors/list.asciidoc +++ b/docs/api/actions-and-connectors/list.asciidoc @@ -1,7 +1,7 @@ [[actions-and-connectors-api-list]] === List action types API ++++ -List action types +List all action types API ++++ experimental[] Retrieve a list of all {kib} action types. @@ -26,57 +26,51 @@ $ curl -X GET api/actions/list_action_types -------------------------------------------------- // KIBANA -==== Action types +The API returns the following: -{kib} ships with a set of built-in action types: - -[options="header"] -|=== - -| Type | Id | Config - -| Email -| `.email` -| <> - -| IBM Resilient -| `.resilient` -| <> - -| Index -| `.index` -| <> +[source,sh] +-------------------------------------------------- +[ + { + "id": ".email", + "name": "Email", + "minimumLicenseRequired": "gold", + "enabled": false, + "enabledInConfig": true, + "enabledInLicense": false + }, + { + "id": ".index", + "name": "Index", + "minimumLicenseRequired": "basic", + "enabled": true, + "enabledInConfig": true, + "enabledInLicense": true + } +] +-------------------------------------------------- -| Jira -| `.jira` -| <> +Each action type object contains the following properties: -| Microsoft Teams -| `.teams` -| <> +[cols="2*<"] +|=== -| PagerDuty -| `.pagerduty` -| <> +| `name` +| The descriptive name of the action type. -| Server log -| `.server-log` -| <> +| `id` +| The unique ID of the action type. -| ServiceNow ITSM -| `.servicenow` -| <> +| `minimumLicenseRequired` +| The license required to use the action type. -| ServiceNow SIR -| `.servicenow-sir` -| <> +| `enabled` +| Whether the action type is enabled or disabled in {kib}. -| Slack -| `.slack` -| <> +| `enabledInConfig` +| Whether the action type is enabled or disabled in the {kib} configuration `yml`. -| Webhook -| `.webhook` -| <> +| `enabledInLicense` +| Whether the action type is enabled or disabled due to license. -|=== \ No newline at end of file +|=== diff --git a/docs/api/actions-and-connectors/update.asciidoc b/docs/api/actions-and-connectors/update.asciidoc index 0002a6507ccbc..cc3d4064ea7c5 100644 --- a/docs/api/actions-and-connectors/update.asciidoc +++ b/docs/api/actions-and-connectors/update.asciidoc @@ -1,114 +1,68 @@ [[actions-and-connectors-api-update]] === Update action API ++++ -Update action +Update action API ++++ -// experimental[] Retrieve a single {kib} saved object by ID. +experimental[] Update the attributes for an existing {kib} action -// [[saved-objects-api-get-request]] -// ==== Request +[[actions-and-connectors-api-update-request]] +==== Request -// `GET :/api/saved_objects//` +`PUT :/api/actions/action/` -// `GET :/s//api/saved_objects//` +[[actions-and-connectors-api-update-params]] +==== Path parameters -// [[saved-objects-api-get-params]] -// ==== Path parameters +`id`:: + (Required, string) The ID of the action 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. +[[actions-and-connectors-api-update-request-body]] +==== Request body +`name`:: + (Required, string) The updated display name for the action. -// `type`:: -// (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`. +`config`:: + (Required, object) The updated action configuration. Configuration properties vary depending on the action type. Some action types will have no configuration properties. See the specific action type to determine required fields. -// `id`:: -// (Required, string) The ID of the object to retrieve. +`secrets`:: + (Required, object) The updated secrets configuration for the action. Secrets properties vary depending on the action type. Some action types will have no secrets properties. See the specific ation type to determine required fields. -// [[saved-objects-api-get-codes]] -// ==== Response code +[[actions-and-connectors-api-update-codes]] +==== Response code -// `200`:: -// Indicates a successful call. +`200`:: + Indicates a successful call. -// [[saved-objects-api-get-example]] -// ==== Example +[[actions-and-connectors-api-update-example]] +==== Example -// Retrieve the index pattern object with the `my-pattern` ID: +[source,sh] +-------------------------------------------------- +$ curl -X PUT api/actions/action/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d ' +{ + "name": "updated-action", + "config": { + "index": "updated-index" + } +}' +-------------------------------------------------- +// KIBANA -// [source,sh] -// -------------------------------------------------- -// $ curl -X GET api/saved_objects/index-pattern/my-pattern -// -------------------------------------------------- -// // KIBANA +The API returns the following: -// The API returns the following: - -// [source,sh] -// -------------------------------------------------- -// { -// "id": "my-pattern", -// "type": "index-pattern", -// "version": 1, -// "attributes": { -// "title": "my-pattern-*" -// } -// } -// -------------------------------------------------- - -// Retrieve a dashboard object in the `testspace` by ID: - -// [source,sh] -// -------------------------------------------------- -// $ curl -X GET s/testspace/api/saved_objects/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d -// -------------------------------------------------- -// // KIBANA - -// The API returns the following: - -// [source,sh] -// -------------------------------------------------- -// { -// "id": "7adfa750-4c81-11e8-b3d7-01146121b73d", -// "type": "dashboard", -// "updated_at": "2019-07-23T00:11:07.059Z", -// "version": "WzQ0LDFd", -// "attributes": { -// "title": "[Flights] Global Flight Dashboard", -// "hits": 0, -// "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats", -// "panelsJSON": "[ . . . ]", -// "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}", -// "version": 1, -// "timeRestore": true, -// "timeTo": "now", -// "timeFrom": "now-24h", -// "refreshInterval": { -// "display": "15 minutes", -// "pause": false, -// "section": 2, -// "value": 900000 -// }, -// "kibanaSavedObjectMeta": { -// "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}" -// } -// }, -// "references": [ -// { -// "name": "panel_0", -// "type": "visualization", -// "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d" -// }, -// . . . -// { -// "name": "panel_18", -// "type": "visualization", -// "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b" -// } -// ], -// "migrationVersion": { -// "dashboard": "7.0.0" -// } -// } -// -------------------------------------------------- +[source,sh] +-------------------------------------------------- +{ + "id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad", + "actionTypeId": ".index", + "name": "updated-action", + "config": { + "index": "updated-index", + "refresh": false, + "executionTimeField": null + }, + "isPreconfigured": false +} +-------------------------------------------------- From fb5b6af30d459676515576125d8317733aa24529 Mon Sep 17 00:00:00 2001 From: Ying Mao Date: Wed, 10 Feb 2021 11:15:02 -0500 Subject: [PATCH 4/8] Cleanup --- docs/api/actions-and-connectors/create.asciidoc | 4 ---- docs/api/actions-and-connectors/execute.asciidoc | 4 ---- 2 files changed, 8 deletions(-) diff --git a/docs/api/actions-and-connectors/create.asciidoc b/docs/api/actions-and-connectors/create.asciidoc index 766f2646a360d..a5819688ff26f 100644 --- a/docs/api/actions-and-connectors/create.asciidoc +++ b/docs/api/actions-and-connectors/create.asciidoc @@ -102,10 +102,6 @@ The API returns the following: | `.servicenow` | <> -| ServiceNow SecOps -| `.servicenow-sir` -| <> - | Slack | `.slack` | <> diff --git a/docs/api/actions-and-connectors/execute.asciidoc b/docs/api/actions-and-connectors/execute.asciidoc index 2911242e17110..3fc9ec5f9b78b 100644 --- a/docs/api/actions-and-connectors/execute.asciidoc +++ b/docs/api/actions-and-connectors/execute.asciidoc @@ -117,10 +117,6 @@ The API returns the following: | `.servicenow` | <> -| ServiceNow SecOps -| `.servicenow-sir` -| <> - | Slack | `.slack` | <> From b23197b8c1bffa0040856baabd3354e0b821e40d Mon Sep 17 00:00:00 2001 From: Ying Mao Date: Tue, 16 Feb 2021 13:39:10 -0500 Subject: [PATCH 5/8] Removing experimental label --- docs/api/actions-and-connectors/create.asciidoc | 2 +- docs/api/actions-and-connectors/delete.asciidoc | 2 +- docs/api/actions-and-connectors/execute.asciidoc | 2 +- docs/api/actions-and-connectors/get.asciidoc | 2 +- docs/api/actions-and-connectors/get_all.asciidoc | 2 +- docs/api/actions-and-connectors/list.asciidoc | 2 +- docs/api/actions-and-connectors/update.asciidoc | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/api/actions-and-connectors/create.asciidoc b/docs/api/actions-and-connectors/create.asciidoc index a5819688ff26f..9eb3650b86d1e 100644 --- a/docs/api/actions-and-connectors/create.asciidoc +++ b/docs/api/actions-and-connectors/create.asciidoc @@ -4,7 +4,7 @@ Create action API ++++ -experimental[] Create {kib} actions. +Create {kib} actions. [[actions-and-connectors-api-create-request]] ==== Request diff --git a/docs/api/actions-and-connectors/delete.asciidoc b/docs/api/actions-and-connectors/delete.asciidoc index d9b24e7a260e4..b2b5e1c19263a 100644 --- a/docs/api/actions-and-connectors/delete.asciidoc +++ b/docs/api/actions-and-connectors/delete.asciidoc @@ -4,7 +4,7 @@ Delete action API ++++ -experimental[] Remove a {kib} action by ID +Remove a {kib} action by ID WARNING: Once you delete an action, _it cannot be recovered_. diff --git a/docs/api/actions-and-connectors/execute.asciidoc b/docs/api/actions-and-connectors/execute.asciidoc index 3fc9ec5f9b78b..d5c8e824445a8 100644 --- a/docs/api/actions-and-connectors/execute.asciidoc +++ b/docs/api/actions-and-connectors/execute.asciidoc @@ -4,7 +4,7 @@ Execute action API ++++ -experimental[] Execute a {kib} action by ID +Execute a {kib} action by ID [[actions-and-connectors-api-execute-request]] ==== Request diff --git a/docs/api/actions-and-connectors/get.asciidoc b/docs/api/actions-and-connectors/get.asciidoc index b054876457264..b287d26cd47b2 100644 --- a/docs/api/actions-and-connectors/get.asciidoc +++ b/docs/api/actions-and-connectors/get.asciidoc @@ -4,7 +4,7 @@ Get action API ++++ -experimental[] Retrieve a single {kib} action by ID. +Retrieve a single {kib} action by ID. [[actions-and-connectors-api-get-request]] ==== Request diff --git a/docs/api/actions-and-connectors/get_all.asciidoc b/docs/api/actions-and-connectors/get_all.asciidoc index 10be62be13c0f..211decab3eaaa 100644 --- a/docs/api/actions-and-connectors/get_all.asciidoc +++ b/docs/api/actions-and-connectors/get_all.asciidoc @@ -4,7 +4,7 @@ Get all actions API ++++ -experimental[] Retrieve all {kib} actions +Retrieve all {kib} actions [[actions-and-connectors-api-get-all-request]] ==== Request diff --git a/docs/api/actions-and-connectors/list.asciidoc b/docs/api/actions-and-connectors/list.asciidoc index 687512e50da5f..9994e5e1f067a 100644 --- a/docs/api/actions-and-connectors/list.asciidoc +++ b/docs/api/actions-and-connectors/list.asciidoc @@ -4,7 +4,7 @@ List all action types API ++++ -experimental[] Retrieve a list of all {kib} action types. +Retrieve a list of all {kib} action types. [[actions-and-connectors-api-list-request]] ==== Request diff --git a/docs/api/actions-and-connectors/update.asciidoc b/docs/api/actions-and-connectors/update.asciidoc index cc3d4064ea7c5..daa21b88ffe6f 100644 --- a/docs/api/actions-and-connectors/update.asciidoc +++ b/docs/api/actions-and-connectors/update.asciidoc @@ -4,7 +4,7 @@ Update action API ++++ -experimental[] Update the attributes for an existing {kib} action +Update the attributes for an existing {kib} action [[actions-and-connectors-api-update-request]] ==== Request From 78b964a09a68ef3e314c33bcc05f1f40d4e560e8 Mon Sep 17 00:00:00 2001 From: Ying Mao Date: Wed, 17 Feb 2021 12:59:38 -0500 Subject: [PATCH 6/8] PR fixes --- docs/api/actions-and-connectors.asciidoc | 75 +++---------------- .../actions-and-connectors/create.asciidoc | 61 ++------------- .../actions-and-connectors/delete.asciidoc | 6 +- .../actions-and-connectors/execute.asciidoc | 59 ++------------- docs/api/actions-and-connectors/get.asciidoc | 4 +- .../actions-and-connectors/get_all.asciidoc | 2 +- docs/api/actions-and-connectors/list.asciidoc | 2 +- .../actions-and-connectors/update.asciidoc | 10 +-- 8 files changed, 34 insertions(+), 185 deletions(-) diff --git a/docs/api/actions-and-connectors.asciidoc b/docs/api/actions-and-connectors.asciidoc index 586aecc5cdf7c..0a49688193dc0 100644 --- a/docs/api/actions-and-connectors.asciidoc +++ b/docs/api/actions-and-connectors.asciidoc @@ -1,78 +1,25 @@ [[actions-and-connectors-api]] -== Actions and Connectors APIs +== Action and Connector APIs -Manage your {kib} actions and connectors. +Manage Actions and Connectors. -The following {kib} actions APIs are available: +The following action APIs are available: -* <> to retrieve a single {kib} action by ID +* <> to retrieve a single action by ID -* <> to retrieve all {kib} actions +* <> to retrieve all actions -* <> to retrieve a list of all {kib} action types +* <> to retrieve a list of all action types -* <> to create {kib} actions +* <> to create actions -* <> to update the attributes for an existing {kib} action +* <> to update the attributes for an existing action -* <> to execute a {kib} action by ID +* <> to execute an action by ID -* <> to remove a {kib} action by ID +* <> to delete an action by ID -=== Action types - -{kib} ships with a set of built-in action types: - -[options="header"] -|=== - -| Type | Id | Description - -| Server log -| `.server-log` -| Logs messages to the {kib} log using {kib}'s logger - -| Email -| `.email` -| Sends an email using SMTP - -| Slack -| `.slack` -| Posts a message to a Slack channel - -| Microsoft Teams -| `.teams` -| Posts a message to a Microsoft Teams channel - -| Index -| `.index` -| Indexes document(s) into Elasticsearch - -| Webhook -| `.webhook` -| Sends a payload to a web service using `HTTP POST` or `PUT` - -| PagerDuty -| `.pagerduty` -| Triggers, resolves or acknowledges an incident to a PagerDuty service - -| ServiceNow ITSM -| `.servicenow` -| Creates or updates an incident to a ServiceNow ITSM instance - -| ServiceNow SIR -| `.servicenow-sir` -| Creates or updates an incident to a ServiceNow SIR instance - -| Jira -| `.jira` -| Creates or updates an issue to a Jira instance - -| IBM Resilient -| `.resilient` -| Creates or updates an incident to an IBM Resilient instance - -|=== +For information about the actions and connectors that {kib} supports, refer to <>. include::actions-and-connectors/get.asciidoc[] include::actions-and-connectors/get_all.asciidoc[] diff --git a/docs/api/actions-and-connectors/create.asciidoc b/docs/api/actions-and-connectors/create.asciidoc index 9eb3650b86d1e..504e027a74d6f 100644 --- a/docs/api/actions-and-connectors/create.asciidoc +++ b/docs/api/actions-and-connectors/create.asciidoc @@ -4,7 +4,7 @@ Create action API ++++ -Create {kib} actions. +Creates an actions. [[actions-and-connectors-api-create-request]] ==== Request @@ -21,12 +21,12 @@ Create {kib} actions. (Required, string) The action type ID for the action. `config`:: - (Required, object) The action configuration. Configuration properties vary depending on - the action type. Some action types will have no configuration properties. See the specific action type to determine required fields. + (Required, object) The configuration for the action. Configuration properties vary depending on + the action type. For information about the configuration properties, refer to <>. `secrets`:: - (Required, object) The secrets configuration for the action. Secrets properties vary - depending on the action type. Some action types will have no secrets properties. See the specific ation type to determine required fields. + (Required, object) The secrets configuration for the action. Secrets configuration properties vary + depending on the action type. For information about the secrets configuration properties, refer to <>. [[actions-and-connectors-api-create-request-codes]] ==== Response code @@ -65,53 +65,4 @@ The API returns the following: }, "isPreconfigured": false } --------------------------------------------------- - -==== Action type configuration and secrets - -[options="header"] -|=== - -| Type | Id | Config - -| Email -| `.email` -| <> - -| Index -| `.index` -| <> - -| Jira -| `.jira` -| <> - -| PagerDuty -| `.pagerduty` -| <> - -| IBM Resilient -| `.resilient` -| <> - -| Server log -| `.server-log` -| <> - -| ServiceNow ITSM -| `.servicenow` -| <> - -| Slack -| `.slack` -| <> - -| Microsoft Teams -| `.teams` -| <> - -| Webhook -| `.webhook` -| <> - -|=== \ No newline at end of file +-------------------------------------------------- \ No newline at end of file diff --git a/docs/api/actions-and-connectors/delete.asciidoc b/docs/api/actions-and-connectors/delete.asciidoc index b2b5e1c19263a..e90b9ae44c5bd 100644 --- a/docs/api/actions-and-connectors/delete.asciidoc +++ b/docs/api/actions-and-connectors/delete.asciidoc @@ -4,9 +4,9 @@ Delete action API ++++ -Remove a {kib} action by ID +Deletes an action by ID. -WARNING: Once you delete an action, _it cannot be recovered_. +WARNING: When you delete an action, _it cannot be recovered_. [[actions-and-connectors-api-delete-request]] ==== Request @@ -17,7 +17,7 @@ WARNING: Once you delete an action, _it cannot be recovered_. ==== Path parameters `id`:: - (Required, string) The ID of the action to remove. + (Required, string) The ID of the action. [[actions-and-connectors-api-delete-response-codes]] ==== Response code diff --git a/docs/api/actions-and-connectors/execute.asciidoc b/docs/api/actions-and-connectors/execute.asciidoc index d5c8e824445a8..12f1405eb4456 100644 --- a/docs/api/actions-and-connectors/execute.asciidoc +++ b/docs/api/actions-and-connectors/execute.asciidoc @@ -4,7 +4,7 @@ Execute action API ++++ -Execute a {kib} action by ID +Executes an action by ID. [[actions-and-connectors-api-execute-request]] ==== Request @@ -15,14 +15,14 @@ Execute a {kib} action by ID ==== Path parameters `id`:: - (Required, string) The ID of the action to execute. + (Required, string) The ID of the action. [[actions-and-connectors-api-execute-request-body]] ==== Request body `params`:: - (Required, object) The action parameters. Parameter properties vary depending on - the action type. See the specific action type to determine required fields. + (Required, object) The parameters of the action. Parameter properties vary depending on + the action type. For information about the parameter properties, refer to <>. [[actions-and-connectors-api-execute-codes]] ==== Response code @@ -80,53 +80,4 @@ The API returns the following: }, "actionId": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad" } --------------------------------------------------- - -==== Action type execution parameters - -[options="header"] -|=== - -| Type | Id | Params - -| Email -| `.email` -| <> - -| Index -| `.index` -| <> - -| Jira -| `.jira` -| <> - -| PagerDuty -| `.pagerduty` -| <> - -| IBM Resilient -| `.resilient` -| <> - -| Server log -| `.server-log` -| <> - -| ServiceNow ITSM -| `.servicenow` -| <> - -| Slack -| `.slack` -| <> - -| Microsoft Teams -| `.teams` -| <> - -| Webhook -| `.webhook` -| <> - -|=== \ No newline at end of file +-------------------------------------------------- \ No newline at end of file diff --git a/docs/api/actions-and-connectors/get.asciidoc b/docs/api/actions-and-connectors/get.asciidoc index b287d26cd47b2..6be554e65db04 100644 --- a/docs/api/actions-and-connectors/get.asciidoc +++ b/docs/api/actions-and-connectors/get.asciidoc @@ -4,7 +4,7 @@ Get action API ++++ -Retrieve a single {kib} action by ID. +Retrieves an action by ID. [[actions-and-connectors-api-get-request]] ==== Request @@ -15,7 +15,7 @@ Retrieve a single {kib} action by ID. ==== Path parameters `id`:: - (Required, string) The ID of the action to retrieve. + (Required, string) The ID of the action. [[actions-and-connectors-api-get-codes]] ==== Response code diff --git a/docs/api/actions-and-connectors/get_all.asciidoc b/docs/api/actions-and-connectors/get_all.asciidoc index 211decab3eaaa..9863963c8395e 100644 --- a/docs/api/actions-and-connectors/get_all.asciidoc +++ b/docs/api/actions-and-connectors/get_all.asciidoc @@ -4,7 +4,7 @@ Get all actions API ++++ -Retrieve all {kib} actions +Retrieves all actions. [[actions-and-connectors-api-get-all-request]] ==== Request diff --git a/docs/api/actions-and-connectors/list.asciidoc b/docs/api/actions-and-connectors/list.asciidoc index 9994e5e1f067a..2558551055745 100644 --- a/docs/api/actions-and-connectors/list.asciidoc +++ b/docs/api/actions-and-connectors/list.asciidoc @@ -4,7 +4,7 @@ List all action types API ++++ -Retrieve a list of all {kib} action types. +Retrieves a list of all action types. [[actions-and-connectors-api-list-request]] ==== Request diff --git a/docs/api/actions-and-connectors/update.asciidoc b/docs/api/actions-and-connectors/update.asciidoc index daa21b88ffe6f..e08ec2f8da1b6 100644 --- a/docs/api/actions-and-connectors/update.asciidoc +++ b/docs/api/actions-and-connectors/update.asciidoc @@ -4,7 +4,7 @@ Update action API ++++ -Update the attributes for an existing {kib} action +Updates the attributes for an existing action. [[actions-and-connectors-api-update-request]] ==== Request @@ -15,19 +15,19 @@ Update the attributes for an existing {kib} action ==== Path parameters `id`:: - (Required, string) The ID of the action to update. + (Required, string) The ID of the action. [[actions-and-connectors-api-update-request-body]] ==== Request body `name`:: - (Required, string) The updated display name for the action. + (Required, string) The new name of the action. `config`:: - (Required, object) The updated action configuration. Configuration properties vary depending on the action type. Some action types will have no configuration properties. See the specific action type to determine required fields. + (Required, object) The new action configuration. Configuration properties vary depending on the action type. For information about the configuration properties, refer to <>. `secrets`:: - (Required, object) The updated secrets configuration for the action. Secrets properties vary depending on the action type. Some action types will have no secrets properties. See the specific ation type to determine required fields. + (Required, object) The updated secrets configuration for the action. Secrets properties vary depending on the action type. For information about the secrets configuration properties, refer to <>. [[actions-and-connectors-api-update-codes]] ==== Response code From 93d630247ab5680466c347479ea54734eecffb4c Mon Sep 17 00:00:00 2001 From: Ying Mao Date: Wed, 17 Feb 2021 13:06:36 -0500 Subject: [PATCH 7/8] PR fixes --- docs/api/actions-and-connectors.asciidoc | 2 +- docs/api/actions-and-connectors/create.asciidoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/actions-and-connectors.asciidoc b/docs/api/actions-and-connectors.asciidoc index 0a49688193dc0..17e7ea1b7672a 100644 --- a/docs/api/actions-and-connectors.asciidoc +++ b/docs/api/actions-and-connectors.asciidoc @@ -1,5 +1,5 @@ [[actions-and-connectors-api]] -== Action and Connector APIs +== Action and connector APIs Manage Actions and Connectors. diff --git a/docs/api/actions-and-connectors/create.asciidoc b/docs/api/actions-and-connectors/create.asciidoc index 504e027a74d6f..af5ddd050e40e 100644 --- a/docs/api/actions-and-connectors/create.asciidoc +++ b/docs/api/actions-and-connectors/create.asciidoc @@ -4,7 +4,7 @@ Create action API ++++ -Creates an actions. +Creates an action. [[actions-and-connectors-api-create-request]] ==== Request From 744c04d29555697c7078249b03fac1c6546398f7 Mon Sep 17 00:00:00 2001 From: Ying Mao Date: Wed, 17 Feb 2021 13:34:06 -0500 Subject: [PATCH 8/8] PR fixes --- docs/api/actions-and-connectors/list.asciidoc | 41 ++++++------------- 1 file changed, 12 insertions(+), 29 deletions(-) diff --git a/docs/api/actions-and-connectors/list.asciidoc b/docs/api/actions-and-connectors/list.asciidoc index 2558551055745..b800b7ff3b4f2 100644 --- a/docs/api/actions-and-connectors/list.asciidoc +++ b/docs/api/actions-and-connectors/list.asciidoc @@ -32,12 +32,12 @@ The API returns the following: -------------------------------------------------- [ { - "id": ".email", - "name": "Email", - "minimumLicenseRequired": "gold", - "enabled": false, - "enabledInConfig": true, - "enabledInLicense": false + "id": ".email", <1> + "name": "Email", <2> + "minimumLicenseRequired": "gold", <3> + "enabled": false, <4> + "enabledInConfig": true, <5> + "enabledInLicense": false <6> }, { "id": ".index", @@ -50,27 +50,10 @@ The API returns the following: ] -------------------------------------------------- -Each action type object contains the following properties: - -[cols="2*<"] -|=== - -| `name` -| The descriptive name of the action type. - -| `id` -| The unique ID of the action type. - -| `minimumLicenseRequired` -| The license required to use the action type. - -| `enabled` -| Whether the action type is enabled or disabled in {kib}. - -| `enabledInConfig` -| Whether the action type is enabled or disabled in the {kib} configuration `yml`. - -| `enabledInLicense` -| Whether the action type is enabled or disabled due to license. -|=== +<1> `id` - The unique ID of the action type. +<2> `name` - The name of the action type. +<3> `minimumLicenseRequired` - The license required to use the action type. +<4> `enabled` - Specifies if the action type is enabled or disabled in {kib}. +<5> `enabledInConfig` - Specifies if the action type is enabled or enabled in the {kib} .yml file. +<6> `enabledInLicense` - Specifies if the action type is enabled or disabled in the license.