Sign in

v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
List

Returns all entities in the specified list as a JSON array with no pagination.

get/list/{listId}/entities

Response

Success

contextobject

Optional metadata attached to this entity when it was added to the list. Contains arbitrary key-value pairs set by the caller via the Add Entity endpoint. Only present if context was provided when the entity was added.

status'pending' | 'processing' | 'ready' required

pending — awaiting initial processing after being added; processing — currently being indexed; ready — fully processed and available for use in alerts and queries.

addedstring date-time required

Timestamp when the entity was added to the list

Example response

[
  {
    "entity": {
      "id": "ip:8.8.8.8",
      "type": "IpAddress",
      "name": "8.8.8.8"
    }
  }
]