SOsocket-dev
full-scans

Create full scan

Create a full scan from a set of package manifest files. Returns a full scan including all SBOM artifacts.

To get a list of supported filetypes that can be uploaded in a full-scan, see the Get supported file types endpoint.

The maximum number of files you can upload at a time is 10000 and each 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.

Query Parameters:

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

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes:

  • full-scans:create
post/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

repostring required

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

workspacestring

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

branchstring

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 ~^:?*[.

commit_messagestring

The commit message to associate the full-scan with.

commit_hashstring

The commit hash to associate the full-scan with.

pull_requestinteger

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

committersstring

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

integration_type'api' | 'github' | 'gitlab' | 'bitbucket' | 'azure' | 'web'

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

integration_org_slugstring

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.

make_default_branchboolean

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

set_as_pending_headboolean

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.

tmpboolean

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

scan_typestring

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

Request body multipart/form-data

object required

Response

The details of the created full scan.

idstring
created_atstring
updated_atstring
organization_idstring
organization_slugstring
repository_idstring
repository_slugstring
branchstring nullable
commit_messagestring nullable
commit_hashstring nullable
pull_requestinteger nullable
committersstring[]
html_urlstring nullable
api_urlstring nullable
workspacestring
repostring
html_report_urlstring
integration_typestring nullable
integration_repo_urlstring nullable
integration_branch_urlstring nullable
integration_commit_urlstring nullable
integration_pull_request_urlstring nullable
scan_typestring nullable
scan_state'pending' | 'precrawl' | 'resolve' | 'scan' nullable

The current processing status of the SBOM

unmatchedFilesstring[]

Changes

No recorded changes to this operation across all 2 revisions of this API.