IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Execute connector API
editExecute connector API
editExecutes a connector by ID.
Request
editPOST <kibana host>:<port>/api/actions/connector/<id>/_execute
POST <kibana host>:<port>/s/<space_id>/api/actions/connector/<id>/_execute
Path parameters
edit-
id
- (Required, string) The ID of the connector.
-
space_id
-
(Optional, string) An identifier for the space. If
space_id
is not provided in the URL, the default space is used.
Request body
edit-
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 and connector types.
Response code
edit-
200
- Indicates a successful call.
Example
edit$ curl -X POST api/actions/connector/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" } ] } }'
The API returns the following:
{ "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 } } ] }, "connector_id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad" }