mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 03:01:21 -04:00
[DOCS] Add index connector actions to run connector API (#134538)
This commit is contained in:
parent
4db96c5f26
commit
61b2fdecf9
1 changed files with 17 additions and 7 deletions
|
@ -13,13 +13,6 @@ Runs a connector by ID.
|
||||||
|
|
||||||
`POST <kibana host>:<port>/s/<space_id>/api/actions/connector/<id>/_execute`
|
`POST <kibana host>:<port>/s/<space_id>/api/actions/connector/<id>/_execute`
|
||||||
|
|
||||||
[[execute-connector-api-desc]]
|
|
||||||
=== {api-description-title}
|
|
||||||
|
|
||||||
You can use this API to test an <<alerting-concepts-actions,action>> that
|
|
||||||
involves interaction with Kibana services or integrations with third-party
|
|
||||||
systems.
|
|
||||||
|
|
||||||
[[execute-connector-api-prereq]]
|
[[execute-connector-api-prereq]]
|
||||||
=== {api-prereq-title}
|
=== {api-prereq-title}
|
||||||
|
|
||||||
|
@ -30,6 +23,13 @@ You must have `read` privileges for the *Actions and Connectors* feature in the
|
||||||
If you use an index connector, you must also have `all`, `create`, `index`, or
|
If you use an index connector, you must also have `all`, `create`, `index`, or
|
||||||
`write` {ref}/security-privileges.html[indices privileges].
|
`write` {ref}/security-privileges.html[indices privileges].
|
||||||
|
|
||||||
|
[[execute-connector-api-desc]]
|
||||||
|
=== {api-description-title}
|
||||||
|
|
||||||
|
You can use this API to test an <<alerting-concepts-actions,action>> that
|
||||||
|
involves interaction with Kibana services or integrations with third-party
|
||||||
|
systems.
|
||||||
|
|
||||||
[[execute-connector-api-params]]
|
[[execute-connector-api-params]]
|
||||||
=== {api-path-parms-title}
|
=== {api-path-parms-title}
|
||||||
|
|
||||||
|
@ -50,6 +50,16 @@ depending on the connector type. For information about the parameter properties,
|
||||||
refer to <<action-types>>.
|
refer to <<action-types>>.
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
|
.Index connectors
|
||||||
|
[%collapsible%open]
|
||||||
|
====
|
||||||
|
`documents`::
|
||||||
|
(Required, array of objects) The documents to index in JSON format.
|
||||||
|
|
||||||
|
For more information, refer to
|
||||||
|
{kibana-ref}/index-action-type.html[Index connector and action].
|
||||||
|
====
|
||||||
|
|
||||||
.Jira connectors
|
.Jira connectors
|
||||||
[%collapsible%open]
|
[%collapsible%open]
|
||||||
====
|
====
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue