SOsocket-dev
full-scans

Stream full scan

Changed on

Stream all SBOM artifacts for a full scan.

This endpoint returns the latest, available alert data for artifacts in the full scan (stale while revalidate). Actively running analysis will be returned when available on subsequent runs.

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/{full_scan_id}

Request

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

Path parameters

org_slugstring required

The slug of the organization

full_scan_idstring required

The ID of the full scan

Query parameters

boolean
OR
string[]

Control which alert priority fields to include in the response. Set to "true" to include all fields, "false" to exclude all fields, or specify individual fields like "components,formula" to include only those fields.

include_scoresboolean required

Include scores event in the response. include_scores_details implies this flag

boolean
OR
string[]

Control which score detail fields to include in the scores event. Set to "true" to include all fields, "false" to exclude all fields, or specify individual fields like "components,formula" to include only those fields.

include_license_detailsboolean required

Include license details in the response. This can increase the response size significantly.

cachedboolean

Return cached immutable scan results. When enabled and results are cached, returns the pre-computed scan. When results are not yet cached, returns 202 Accepted and enqueues a background job.

if_cachedboolean

Return the cached immutable scan results when they exist, otherwise 404. Never enqueues a scan job. Implies cached.

Response

Socket issue lists and scores for all packages, followed by a final scores event

Changes

  • 5ad8bf36b1e7Revision changes
    • warning

      added the new edge-extension enum value to the ///////////// response property for the response status

    • warning

      added the new edge-extension enum value to the //////// response property for the response status

    • warning

      added the new firefox-extension enum value to the ///////////// response property for the response status

    • warning

      added the new firefox-extension enum value to the //////// response property for the response status

    • warning

      added the new vscode-extension enum value to the ///////////// response property for the response status

    • warning

      added the new vscode-extension enum value to the //////// response property for the response status

    • info

      added the new optional query request parameter if_cached

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      removed subschema #1 subschema #2 from the /////////// response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the /////////// response property anyOf list for the response status