A newer version is available. For the latest information, see the
current release documentation.
Update connector APIedit
Updates the attributes for an existing connector.
Requestedit
PUT <kibana host>:<port>/api/actions/connector/<id>
PUT <kibana host>:<port>/s/<space_id>/api/actions/connector/<id>
Path parametersedit
-
id - (Required, string) The ID of the connector.
-
space_id -
(Optional, string) An identifier for the space. If
space_idis not provided in the URL, the default space is used.
Request bodyedit
-
name - (Required, string) The new name of the connector.
-
config - (Required, object) The new connector configuration. Configuration properties vary depending on the connector type. For information about the configuration properties, refer to Action and connector types.
-
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 and connector types.
Response codeedit
-
200 - Indicates a successful call.
Exampleedit
$ curl -X PUT api/actions/connector/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
"name": "updated-connector",
"config": {
"index": "updated-index"
}
}'
The API returns the following:
{
"id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad",
"connector_type_id": ".index",
"name": "updated-connector",
"config": {
"index": "updated-index",
"refresh": false,
"executionTimeField": null
},
"is_preconfigured": false,
"is_missing_secrets": false
}