github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Improve terminology in execute connector API (#133694) (#134056)

Browse source 
(cherry picked from commit 580a964eda)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
Kibana Machine 2022-06-09 11:02:42 -04:00 • committed by GitHub
parent b13e4fa9c4
commit 986e4e2a07
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/api/actions-and-connectors.asciidoc
View file

@ -28,8 +28,8 @@ include::actions-and-connectors/delete.asciidoc[leveloffset=+1]
include::actions-and-connectors/get.asciidoc[leveloffset=+1]
include::actions-and-connectors/get_all.asciidoc[leveloffset=+1]
include::actions-and-connectors/list.asciidoc[]
include::actions-and-connectors/execute.asciidoc[leveloffset=+1]
include::actions-and-connectors/update.asciidoc[leveloffset=+1]
include::actions-and-connectors/execute.asciidoc[]
include::actions-and-connectors/legacy/index.asciidoc[]
include::actions-and-connectors/legacy/get.asciidoc[]
include::actions-and-connectors/legacy/get_all.asciidoc[]

25
docs/api/actions-and-connectors/execute.asciidoc
View file

@ -1,19 +1,26 @@
[[execute-connector-api]]
=== Execute connector API
== Run connector API
++++
<titleabbrev>Execute connector</titleabbrev>
<titleabbrev>Run connector</titleabbrev>
++++
Executes a connector by ID.
Runs a connector by ID.
[[execute-connector-api-request]]
==== {api-request-title}
=== {api-request-title}
`POST <kibana host>:<port>/api/actions/connector/<id>/_execute`
`POST <kibana host>:<port>/s/<space_id>/api/actions/connector/<id>/_execute`
[discrete]
[[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]]
=== {api-prereq-title}
You must have `read` privileges for the *Actions and Connectors* feature in the
@ -24,7 +31,7 @@ If you use an index connector, you must also have `all`, `create`, `index`, or
`write` {ref}/security-privileges.html[indices privileges].
[[execute-connector-api-params]]
==== {api-path-parms-title}
=== {api-path-parms-title}
`id`::
(Required, string) The ID of the connector.
@ -33,20 +40,20 @@ If you use an index connector, you must also have `all`, `create`, `index`, or
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[execute-connector-api-request-body]]
==== {api-request-body-title}
=== {api-request-body-title}
`params`::
(Required, object) The parameters of the connector. Parameter properties vary depending on
the connector type. For information about the parameter properties, refer to <<action-types,Action and connector types>>.
[[execute-connector-api-codes]]
==== {api-response-codes-title}
=== {api-response-codes-title}
`200`::
Indicates a successful call.
[[execute-connector-api-example]]
==== {api-examples-title}
=== {api-examples-title}
Run an index connector: