Attack Paths
Enterprise

List attack path findings

Changed on

Returns a unified, paginated list of attack path findings. Defaults to active findings of both relationship and list types unless filtered otherwise.

get/api/v2/attack-paths/findings

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/attack-paths/findings
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

Query parameters

sort_bystring

Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

Sortable columns are severity, finding_type, finding, title, platform, environment_id, environment_name, asset_group_tag_id, zone_name, source_principal_id, source_principal_kind, source_principal_name, target_principal_id, target_principal_kind, target_principal_name, status, id, first_seen, last_seen.

severitystring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by severity level.

finding_typestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by finding type. When not provided, both types are returned.

findingstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by finding name.

titlestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by human-readable finding title.

platformstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by platform.

environment_idstring[]

Filter by one or more environment identifiers. Repeat the parameter to include multiple environments — results are the union of all specified values.

environment_namestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by environment display name.

asset_group_tag_idstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by asset group tag identifier.

zone_namestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by zone name (e.g. "Tier Zero").

source_principal_idstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by source principal identifier.

source_principal_kindstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by source principal kind.

source_principal_namestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by source principal display name.

target_principal_idstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by target principal identifier.

target_principal_kindstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by target principal kind.

target_principal_namestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by target principal display name.

statusstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by finding status.

first_seenstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by first seen timestamp.

last_seenstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Filter by last seen timestamp.

is_cross_platformstring

Filter results by column boolean value. Valid filter predicates are eq, neq.

Filter findings by whether source and target principals belong to different platforms.

skipinteger

The number of items to skip in a paginated response.

This query parameter is used for determining the number of objects to skip in pagination.

limitinteger

The limit of results requested by the client.

This query parameter is used for setting an upper limit of objects returned in paginated responses.

Response

OK

countinteger

The total number of results.

skipinteger

The number of items to skip in a paginated response.

limitinteger

The limit of results requested by the client.

Changes

  • e1b5e5927040Revision changes
    • warning

      added the new in_progress enum value to the /// response property for the response status

  • 98ac7bb39c3fRevision changes
    • info

      added the optional property /// to the response with the status