Trending Actors

To monitor for trending actors, use the actors index page, with the 'sort' parameter set to one of the following:

  • trending_1d

  • trending_7d

  • trending_30d

Threat Actors Index

get

Endpoint to browse for threat actors, with filters on some criteria.

Query parameters
filterstringOptional

A string used to filter threat actors. It can start with specific prefixes to indicate the type of filter:

  • name:: Filter by Name, case-insensitive.
  • uuid:: Filter by UUID, case-insensitive.
  • internal_name:: Filter by internal_name (exact match).
  • desc:: Filter by description (searches both description and gen_description fields). If no prefix is provided, it defaults to filtering on the display_name or name fields. Examples:
  • name:APT
  • name:lazarus_group
  • internal_name:m-threat-actor-happy-yellow-dog-a123
  • lazarus_group
  • Lazarus Group
offsetintegerOptional

The number of items to skip before starting to collect the result set.

Default: 0
sortstringOptional

Field to sort by - either name, created_at, updated_at, enriched_at, trending_1d, trending_7d, or trending_30d

Default: created_atPattern: ^(name|created_at|updated_at|enriched_at|trending_1d|trending_7d|trending_30d)$
orderstringOptional

Sort order - either asc or desc

Default: descPattern: ^(asc|desc)$
limitinteger · min: 1Optional

The maximum number of items to return.

Default: 100
include_mergedbooleanOptional

Include entities that have been merged into other entities

Default: false
followedbooleanOptional

When true, returns only threat actors that the tenant is following

Default: false
motivationany ofOptional

Filter on the motivation field by exact match

stringOptional
or
nullOptional
motivation__neqany ofOptional

Filter on the motivation field for items not equal to the given value

stringOptional
or
nullOptional
motivation__inany ofOptional

Filter on the motivation field for items that match any value in a comma-separated list

stringOptional
or
nullOptional
motivation__not_inany ofOptional

Filter on the motivation field for items that do not match any value in a comma-separated list

stringOptional
or
nullOptional
motivation__likeany ofOptional

Filter on the motivation field for items that match a SQL LIKE pattern (use % as wildcard, case-sensitive)

stringOptional
or
nullOptional
motivation__ilikeany ofOptional

Filter on the motivation field for items that match a SQL LIKE pattern (use % as wildcard, case-insensitive)

stringOptional
or
nullOptional
sponsorany ofOptional

Filter on the sponsor field by exact match

stringOptional
or
nullOptional
sponsor__neqany ofOptional

Filter on the sponsor field for items not equal to the given value

stringOptional
or
nullOptional
sponsor__inany ofOptional

Filter on the sponsor field for items that match any value in a comma-separated list

stringOptional
or
nullOptional
sponsor__not_inany ofOptional

Filter on the sponsor field for items that do not match any value in a comma-separated list

stringOptional
or
nullOptional
sponsor__likeany ofOptional

Filter on the sponsor field for items that match a SQL LIKE pattern (use % as wildcard, case-sensitive)

stringOptional
or
nullOptional
sponsor__ilikeany ofOptional

Filter on the sponsor field for items that match a SQL LIKE pattern (use % as wildcard, case-insensitive)

stringOptional
or
nullOptional
family_nameany ofOptional

Filter on the family_name field by exact match

stringOptional
or
nullOptional
family_name__neqany ofOptional

Filter on the family_name field for items not equal to the given value

stringOptional
or
nullOptional
family_name__inany ofOptional

Filter on the family_name field for items that match any value in a comma-separated list

stringOptional
or
nullOptional
family_name__not_inany ofOptional

Filter on the family_name field for items that do not match any value in a comma-separated list

stringOptional
or
nullOptional
family_name__likeany ofOptional

Filter on the family_name field for items that match a SQL LIKE pattern (use % as wildcard, case-sensitive)

stringOptional
or
nullOptional
family_name__ilikeany ofOptional

Filter on the family_name field for items that match a SQL LIKE pattern (use % as wildcard, case-insensitive)

stringOptional
or
nullOptional
enriched_at__gteany ofOptional

Filter on the enriched_at field for items greater than or equal to the given value

string · date-timeOptional
or
nullOptional
enriched_at__ltany ofOptional

Filter on the enriched_at field for items less than the given value

string · date-timeOptional
or
nullOptional
created_at__gteany ofOptional

Filter on the created_at field for items greater than or equal to the given value

string · date-timeOptional
or
nullOptional
created_at__ltany ofOptional

Filter on the created_at field for items less than the given value

string · date-timeOptional
or
nullOptional
updated_at__gteany ofOptional

Filter on the updated_at field for items greater than or equal to the given value

string · date-timeOptional
or
nullOptional
updated_at__ltany ofOptional

Filter on the updated_at field for items less than the given value

string · date-timeOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
get
/v1/actors

Once you've identified the ideal aperature, and you'd like more detail about /why/ they are trending, you can simply build a list of the actor uuids and request each one individually, the response contains the recent mentions.

Lookup Threat Actor

get
Path parameters
identifierstringRequired

The unique UUID or name of the threat actor to retrieve

Responses
chevron-right
200

Successful Response

application/json
get
/v1/actors/{identifier}

Last updated