* Initial commit * Remove 'API' from title abbreviations * Merge deprecated warning w/ alternative solution Co-authored-by: Mike Côté <mikecote@users.noreply.github.com>
This commit is contained in:
parent
0ae48b1de2
commit
003697b49b
|
@ -5,19 +5,19 @@ Manage Actions and Connectors.
|
|||
|
||||
The following connector APIs are available:
|
||||
|
||||
* <<actions-and-connectors-api-get, Get connector API>> to retrieve a single connector by ID
|
||||
* <<get-connector-api, Get connector API>> to retrieve a single connector by ID
|
||||
|
||||
* <<actions-and-connectors-api-get-all, Get all connectors API>> to retrieve all connectors
|
||||
* <<get-all-connectors-api, Get all connectors API>> to retrieve all connectors
|
||||
|
||||
* <<actions-and-connectors-api-list, List all connector types API>> to retrieve a list of all connector types
|
||||
* <<list-connector-types-api, List all connector types API>> to retrieve a list of all connector types
|
||||
|
||||
* <<actions-and-connectors-api-create, Create connector API>> to create connectors
|
||||
* <<create-connector-api, Create connector API>> to create connectors
|
||||
|
||||
* <<actions-and-connectors-api-update, Update connector API>> to update the attributes for an existing connector
|
||||
* <<update-connector-api, Update connector API>> to update the attributes for an existing connector
|
||||
|
||||
* <<actions-and-connectors-api-execute, Execute connector API>> to execute a connector by ID
|
||||
* <<execute-connector-api, Execute connector API>> to execute a connector by ID
|
||||
|
||||
* <<actions-and-connectors-api-delete, Delete connector API>> to delete a connector by ID
|
||||
* <<delete-connector-api, Delete connector API>> to delete a connector by ID
|
||||
|
||||
For deprecated APIs, refer to <<actions-and-connectors-legacy-apis>>.
|
||||
|
||||
|
|
|
@ -1,25 +1,25 @@
|
|||
[[actions-and-connectors-api-create]]
|
||||
[[create-connector-api]]
|
||||
=== Create connector API
|
||||
++++
|
||||
<titleabbrev>Create connector API</titleabbrev>
|
||||
<titleabbrev>Create connector</titleabbrev>
|
||||
++++
|
||||
|
||||
Creates a connector.
|
||||
|
||||
[[actions-and-connectors-api-create-request]]
|
||||
[[create-connector-api-request]]
|
||||
==== Request
|
||||
|
||||
`POST <kibana host>:<port>/api/actions/connector`
|
||||
|
||||
`POST <kibana host>:<port>/s/<space_id>/api/actions/connector`
|
||||
|
||||
[[actions-and-connectors-api-create-path-params]]
|
||||
[[create-connector-api-path-params]]
|
||||
==== Path parameters
|
||||
|
||||
`space_id`::
|
||||
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
|
||||
|
||||
[[actions-and-connectors-api-create-request-body]]
|
||||
[[create-connector-api-request-body]]
|
||||
==== Request body
|
||||
|
||||
`name`::
|
||||
|
@ -36,15 +36,15 @@ Creates a connector.
|
|||
(Required, object) The secrets configuration for the connector. Secrets configuration properties vary
|
||||
depending on the connector type. For information about the secrets configuration properties, refer to <<action-types,Action and connector types>>.
|
||||
+
|
||||
WARNING: Remember these values. You must provide them each time you call the <<actions-and-connectors-api-update, update>> API.
|
||||
WARNING: Remember these values. You must provide them each time you call the <<update-connector-api, update>> API.
|
||||
|
||||
[[actions-and-connectors-api-create-request-codes]]
|
||||
[[create-connector-api-request-codes]]
|
||||
==== Response code
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[actions-and-connectors-api-create-example]]
|
||||
[[create-connector-api-example]]
|
||||
==== Example
|
||||
|
||||
[source,sh]
|
||||
|
|
|
@ -1,21 +1,21 @@
|
|||
[[actions-and-connectors-api-delete]]
|
||||
[[delete-connector-api]]
|
||||
=== Delete connector API
|
||||
++++
|
||||
<titleabbrev>Delete connector API</titleabbrev>
|
||||
<titleabbrev>Delete connector</titleabbrev>
|
||||
++++
|
||||
|
||||
Deletes an connector by ID.
|
||||
|
||||
WARNING: When you delete a connector, _it cannot be recovered_.
|
||||
|
||||
[[actions-and-connectors-api-delete-request]]
|
||||
[[delete-connector-api-request]]
|
||||
==== Request
|
||||
|
||||
`DELETE <kibana host>:<port>/api/actions/connector/<id>`
|
||||
|
||||
`DELETE <kibana host>:<port>/s/<space_id>/api/actions/connector/<id>`
|
||||
|
||||
[[actions-and-connectors-api-delete-path-params]]
|
||||
[[delete-connector-api-path-params]]
|
||||
==== Path parameters
|
||||
|
||||
`id`::
|
||||
|
@ -24,7 +24,7 @@ WARNING: When you delete a connector, _it cannot be recovered_.
|
|||
`space_id`::
|
||||
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
|
||||
|
||||
[[actions-and-connectors-api-delete-response-codes]]
|
||||
[[delete-connector-api-response-codes]]
|
||||
==== Response code
|
||||
|
||||
`200`::
|
||||
|
|
|
@ -1,19 +1,19 @@
|
|||
[[actions-and-connectors-api-execute]]
|
||||
[[execute-connector-api]]
|
||||
=== Execute connector API
|
||||
++++
|
||||
<titleabbrev>Execute connector API</titleabbrev>
|
||||
<titleabbrev>Execute connector</titleabbrev>
|
||||
++++
|
||||
|
||||
Executes a connector by ID.
|
||||
|
||||
[[actions-and-connectors-api-execute-request]]
|
||||
[[execute-connector-api-request]]
|
||||
==== Request
|
||||
|
||||
`POST <kibana host>:<port>/api/actions/connector/<id>/_execute`
|
||||
|
||||
`POST <kibana host>:<port>/s/<space_id>/api/actions/connector/<id>/_execute`
|
||||
|
||||
[[actions-and-connectors-api-execute-params]]
|
||||
[[execute-connector-api-params]]
|
||||
==== Path parameters
|
||||
|
||||
`id`::
|
||||
|
@ -22,20 +22,20 @@ Executes a connector by ID.
|
|||
`space_id`::
|
||||
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
|
||||
|
||||
[[actions-and-connectors-api-execute-request-body]]
|
||||
[[execute-connector-api-request-body]]
|
||||
==== Request body
|
||||
|
||||
`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>>.
|
||||
|
||||
[[actions-and-connectors-api-execute-codes]]
|
||||
[[execute-connector-api-codes]]
|
||||
==== Response code
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[actions-and-connectors-api-execute-example]]
|
||||
[[execute-connector-api-example]]
|
||||
==== Example
|
||||
|
||||
[source,sh]
|
||||
|
|
|
@ -1,19 +1,19 @@
|
|||
[[actions-and-connectors-api-get]]
|
||||
[[get-connector-api]]
|
||||
=== Get connector API
|
||||
++++
|
||||
<titleabbrev>Get connector API</titleabbrev>
|
||||
<titleabbrev>Get connector</titleabbrev>
|
||||
++++
|
||||
|
||||
Retrieves a connector by ID.
|
||||
|
||||
[[actions-and-connectors-api-get-request]]
|
||||
[[get-connector-api-request]]
|
||||
==== Request
|
||||
|
||||
`GET <kibana host>:<port>/api/actions/connector/<id>`
|
||||
|
||||
`GET <kibana host>:<port>/s/<space_id>/api/actions/connector/<id>`
|
||||
|
||||
[[actions-and-connectors-api-get-params]]
|
||||
[[get-connector-api-params]]
|
||||
==== Path parameters
|
||||
|
||||
`id`::
|
||||
|
@ -22,13 +22,13 @@ Retrieves a connector by ID.
|
|||
`space_id`::
|
||||
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
|
||||
|
||||
[[actions-and-connectors-api-get-codes]]
|
||||
[[get-connector-api-codes]]
|
||||
==== Response code
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[actions-and-connectors-api-get-example]]
|
||||
[[get-connector-api-example]]
|
||||
==== Example
|
||||
|
||||
[source,sh]
|
||||
|
|
|
@ -1,31 +1,31 @@
|
|||
[[actions-and-connectors-api-get-all]]
|
||||
=== Get all actions API
|
||||
[[get-all-connectors-api]]
|
||||
=== Get all connectors API
|
||||
++++
|
||||
<titleabbrev>Get all actions API</titleabbrev>
|
||||
<titleabbrev>Get all connectors</titleabbrev>
|
||||
++++
|
||||
|
||||
Retrieves all connectors.
|
||||
|
||||
[[actions-and-connectors-api-get-all-request]]
|
||||
[[get-all-connectors-api-request]]
|
||||
==== Request
|
||||
|
||||
`GET <kibana host>:<port>/api/actions/connectors`
|
||||
|
||||
`GET <kibana host>:<port>/s/<space_id>/api/actions/connectors`
|
||||
|
||||
[[actions-and-connectors-api-get-all-path-params]]
|
||||
[[get-all-connectors-api-path-params]]
|
||||
==== Path parameters
|
||||
|
||||
`space_id`::
|
||||
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
|
||||
|
||||
[[actions-and-connectors-api-get-all-codes]]
|
||||
[[get-all-connectors-api-codes]]
|
||||
==== Response code
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[actions-and-connectors-api-get-all-example]]
|
||||
[[get-all-connectors-api-example]]
|
||||
==== Example
|
||||
|
||||
[source,sh]
|
||||
|
|
|
@ -1,12 +1,10 @@
|
|||
[[actions-and-connectors-legacy-api-create]]
|
||||
==== Legacy Create connector API
|
||||
++++
|
||||
<titleabbrev>Legacy Create connector API</titleabbrev>
|
||||
<titleabbrev>Legacy Create connector</titleabbrev>
|
||||
++++
|
||||
|
||||
deprecated::[7.13.0]
|
||||
|
||||
Please use the <<actions-and-connectors-api-create>> instead.
|
||||
WARNING: Deprecated in 7.13.0. Use <<create-connector-api>> instead.
|
||||
|
||||
Creates a connector.
|
||||
|
||||
|
|
|
@ -1,12 +1,10 @@
|
|||
[[actions-and-connectors-legacy-api-delete]]
|
||||
==== Legacy Delete connector API
|
||||
++++
|
||||
<titleabbrev>Legacy Delete connector API</titleabbrev>
|
||||
<titleabbrev>Legacy Delete connector</titleabbrev>
|
||||
++++
|
||||
|
||||
deprecated::[7.13.0]
|
||||
|
||||
Please use the <<actions-and-connectors-api-delete>> instead.
|
||||
WARNING: Deprecated in 7.13.0. Use <<delete-connector-api>> instead.
|
||||
|
||||
Deletes a connector by ID.
|
||||
|
||||
|
|
|
@ -1,12 +1,10 @@
|
|||
[[actions-and-connectors-legacy-api-execute]]
|
||||
==== Legacy Execute connector API
|
||||
++++
|
||||
<titleabbrev>Legacy Execute connector API</titleabbrev>
|
||||
<titleabbrev>Legacy Execute connector</titleabbrev>
|
||||
++++
|
||||
|
||||
deprecated::[7.13.0]
|
||||
|
||||
Please use the <<actions-and-connectors-api-execute>> instead.
|
||||
WARNING: Deprecated in 7.13.0. Use <<execute-connector-api>> instead.
|
||||
|
||||
Executes a connector by ID.
|
||||
|
||||
|
|
|
@ -1,12 +1,10 @@
|
|||
[[actions-and-connectors-legacy-api-get]]
|
||||
==== Legacy Get connector API
|
||||
++++
|
||||
<titleabbrev>Legacy Get connector API</titleabbrev>
|
||||
<titleabbrev>Legacy Get connector</titleabbrev>
|
||||
++++
|
||||
|
||||
deprecated::[7.13.0]
|
||||
|
||||
Please use the <<actions-and-connectors-api-get>> instead.
|
||||
WARNING: Deprecated in 7.13.0. Use <<get-connector-api>> instead.
|
||||
|
||||
Retrieves a connector by ID.
|
||||
|
||||
|
|
|
@ -1,12 +1,10 @@
|
|||
[[actions-and-connectors-legacy-api-get-all]]
|
||||
==== Legacy Get all connector API
|
||||
++++
|
||||
<titleabbrev>Legacy Get all connector API</titleabbrev>
|
||||
<titleabbrev>Legacy Get all connector</titleabbrev>
|
||||
++++
|
||||
|
||||
deprecated::[7.13.0]
|
||||
|
||||
Please use the <<actions-and-connectors-api-get-all>> instead.
|
||||
WARNING: Deprecated in 7.13.0. Use <<get-all-connectors-api>> instead.
|
||||
|
||||
Retrieves all connectors.
|
||||
|
||||
|
|
|
@ -1,12 +1,10 @@
|
|||
[[actions-and-connectors-legacy-api-list]]
|
||||
==== Legacy List connector types API
|
||||
++++
|
||||
<titleabbrev>Legacy List all connector types API</titleabbrev>
|
||||
<titleabbrev>Legacy List all connector types</titleabbrev>
|
||||
++++
|
||||
|
||||
deprecated::[7.13.0]
|
||||
|
||||
Please use the <<actions-and-connectors-api-list>> instead.
|
||||
WARNING: Deprecated in 7.13.0. Use <<list-connector-types-api>> instead.
|
||||
|
||||
Retrieves a list of all connector types.
|
||||
|
||||
|
|
|
@ -1,12 +1,10 @@
|
|||
[[actions-and-connectors-legacy-api-update]]
|
||||
==== Legacy Update connector API
|
||||
++++
|
||||
<titleabbrev>Legacy Update connector API</titleabbrev>
|
||||
<titleabbrev>Legacy Update connector</titleabbrev>
|
||||
++++
|
||||
|
||||
deprecated::[7.13.0]
|
||||
|
||||
Please use the <<actions-and-connectors-api-update>> instead.
|
||||
WARNING: Deprecated in 7.13.0. Use <<update-connector-api>> instead.
|
||||
|
||||
Updates the attributes for an existing connector.
|
||||
|
||||
|
|
|
@ -1,31 +1,31 @@
|
|||
[[actions-and-connectors-api-list]]
|
||||
[[list-connector-types-api]]
|
||||
=== List connector types API
|
||||
++++
|
||||
<titleabbrev>List all connector types API</titleabbrev>
|
||||
<titleabbrev>List all connector types</titleabbrev>
|
||||
++++
|
||||
|
||||
Retrieves a list of all connector types.
|
||||
|
||||
[[actions-and-connectors-api-list-request]]
|
||||
[[list-connector-types-api-request]]
|
||||
==== Request
|
||||
|
||||
`GET <kibana host>:<port>/api/actions/connector_types`
|
||||
|
||||
`GET <kibana host>:<port>/s/<space_id>/api/actions/connector_types`
|
||||
|
||||
[[actions-and-connectors-api-list-path-params]]
|
||||
[[list-connector-types-api-path-params]]
|
||||
==== Path parameters
|
||||
|
||||
`space_id`::
|
||||
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
|
||||
|
||||
[[actions-and-connectors-api-list-codes]]
|
||||
[[list-connector-types-api-codes]]
|
||||
==== Response code
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[actions-and-connectors-api-list-example]]
|
||||
[[list-connector-types-api-example]]
|
||||
==== Example
|
||||
|
||||
[source,sh]
|
||||
|
|
|
@ -1,19 +1,19 @@
|
|||
[[actions-and-connectors-api-update]]
|
||||
[[update-connector-api]]
|
||||
=== Update connector API
|
||||
++++
|
||||
<titleabbrev>Update connector API</titleabbrev>
|
||||
<titleabbrev>Update connector</titleabbrev>
|
||||
++++
|
||||
|
||||
Updates the attributes for an existing connector.
|
||||
|
||||
[[actions-and-connectors-api-update-request]]
|
||||
[[update-connector-api-request]]
|
||||
==== Request
|
||||
|
||||
`PUT <kibana host>:<port>/api/actions/connector/<id>`
|
||||
|
||||
`PUT <kibana host>:<port>/s/<space_id>/api/actions/connector/<id>`
|
||||
|
||||
[[actions-and-connectors-api-update-params]]
|
||||
[[update-connector-api-params]]
|
||||
==== Path parameters
|
||||
|
||||
`id`::
|
||||
|
@ -22,7 +22,7 @@ Updates the attributes for an existing connector.
|
|||
`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]]
|
||||
[[update-connector-api-request-body]]
|
||||
==== Request body
|
||||
|
||||
`name`::
|
||||
|
@ -34,13 +34,13 @@ Updates the attributes for an existing connector.
|
|||
`secrets`::
|
||||
(Required, object) The updated secrets configuration for the connector. Secrets properties vary depending on the connector type. For information about the secrets configuration properties, refer to <<action-types,Action and connector types>>.
|
||||
|
||||
[[actions-and-connectors-api-update-codes]]
|
||||
[[update-connector-api-codes]]
|
||||
==== Response code
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[actions-and-connectors-api-update-example]]
|
||||
[[update-connector-api-example]]
|
||||
==== Example
|
||||
|
||||
[source,sh]
|
||||
|
|
Loading…
Reference in a new issue