This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

› › ›

Get list container

edit

Get list container

edit

Retrieves a list container using its id field.

Request URL

edit

GET <kibana host>:<port>/api/lists

URL query parameters

edit

The URL query must include the list container’s id:

id - GET /api/lists?id=<id>

Example request

edit

Retrieves the list container with a id of internal-ip-excludes:

GET api/lists?id=internal-ip-excludes

Response code

edit

200: Indicates a successful call.

Response payload

edit

{
  "id": "internal-ip-excludes",
  "created_at": "2020-07-07T04:09:55.028Z",
  "created_by": "Threat Hunter",
  "description": "Contains list items that exclude internal IP addresses from detection rules.",
  "name": "Exclude internal IP addresses",
  "tie_breaker_id": "b123ab0e-d7c0-4ee5-9630-63a38641aa0c",
  "type": "ip",
  "updated_at": "2020-07-07T04:09:55.028Z",
  "updated_by": "Threat Hunter"
}

« Find list items Get list item »