List findings for advisory

curl --request POST \
  --url https://semgrep.dev/api/sca/deployments/{deploymentId}/advisories/{advisoryId}/findings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deploymentId": 123,
  "advisoryId": "ssc-abc123",
  "pageSize": 25,
  "cursorFindingCount": 123,
  "cursorProjectName": "<string>"
}
'

import requests

url = "https://semgrep.dev/api/sca/deployments/{deploymentId}/advisories/{advisoryId}/findings"

payload = {
    "deploymentId": 123,
    "advisoryId": "ssc-abc123",
    "pageSize": 25,
    "cursorFindingCount": 123,
    "cursorProjectName": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deploymentId: 123,
    advisoryId: 'ssc-abc123',
    pageSize: 25,
    cursorFindingCount: 123,
    cursorProjectName: '<string>'
  })
};

fetch('https://semgrep.dev/api/sca/deployments/{deploymentId}/advisories/{advisoryId}/findings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://semgrep.dev/api/sca/deployments/{deploymentId}/advisories/{advisoryId}/findings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'deploymentId' => 123,
    'advisoryId' => 'ssc-abc123',
    'pageSize' => 25,
    'cursorFindingCount' => 123,
    'cursorProjectName' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://semgrep.dev/api/sca/deployments/{deploymentId}/advisories/{advisoryId}/findings"

	payload := strings.NewReader("{\n  \"deploymentId\": 123,\n  \"advisoryId\": \"ssc-abc123\",\n  \"pageSize\": 25,\n  \"cursorFindingCount\": 123,\n  \"cursorProjectName\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://semgrep.dev/api/sca/deployments/{deploymentId}/advisories/{advisoryId}/findings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"deploymentId\": 123,\n  \"advisoryId\": \"ssc-abc123\",\n  \"pageSize\": 25,\n  \"cursorFindingCount\": 123,\n  \"cursorProjectName\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://semgrep.dev/api/sca/deployments/{deploymentId}/advisories/{advisoryId}/findings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"deploymentId\": 123,\n  \"advisoryId\": \"ssc-abc123\",\n  \"pageSize\": 25,\n  \"cursorFindingCount\": 123,\n  \"cursorProjectName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "projects": [
    {
      "projectName": "<string>",
      "totalFindingCount": 123,
      "branchFindings": [
        {
          "branchName": "<string>",
          "findingCount": 123
        }
      ]
    }
  ],
  "hasMore": true,
  "cursorFindingCount": 123,
  "cursorProjectName": "<string>",
  "ruleId": "<string>"
}

POST

api

sca

deployments

{deploymentId}

advisories

{advisoryId}

findings

List findings for advisory

curl --request POST \
  --url https://semgrep.dev/api/sca/deployments/{deploymentId}/advisories/{advisoryId}/findings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deploymentId": 123,
  "advisoryId": "ssc-abc123",
  "pageSize": 25,
  "cursorFindingCount": 123,
  "cursorProjectName": "<string>"
}
'

import requests

url = "https://semgrep.dev/api/sca/deployments/{deploymentId}/advisories/{advisoryId}/findings"

payload = {
    "deploymentId": 123,
    "advisoryId": "ssc-abc123",
    "pageSize": 25,
    "cursorFindingCount": 123,
    "cursorProjectName": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deploymentId: 123,
    advisoryId: 'ssc-abc123',
    pageSize: 25,
    cursorFindingCount: 123,
    cursorProjectName: '<string>'
  })
};

fetch('https://semgrep.dev/api/sca/deployments/{deploymentId}/advisories/{advisoryId}/findings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://semgrep.dev/api/sca/deployments/{deploymentId}/advisories/{advisoryId}/findings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'deploymentId' => 123,
    'advisoryId' => 'ssc-abc123',
    'pageSize' => 25,
    'cursorFindingCount' => 123,
    'cursorProjectName' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://semgrep.dev/api/sca/deployments/{deploymentId}/advisories/{advisoryId}/findings"

	payload := strings.NewReader("{\n  \"deploymentId\": 123,\n  \"advisoryId\": \"ssc-abc123\",\n  \"pageSize\": 25,\n  \"cursorFindingCount\": 123,\n  \"cursorProjectName\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://semgrep.dev/api/sca/deployments/{deploymentId}/advisories/{advisoryId}/findings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"deploymentId\": 123,\n  \"advisoryId\": \"ssc-abc123\",\n  \"pageSize\": 25,\n  \"cursorFindingCount\": 123,\n  \"cursorProjectName\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://semgrep.dev/api/sca/deployments/{deploymentId}/advisories/{advisoryId}/findings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"deploymentId\": 123,\n  \"advisoryId\": \"ssc-abc123\",\n  \"pageSize\": 25,\n  \"cursorFindingCount\": 123,\n  \"cursorProjectName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "projects": [
    {
      "projectName": "<string>",
      "totalFindingCount": 123,
      "branchFindings": [
        {
          "branchName": "<string>",
          "findingCount": 123
        }
      ]
    }
  ],
  "hasMore": true,
  "cursorFindingCount": 123,
  "cursorProjectName": "<string>",
  "ruleId": "<string>"
}

This endpoint is experimental. It may change or be removed without notice, and is not covered by API stability guarantees.

Authorizations

Authorization

string

header

required

Get access to data with your API token. Example header:

Authorization: Bearer 2991e2fb4b540fe75b8f90677b0b892b6314e4961cb001fe6eb452eee248a628

The token can be provisioned from the Tokens section in your Settings, and requires explicitly enabling Web API access.

Path Parameters

deploymentId

string<int64>

required

Deployment ID (numeric). Example: 123. Can be found at /deployments, or in your Settings in the web UI.

Example:

123

advisoryId

string

required

Advisory identifier to get findings for

Example:

"ssc-abc123"

Body

application/json

deploymentId

string<int64>

Deployment ID (numeric). Example: 123. Can be found at /deployments, or in your Settings in the web UI.

Example:

123

advisoryId

string

Advisory identifier to get findings for

Example:

"ssc-abc123"

pageSize

integer<int64>

default:25

Number of projects per page.

Required range: 1 <= x <= 100

Example:

25

cursorFindingCount

integer<int64>

Total finding count from the last project of the previous page for cursor-based pagination.

cursorProjectName

string

Project name from the last project of the previous page for cursor-based pagination.

Response

200 - application/json

projects

object[]

List of projects with their branch-level finding summaries.

Show child attributes

hasMore

boolean

True if there are more projects to get.

cursorFindingCount

integer<int64>

Total finding count from the last project - pass to next request for pagination.

cursorProjectName

string

Project name from the last project - pass to next request for pagination.

ruleId

string

Database rule ID for constructing findings URLs (integer primary key)

⌘I

Overview

Endpoints

List findings for advisory

Authorizations

Path Parameters

Body

Response