v1
latestOpenAPI 3.0.02026-07-249055687.1 KBCreate full scan from 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.
This endpoint consumes 1 unit of your quota.
This endpoint requires the following org token scopes:
- full-scans:create
Path parameters
The slug of the organization
Query parameters
The slug of the repository to associate the full-scan with.
The workspace of the repository to associate the full-scan with.
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 ~^:?*[.
The commit message to associate the full-scan with.
The commit hash to associate the full-scan with.
The pull request number to associate the full-scan with.
The committers to associate with the full-scan. Set query more than once to set multiple.
The integration type to associate the full-scan with. Defaults to "Api" if omitted.
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.
Set the default branch of the repository to the branch of this full-scan. A branch name is required with this option.
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.
Create a temporary full-scan that is not listed in the reports dashboard. Cannot be used when set_as_pending_head=true.
The type of scan to perform. Defaults to 'socket'. Must be 32 characters or less. Used for categorizing multiple SBOM heads per repository branch.
Response
The details of the created full scan.