API Reference

Stream full scan

get
https://api.socket.dev/v0/orgs//full-scans/

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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The slug of the organization

string
required

The ID of the full scan

Query Params
Defaults to false

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.

boolean
required
Defaults to false

Include scores event in the response. include_scores_details implies this flag

Defaults to false

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.

boolean
required
Defaults to false

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

boolean
Defaults to false

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.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/x-ndjson
application/json

Updated 4 months ago