Update action APIedit

Updates the attributes for an existing action.

Requestedit

PUT <kibana host>:<port>/api/actions/action/<id>

Path parametersedit

id
(Required, string) The ID of the action.

Request bodyedit

name
(Required, string) The new name of the action.
config
(Required, object) The new action configuration. Configuration properties vary depending on the action type. For information about the configuration properties, refer to Action and connector types.
secrets
(Required, object) The updated secrets configuration for the action. Secrets properties vary depending on the action 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/action/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad  -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
  "name": "updated-action",
  "config": {
    "index": "updated-index"
  }
}'

The API returns the following:

{
  "id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad",
  "actionTypeId": ".index",
  "name": "updated-action",
  "config": {
    "index": "updated-index",
    "refresh": false,
    "executionTimeField": null
  },
  "isPreconfigured": false
}