SOsocket-dev
diff-scans

List diff scans

Changed on

Returns a paginated list of all diff scans in an organization.

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes:

  • diff-scans:list
get/orgs/{org_slug}/diff-scans

Request

  • Base URL
    https://api.socket.dev/v0
  • URL
    https://api.socket.dev/v0/orgs/{org_slug}/diff-scans
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

org_slugstring required

The slug of the organization

Query parameters

sort'created_at' | 'updated_at'

Specify sort field.

direction'asc' | 'desc'

Specify sort direction.

per_pageinteger

Specify the maximum number of results to return per page.

startAfterCursorstring

Pass the previous response endCursor to retrieve the next page. Takes precedence over cursor when both are supplied. Unsupported cursor aliases return 400; unrelated query parameters are unchanged.

cursorstring

Deprecated alias for startAfterCursor. Existing next_cursor values remain accepted.

repository_idstring

Filter by repository ID.

before_full_scan_idstring

Filter by before full scan ID.

after_full_scan_idstring

Filter by after full scan ID.

has_cached_resultboolean

Set to true to only return diff scans whose immutable result is still cached and can be retrieved without triggering a rescan. The marker is best-effort and may disagree with actual availability in either direction.

Response

Lists diff scans for the specified organization.

next_page_hrefstring nullable required
endCursorstring nullable required
next_cursorstring nullable required

Deprecated alias for endCursor.

Changes

  • 5ad8bf36b1e7Revision changes
    • info

      added the new optional query request parameter has_cached_result

    • info

      added the new optional query request parameter startAfterCursor

    • info

      query request parameter cursor was deprecated

    • info

      response property next_cursor deprecated

    • info

      added the required property to the response with the status

    • info

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