API Reference

Create diff scan from full scan IDs

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

Create a diff scan from two existing full scan IDs. The full scans must be in the same repository. 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.

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes: - diff-scans:create

  • 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

Query Params
string
required

The ID of the before/base full scan (older)

string
required

The ID of the after/head full scan (newer)

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.

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.

Responses

Updated 7 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 7 months ago