๐Ÿ”’ List collections

๐Ÿšง

Special privileges required

This endpoint is only available to users with the Threat Landscape module.

Returns a list of Collections objects.

Allowed filters:

  • Text without modifiers: Collection's name, description or tag.
  • creation_date: Collection's creation date.
  • description: Collection's description. You can search for word or expressions (full-text search).
  • name: Collection's name.
  • owner: Collection's owner.
  • source_region: Collections's source region. You can use ISO 3166-1 alpha-2 country codes, the ISO or the full country name.
  • tag: Collection's tag.
  • targeted_industry: Collections's targeted industry.
  • targeted_region: Collections's targeted region. Same use as source_region.
  • threat_category: Collection's threat category.

Allowed orders:

  • creation_date: Collection's creation date.
  • creation_day: Collection's creation day. Collections created within the same day are sorted by relevance.
  • domains: Number of domains in the collection.
  • files: Number of files in the collection.
  • ip_addresses: Number of IP addresses in the collection.
  • last_modification_date: Collection's last modification date.
  • last_modification_day: Collection's last modification day. Collections modified within the same day are sorted by relevance.
  • references: Number of references in the collection.
  • urls: Number of URLs in the collection.

Some examples:
GET /api/v3/collections?filter=source_region:US&order=files-
GET /api/v3/collections?filter=targeted_industry:government&order:creation_day-

Language
Credentials
Header
Click Try It! to start a request and see the response here!