Attack Paths
Enterprise

List domain attack paths details

Changed on

Lists detailed data about attack paths for a domain.

Note: ImpactCount, ImpactPercentage, ExposureCount, ExposurePercentage and Severity will have a value other than zero when butterfly analysis is enabled.

get/api/v2/domains/{domain_id}/details

Request

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

Query parameters

Acceptstring

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

Media type to determine the response format (application/json or text/csv).

findingstring required

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

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 domain_sid, index, AcceptedUntil, id, created_at, updated_at, deleted_at, exposure_percentage, impact_percentage. Relationship risks can be sorted on FromPrincipal and ToPrincipal in addition to the sortable columns for List Risks.

FromPrincipalstring

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

ToPrincipalstring

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

from_principalstring

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

to_principalstring

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

principals_hashstring

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

Acceptedstring

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

AcceptedUntilstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

accepted_untilstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Principalstring

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

domain_sidstring

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

idstring

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

created_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Filter results by created_at value. See filter schema details for valid predicates.

updated_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Filter results by updated_at value. See filter schema details for valid predicates.

deleted_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Filter results by deleted_at value. See filter schema details for valid predicates.

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

OR

Changes

  • e0b866156902Revision changes
    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body oneOf list for the response status

  • 40bf219eced6Revision changes
    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ to the query request parameter id

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter AcceptedUntil

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter accepted_until

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter created_at

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter deleted_at

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter updated_at

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter Accept

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter Accepted

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter FromPrincipal

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter Principal

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter ToPrincipal

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter domain_sid

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter finding

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter from_principal

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter principals_hash

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter to_principal

    • info

      for the query request parameter AcceptedUntil, the format was generalized from date-time to no format

    • info

      for the query request parameter accepted_until, the format was generalized from date-time to no format

    • info

      for the query request parameter created_at, the format was generalized from date-time to no format

    • info

      for the query request parameter deleted_at, the format was generalized from date-time to no format

    • info

      for the query request parameter id, the type was generalized from integer to string

    • info

      for the query request parameter updated_at, the format was generalized from date-time to no format