SOsocket-dev
full-scans

List full scans

Changed on

Returns a paginated list of all full scans in an org, excluding SBOM artifacts.

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes:

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

Request

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

Path parameters

org_slugstring required

The slug of the organization

Query parameters

sort'name' | 'created_at'

Specify Sort order.

direction'asc' | 'desc'

Specify sort direction.

per_pageinteger

Specify the maximum number of results to return per page.

pageinteger

The page number to return when using offset-style pagination. Ignored when cursor pagination is used.

startAfterCursorstring

Cursor token for pagination. Pass the previous response's endCursor to fetch the next set of results. nextPageCursor remains available for compatibility. Unsupported cursor aliases return 400; unrelated query parameters are unchanged.

use_cursorboolean

Set to true on the first request to opt into cursor-based pagination.

fromstring

A Unix timestamp in seconds that filters full-scans prior to the date.

workspacestring

A repository workspace to filter full-scans by.

repostring

A repository slug to filter full-scans by.

branchstring

A branch name to filter full-scans by.

pull_requeststring

A PR number to filter full-scans by.

commit_hashstring

A commit hash to filter full-scans by.

scan_typestring

A scan type to filter full-scans by (e.g. socket, socket_tier1, socket_basics).

has_cached_resultboolean

Set to true to only return full 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 repositories for the specified organization. The authenticated user must be a member of the organization.

endCursorstring nullable required
nextPageCursorstring nullable required

Deprecated alias for endCursor.

nextPageinteger nullable required

Changes

  • 5ad8bf36b1e7Revision changes
    • info

      added the new optional query request parameter has_cached_result

    • info

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

    • info

      response property nextPageCursor deprecated

    • info

      added the required property to the response with the status