IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs ›Kibana Guide [7.12] ›REST API ›Action and connector APIs
« Create action API Execute action API »

Update action APIedit

Updates the attributes for an existing action.

Requestedit

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

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

Path parametersedit

id
(Required, string) The ID of the action.
space_id
(Optional, string) An identifier for the space. If space_id is not provided in the URL, the default space is used.

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
}
« Create action API Execute action API »