New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Action and connector APIs Get all actions API »
Elastic Docs ›Kibana Guide [7.11] ›REST API ›Action and connector APIs

Get action API

edit

Get action API

edit

Retrieves an action by ID.

Request

edit

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

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

Path parameters

edit
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.

Response code

edit
200
Indicates a successful call.

Example

edit
$ curl -X GET api/actions/action/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad
Copy as curl 

The API returns the following:

{
  "id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad",
  "actionTypeId": ".index",
  "name": "my-action",
  "config": {
    "index": "test-index",
    "refresh": false,
    "executionTimeField": null
  },
  "isPreconfigured": false
}
« Action and connector APIs Get all actions API »

On this page

Was this helpful?
Feedback