Add and remove detection alert tags

Base URL: https://{kibana_url}

POST /api/detection_engine/signals/tags
POST /s/{space_id}/api/detection_engine/signals/tags

Auth

Add tags to detection alerts, and remove them from alerts, by alert IDs or a query, in a single request.

Note

You cannot add and remove the same alert tag in the same request.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Request body

An object containing tags to add or remove and alert ids the changes will be applied

ids string[] · format: nonempty · min items: 1 required: A list of alerts ids.
tags object required: Object with list of tags to add and remove.

Responses

Successful response

application/json

Response Type: object

Invalid input data response

application/json

Unsuccessful authentication response

application/json

Internal server error response

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/detection_engine/signals/tags
{
  "ids": [
    "549c7129c76cbd554aba1bd638f8a49dde95088f5832e50218358e7eca1cf16e"
  ],
  "tags": {
    "tags_to_add": [
      "Duplicate"
    ],
    "tags_to_remove": []
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/detection_engine/signals/tags" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [
      "549c7129c76cbd554aba1bd638f8a49dde95088f5832e50218358e7eca1cf16e"
    ],
    "tags": {
      "tags_to_add": [
        "Duplicate"
      ],
      "tags_to_remove": []
    }
  }'

Generated from the API spec

Response

{
  "batches": "1,",
  "deleted": "0,",
  "failures": [],
  "noops": "0,",
  "requests_per_second": "-1,",
  "retries": {
    "bulk": "0,",
    "search": 0
  },
  "throttled_millis": "0,",
  "throttled_until_millis": "0,",
  "timed_out": "false,",
  "took": "68,",
  "total": "1,",
  "updated": "1,",
  "version_conflicts": "0,"
}

{
  "error": "Bad Request",
  "message": "[request body].tags: cannot add and remove the same tag in a single request",
  "statusCode": 400
}

{
  "error": "Unauthorized",
  "message": "[security_exception\n\tRoot causes:\n\t\tsecurity_exception: unable to authenticate user [elastic] for REST request [/_security/_authenticate]]: unable to authenticate user [elastic] for REST request [/_security/_authenticate]",
  "statusCode": 401
}

{
  "message": "Internal Server Error",
  "status_code": 500
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/detection_engine/signals/tags
{
  "ids": [
    "549c7129c76cbd554aba1bd638f8a49dde95088f5832e50218358e7eca1cf16e"
  ],
  "tags": {
    "tags_to_add": [],
    "tags_to_remove": [
      "Duplicate"
    ]
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/detection_engine/signals/tags" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [
      "549c7129c76cbd554aba1bd638f8a49dde95088f5832e50218358e7eca1cf16e"
    ],
    "tags": {
      "tags_to_add": [],
      "tags_to_remove": [
        "Duplicate"
      ]
    }
  }'

Generated from the API spec

Response

{
  "batches": "1,",
  "deleted": "0,",
  "failures": [],
  "noops": "0,",
  "requests_per_second": "-1,",
  "retries": {
    "bulk": "0,",
    "search": 0
  },
  "throttled_millis": "0,",
  "throttled_until_millis": "0,",
  "timed_out": "false,",
  "took": "68,",
  "total": "1,",
  "updated": "1,",
  "version_conflicts": "0,"
}

{
  "error": "Bad Request",
  "message": "[request body].tags: cannot add and remove the same tag in a single request",
  "statusCode": 400
}

{
  "error": "Unauthorized",
  "message": "[security_exception\n\tRoot causes:\n\t\tsecurity_exception: unable to authenticate user [elastic] for REST request [/_security/_authenticate]]: unable to authenticate user [elastic] for REST request [/_security/_authenticate]",
  "statusCode": 401
}

{
  "message": "Internal Server Error",
  "status_code": 500
}

Path parameters

Request body { }

Responses

Request body