API Reference
  1. API Endpoints
  2. Diff Scans

SCM comments for diff scan

get
https://api.socket.dev/v0/orgs//diff-scans//comments

Get the dependency overview and dependency alert comments for an existing diff scan, rendered for the pull or merge request platform that will display them.

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes:

  • diff-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

uuid
required

The ID of the diff scan

Query Params
string
enum
required

The platform that will display the comments. Selects branding, wording, link formats, and image formats.

Allowed:
string
required

Web URL of the pull or merge request that will display the comments, used to link manifests to its diff. A diff scan can be shared by several requests, so it is never inferred. GitHub URLs must be on a GitHub host registered with Socket.

boolean

Include @SocketSecurity ignore and patch instructions. Set only when the caller handles those replies. Defaults to the platform's setting: true for github, false otherwise.

boolean
Defaults to false

Comments are always rendered from the same immutable diff scan results as GET /diff-scans/{diff_scan_id}, so they match verdicts computed from that response. By default the request waits for those results like GET does. With cached=true it returns 202 Accepted immediately and enqueues processing when results are not cached yet.

string

The ID of a GitHub installation whose custom alerts header and ignore comment setting should be used.

Responses

Updated 1 day 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 1 day ago

Did this page help you?