Get a list of entities.

get

http://localhost/api/v1/entities

Required permissions

read entities

Optional permissions

read extracts Required to access the observables attached with an entity
read taxonomies Required to access the taxonomies associated with an entity
read attack Required to access the MITRE ATT&CKs associated with an entity
read intel-sets Required to access the datasets associated with an entity
read incoming-feeds Required to access the incoming feeds associated with an entity
read outgoing-feeds Required to access the outgoing feeds associated with an entity

Query Params

limit

int32

≥ 1

Maximum number of items to be returned

offset

int32

≥ 0

Return results starting from the specified (zero-based) index

sort

string

Comma-separated list of fields to sort on. Prefix a field with the minus "-" sign if you intend to apply descending sorting to it

data

boolean

Set this parameter to false if you want to only retrieve the number of objects matching the query

attributes

string

Comma-separated list of attributes to be returned. Nested attributes are separated by dots - e.g. data.title

filter[type]

string

Filter by entity type

filter[data.id]

string

Filter by STIX ID

filter[data.title]

string

Filter by title

filter[data.description]

string

Filter by description

filter[data.test_mechanisms.test_mechanism_type]

string

Filter by test mechanism type

filter[data.producer.identity]

string

Filter by producer identity

filter[data.producer.roles]

string

Filter by producer roles

filter[meta.alias]

string

Filter by entity alias

filter[meta.half_life]

string

Filter by entity half-life

filter[sources]

string

Filter by source(s)

filter[incoming_feed]

string

Filter by incoming feed ID/URL

filter[outgoing_feeds]

string

Filter by outgoing feed IDs/URLs

filter[meta.source_reliability]

string

Filter by entity source reliability

filter[meta.tags]

string

Filter by tags

filter[meta.taxonomies]

string

Filter by taxonomy node IDs/URLs

filter[meta.tlp_color]

string

Filter by TLP color

filter[meta.attacks]

string

Filter by MITRE attack IDs/URLs

filter[datasets]

string

Filter by dataset IDs/URLs

filter[observables]

string

Filter by observable IDs/URLs

Responses

200The requested object(s)

400Invalid request

401Unauthorized request

403Missing permissions

422Tighten your filters