API Reference
  1. API Endpoints
  2. Full Scans

Create full scan from archive

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

Create a full scan by uploading one or more archives. Supported archive formats include .tar, .tar.gz/.tgz, and .zip.

Each uploaded archive is extracted server-side and any supported manifest files (like package.json, package-lock.json, pnpm-lock.yaml, etc.) are ingested for the scan. If you upload multiple archives in a single request, the manifests from every archive are merged into one full scan. The response includes any files that were ignored.

The maximum combined number of files extracted from your upload is 10000 and each extracted file can be no bigger than 268 MB.

To make a scan's alerts show up in notifications and the main dashboard, pass these query parameters:

  • branch: the repo's default branch, e.g. main
  • make_default_branch=true
  • set_as_pending_head=true

Without them, the scan's alerts only appear in its own report. Repos created by this endpoint have no default branch until make_default_branch=true sets one, and set_as_pending_head is ignored on other branches.

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes:

  • full-scans:create
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The slug of the organization

Query Params
string
required

The slug of the repository to associate the full-scan with.

string

The workspace of the repository to associate the full-scan with.

string

The branch name to associate the full-scan with. Branch names must follow Git branch name rules: be 1–255 characters long; cannot be exactly @; cannot begin or end with /, ., or .lock; cannot contain "//", "..", or "@{"; and cannot include control characters, spaces, or any of ~^:?*[.

string

The commit message to associate the full-scan with.

string

The commit hash to associate the full-scan with.

integer
≥ 1

The pull request number to associate the full-scan with.

string

The committers to associate with the full-scan. Set query more than once to set multiple.

string
enum

The integration type to associate the full-scan with. Defaults to "Api" if omitted.

Allowed:
string

The integration org slug to associate the full-scan with. If omitted, the Socket org name will be used. This is used to generate links and badges.

boolean
Defaults to false

Set the default branch of the repository to the branch of this full-scan. A branch name is required with this option.

boolean
Defaults to false

Designate this full-scan as the latest scan of a given branch. Default branch head scans are included in org alerts. This is only supported on the default branch. A branch name is required with this option.

boolean
Defaults to false

Create a temporary full-scan that is not listed in the reports dashboard. Cannot be used when set_as_pending_head=true.

string
Defaults to socket

The type of scan to perform. Defaults to 'socket'. Must be 32 characters or less. Used for categorizing multiple SBOM heads per repository branch.

Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?