API Reference

Create diff scan from repository HEAD full-scan

post
https://api.socket.dev/v0/orgs//diff-scans/from-repo/

Create a diff scan between the repository's current HEAD full scan and a new full scan from uploaded manifest files. Returns metadata about the diff scan. Once the diff scan is created, fetch the diff scan from the api_url URL to get the contents of the diff.

The maximum number of files you can upload at a time is 5000 and each file can be no bigger than 268 MB.

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes: - repo:list

  • diff-scans:create
  • 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

string
required

The slug of the repository

Query Params
string

A description of the diff scan. This will be used in the diff report and can be used to provide context for the changes made.

string

An external URL to associate with the diff scan. This can be a link to a pull request, issue, or any other relevant resource.

string

The branch name to associate the new 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 new full-scan with.

string

The commit hash to associate the full-scan with.

integer
≥ 1

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

string

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

string
enum

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

Allowed:
string

The integration org slug to associate the new 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 to true when running a diff between a merged commit and its parent commit in the same branch. Set to false when running diffs in an open PR between unmerged commits.

string

The workspace of the repository.

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/json

Updated 4 months ago