Create a new watchlist

Base URL: https://{kibana_url}

POST /api/entity_analytics/watchlists

Creates a new entity analytics watchlist with an optional set of entity sources. Watchlists apply a risk score modifier to matched entities.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Request body

description string · max length: 1000: Description of the watchlist
entitySources object[] · max items: 100: Optional entity sources to create and link to the watchlist
managed boolean: Indicates if the watchlist is managed by the system
name string · max length: 256 required: Unique name for the watchlist
riskModifier number · min: 0 · max: 2 required: Risk score modifier associated with the watchlist

Response

Watchlist created successfully

application/json

createdAt string · format: date-time: Timestamp indicating when the watchlist was created
description string: Description of the watchlist
entityCount number: Number of entities in the watchlist
entitySourceIds string[]: List of entity source IDs associated with the watchlist
hasManualEntities boolean: Indicates whether the watchlist contains manually assigned entities
id string: The unique ID of the watchlist
managed boolean required: Indicates if the watchlist is managed by the system
name string required: The name of the watchlist
riskModifier number required: Risk score modifier associated with the watchlist
updatedAt string · format: date-time: Timestamp indicating when the watchlist was last updated
entitySources object[]

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/entity_analytics/watchlists
{
  "description": "High risk vendor watchlist",
  "managed": false,
  "name": "High Risk Vendors",
  "riskModifier": 1.5
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/entity_analytics/watchlists" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "High risk vendor watchlist",
    "managed": false,
    "name": "High Risk Vendors",
    "riskModifier": 1.5
  }'

Generated from the API spec

Response

{
  "createdAt": "2026-01-28T12:00:00.000Z",
  "description": "High risk vendor watchlist",
  "id": "watchlist-123",
  "managed": false,
  "name": "High Risk Vendors",
  "riskModifier": 1.5,
  "updatedAt": "2026-01-28T12:00:00.000Z"
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/entity_analytics/watchlists
{
  "description": "High risk vendor watchlist",
  "entitySources": [
    {
      "enabled": true,
      "identifierField": "user.name",
      "indexPattern": "my-sync-index",
      "name": "My User Index Source",
      "type": "index"
    }
  ],
  "managed": false,
  "name": "High Risk Vendors",
  "riskModifier": 1.5
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/entity_analytics/watchlists" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "High risk vendor watchlist",
    "entitySources": [
      {
        "enabled": true,
        "identifierField": "user.name",
        "indexPattern": "my-sync-index",
        "name": "My User Index Source",
        "type": "index"
      }
    ],
    "managed": false,
    "name": "High Risk Vendors",
    "riskModifier": 1.5
  }'

Generated from the API spec

Response

{
  "createdAt": "2026-01-28T12:00:00.000Z",
  "description": "High risk vendor watchlist",
  "id": "watchlist-123",
  "managed": false,
  "name": "High Risk Vendors",
  "riskModifier": 1.5,
  "updatedAt": "2026-01-28T12:00:00.000Z"
}

Authentication

Request body { }

Response

Request body