Export issues as CSV
curl --request POST \
--url https://semgrep.dev/api/deployments/{deploymentId}/issue-exports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"deploymentId": "<string>",
"filters": {
"ids": [
"<string>"
],
"titleQuery": "<string>",
"descriptionQuery": "<string>",
"reasoningQuery": "<string>",
"detectionStates": [],
"severities": [],
"triageStates": [],
"triageReasons": [],
"actions": [
"<string>"
],
"workflowIds": [
"<string>"
],
"identities": [
"<string>"
],
"triggerSources": [
"<string>"
],
"projectIds": [
"<string>"
],
"refIds": [
"<string>"
],
"filePathQuery": "<string>",
"createdAt": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
},
"lastDetectedAt": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
},
"triagedAt": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
},
"workflowJobIds": [
"<string>"
]
}
}
'import requests
url = "https://semgrep.dev/api/deployments/{deploymentId}/issue-exports"
payload = {
"deploymentId": "<string>",
"filters": {
"ids": ["<string>"],
"titleQuery": "<string>",
"descriptionQuery": "<string>",
"reasoningQuery": "<string>",
"detectionStates": [],
"severities": [],
"triageStates": [],
"triageReasons": [],
"actions": ["<string>"],
"workflowIds": ["<string>"],
"identities": ["<string>"],
"triggerSources": ["<string>"],
"projectIds": ["<string>"],
"refIds": ["<string>"],
"filePathQuery": "<string>",
"createdAt": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
},
"lastDetectedAt": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
},
"triagedAt": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
},
"workflowJobIds": ["<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: '<string>',
filters: {
ids: ['<string>'],
titleQuery: '<string>',
descriptionQuery: '<string>',
reasoningQuery: '<string>',
detectionStates: [],
severities: [],
triageStates: [],
triageReasons: [],
actions: ['<string>'],
workflowIds: ['<string>'],
identities: ['<string>'],
triggerSources: ['<string>'],
projectIds: ['<string>'],
refIds: ['<string>'],
filePathQuery: '<string>',
createdAt: {startAt: '2023-11-07T05:31:56Z', endAt: '2023-11-07T05:31:56Z'},
lastDetectedAt: {startAt: '2023-11-07T05:31:56Z', endAt: '2023-11-07T05:31:56Z'},
triagedAt: {startAt: '2023-11-07T05:31:56Z', endAt: '2023-11-07T05:31:56Z'},
workflowJobIds: ['<string>']
}
})
};
fetch('https://semgrep.dev/api/deployments/{deploymentId}/issue-exports', 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/deployments/{deploymentId}/issue-exports",
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' => '<string>',
'filters' => [
'ids' => [
'<string>'
],
'titleQuery' => '<string>',
'descriptionQuery' => '<string>',
'reasoningQuery' => '<string>',
'detectionStates' => [
],
'severities' => [
],
'triageStates' => [
],
'triageReasons' => [
],
'actions' => [
'<string>'
],
'workflowIds' => [
'<string>'
],
'identities' => [
'<string>'
],
'triggerSources' => [
'<string>'
],
'projectIds' => [
'<string>'
],
'refIds' => [
'<string>'
],
'filePathQuery' => '<string>',
'createdAt' => [
'startAt' => '2023-11-07T05:31:56Z',
'endAt' => '2023-11-07T05:31:56Z'
],
'lastDetectedAt' => [
'startAt' => '2023-11-07T05:31:56Z',
'endAt' => '2023-11-07T05:31:56Z'
],
'triagedAt' => [
'startAt' => '2023-11-07T05:31:56Z',
'endAt' => '2023-11-07T05:31:56Z'
],
'workflowJobIds' => [
'<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/deployments/{deploymentId}/issue-exports"
payload := strings.NewReader("{\n \"deploymentId\": \"<string>\",\n \"filters\": {\n \"ids\": [\n \"<string>\"\n ],\n \"titleQuery\": \"<string>\",\n \"descriptionQuery\": \"<string>\",\n \"reasoningQuery\": \"<string>\",\n \"detectionStates\": [],\n \"severities\": [],\n \"triageStates\": [],\n \"triageReasons\": [],\n \"actions\": [\n \"<string>\"\n ],\n \"workflowIds\": [\n \"<string>\"\n ],\n \"identities\": [\n \"<string>\"\n ],\n \"triggerSources\": [\n \"<string>\"\n ],\n \"projectIds\": [\n \"<string>\"\n ],\n \"refIds\": [\n \"<string>\"\n ],\n \"filePathQuery\": \"<string>\",\n \"createdAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"lastDetectedAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"triagedAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"workflowJobIds\": [\n \"<string>\"\n ]\n }\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/deployments/{deploymentId}/issue-exports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"deploymentId\": \"<string>\",\n \"filters\": {\n \"ids\": [\n \"<string>\"\n ],\n \"titleQuery\": \"<string>\",\n \"descriptionQuery\": \"<string>\",\n \"reasoningQuery\": \"<string>\",\n \"detectionStates\": [],\n \"severities\": [],\n \"triageStates\": [],\n \"triageReasons\": [],\n \"actions\": [\n \"<string>\"\n ],\n \"workflowIds\": [\n \"<string>\"\n ],\n \"identities\": [\n \"<string>\"\n ],\n \"triggerSources\": [\n \"<string>\"\n ],\n \"projectIds\": [\n \"<string>\"\n ],\n \"refIds\": [\n \"<string>\"\n ],\n \"filePathQuery\": \"<string>\",\n \"createdAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"lastDetectedAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"triagedAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"workflowJobIds\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://semgrep.dev/api/deployments/{deploymentId}/issue-exports")
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\": \"<string>\",\n \"filters\": {\n \"ids\": [\n \"<string>\"\n ],\n \"titleQuery\": \"<string>\",\n \"descriptionQuery\": \"<string>\",\n \"reasoningQuery\": \"<string>\",\n \"detectionStates\": [],\n \"severities\": [],\n \"triageStates\": [],\n \"triageReasons\": [],\n \"actions\": [\n \"<string>\"\n ],\n \"workflowIds\": [\n \"<string>\"\n ],\n \"identities\": [\n \"<string>\"\n ],\n \"triggerSources\": [\n \"<string>\"\n ],\n \"projectIds\": [\n \"<string>\"\n ],\n \"refIds\": [\n \"<string>\"\n ],\n \"filePathQuery\": \"<string>\",\n \"createdAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"lastDetectedAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"triagedAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"workflowJobIds\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"issueExport": {
"id": "<string>",
"state": "ISSUE_EXPORT_STATE_PENDING",
"downloadUrl": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"exportedCount": "<string>",
"truncated": true,
"failureReason": "<string>"
}
}Issues (Semgrep Agentic Workflows)
Export issues as CSV
Create an asynchronous CSV export of Semgrep Agentic Workflows issues. Exports are limited to 10,000 rows. Download URLs expire 15 minutes after generation finishes.
POST
/
api
/
deployments
/
{deploymentId}
/
issue-exports
Export issues as CSV
curl --request POST \
--url https://semgrep.dev/api/deployments/{deploymentId}/issue-exports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"deploymentId": "<string>",
"filters": {
"ids": [
"<string>"
],
"titleQuery": "<string>",
"descriptionQuery": "<string>",
"reasoningQuery": "<string>",
"detectionStates": [],
"severities": [],
"triageStates": [],
"triageReasons": [],
"actions": [
"<string>"
],
"workflowIds": [
"<string>"
],
"identities": [
"<string>"
],
"triggerSources": [
"<string>"
],
"projectIds": [
"<string>"
],
"refIds": [
"<string>"
],
"filePathQuery": "<string>",
"createdAt": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
},
"lastDetectedAt": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
},
"triagedAt": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
},
"workflowJobIds": [
"<string>"
]
}
}
'import requests
url = "https://semgrep.dev/api/deployments/{deploymentId}/issue-exports"
payload = {
"deploymentId": "<string>",
"filters": {
"ids": ["<string>"],
"titleQuery": "<string>",
"descriptionQuery": "<string>",
"reasoningQuery": "<string>",
"detectionStates": [],
"severities": [],
"triageStates": [],
"triageReasons": [],
"actions": ["<string>"],
"workflowIds": ["<string>"],
"identities": ["<string>"],
"triggerSources": ["<string>"],
"projectIds": ["<string>"],
"refIds": ["<string>"],
"filePathQuery": "<string>",
"createdAt": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
},
"lastDetectedAt": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
},
"triagedAt": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
},
"workflowJobIds": ["<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: '<string>',
filters: {
ids: ['<string>'],
titleQuery: '<string>',
descriptionQuery: '<string>',
reasoningQuery: '<string>',
detectionStates: [],
severities: [],
triageStates: [],
triageReasons: [],
actions: ['<string>'],
workflowIds: ['<string>'],
identities: ['<string>'],
triggerSources: ['<string>'],
projectIds: ['<string>'],
refIds: ['<string>'],
filePathQuery: '<string>',
createdAt: {startAt: '2023-11-07T05:31:56Z', endAt: '2023-11-07T05:31:56Z'},
lastDetectedAt: {startAt: '2023-11-07T05:31:56Z', endAt: '2023-11-07T05:31:56Z'},
triagedAt: {startAt: '2023-11-07T05:31:56Z', endAt: '2023-11-07T05:31:56Z'},
workflowJobIds: ['<string>']
}
})
};
fetch('https://semgrep.dev/api/deployments/{deploymentId}/issue-exports', 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/deployments/{deploymentId}/issue-exports",
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' => '<string>',
'filters' => [
'ids' => [
'<string>'
],
'titleQuery' => '<string>',
'descriptionQuery' => '<string>',
'reasoningQuery' => '<string>',
'detectionStates' => [
],
'severities' => [
],
'triageStates' => [
],
'triageReasons' => [
],
'actions' => [
'<string>'
],
'workflowIds' => [
'<string>'
],
'identities' => [
'<string>'
],
'triggerSources' => [
'<string>'
],
'projectIds' => [
'<string>'
],
'refIds' => [
'<string>'
],
'filePathQuery' => '<string>',
'createdAt' => [
'startAt' => '2023-11-07T05:31:56Z',
'endAt' => '2023-11-07T05:31:56Z'
],
'lastDetectedAt' => [
'startAt' => '2023-11-07T05:31:56Z',
'endAt' => '2023-11-07T05:31:56Z'
],
'triagedAt' => [
'startAt' => '2023-11-07T05:31:56Z',
'endAt' => '2023-11-07T05:31:56Z'
],
'workflowJobIds' => [
'<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/deployments/{deploymentId}/issue-exports"
payload := strings.NewReader("{\n \"deploymentId\": \"<string>\",\n \"filters\": {\n \"ids\": [\n \"<string>\"\n ],\n \"titleQuery\": \"<string>\",\n \"descriptionQuery\": \"<string>\",\n \"reasoningQuery\": \"<string>\",\n \"detectionStates\": [],\n \"severities\": [],\n \"triageStates\": [],\n \"triageReasons\": [],\n \"actions\": [\n \"<string>\"\n ],\n \"workflowIds\": [\n \"<string>\"\n ],\n \"identities\": [\n \"<string>\"\n ],\n \"triggerSources\": [\n \"<string>\"\n ],\n \"projectIds\": [\n \"<string>\"\n ],\n \"refIds\": [\n \"<string>\"\n ],\n \"filePathQuery\": \"<string>\",\n \"createdAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"lastDetectedAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"triagedAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"workflowJobIds\": [\n \"<string>\"\n ]\n }\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/deployments/{deploymentId}/issue-exports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"deploymentId\": \"<string>\",\n \"filters\": {\n \"ids\": [\n \"<string>\"\n ],\n \"titleQuery\": \"<string>\",\n \"descriptionQuery\": \"<string>\",\n \"reasoningQuery\": \"<string>\",\n \"detectionStates\": [],\n \"severities\": [],\n \"triageStates\": [],\n \"triageReasons\": [],\n \"actions\": [\n \"<string>\"\n ],\n \"workflowIds\": [\n \"<string>\"\n ],\n \"identities\": [\n \"<string>\"\n ],\n \"triggerSources\": [\n \"<string>\"\n ],\n \"projectIds\": [\n \"<string>\"\n ],\n \"refIds\": [\n \"<string>\"\n ],\n \"filePathQuery\": \"<string>\",\n \"createdAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"lastDetectedAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"triagedAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"workflowJobIds\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://semgrep.dev/api/deployments/{deploymentId}/issue-exports")
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\": \"<string>\",\n \"filters\": {\n \"ids\": [\n \"<string>\"\n ],\n \"titleQuery\": \"<string>\",\n \"descriptionQuery\": \"<string>\",\n \"reasoningQuery\": \"<string>\",\n \"detectionStates\": [],\n \"severities\": [],\n \"triageStates\": [],\n \"triageReasons\": [],\n \"actions\": [\n \"<string>\"\n ],\n \"workflowIds\": [\n \"<string>\"\n ],\n \"identities\": [\n \"<string>\"\n ],\n \"triggerSources\": [\n \"<string>\"\n ],\n \"projectIds\": [\n \"<string>\"\n ],\n \"refIds\": [\n \"<string>\"\n ],\n \"filePathQuery\": \"<string>\",\n \"createdAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"lastDetectedAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"triagedAt\": {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n },\n \"workflowJobIds\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"issueExport": {
"id": "<string>",
"state": "ISSUE_EXPORT_STATE_PENDING",
"downloadUrl": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"exportedCount": "<string>",
"truncated": true,
"failureReason": "<string>"
}
}This endpoint is experimental. It may change or be removed without notice and is not covered by API stability guarantees.
Authorizations
SemgrepWebTokenSemgrepJWT
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
Body
application/json
Filters for narrowing listed issues. Fields are combined with AND; multiple values within a field are combined with OR.
Show child attributes
Show child attributes
| value | description |
|---|---|
| ISSUE_SORT_FIELD_SEVERITY | |
| ISSUE_SORT_FIELD_LAST_DETECTED_AT | |
| ISSUE_SORT_FIELD_CREATED_AT | |
| ISSUE_SORT_FIELD_FILE_PATH |
Available options:
ISSUE_SORT_FIELD_SEVERITY, ISSUE_SORT_FIELD_LAST_DETECTED_AT, ISSUE_SORT_FIELD_CREATED_AT, ISSUE_SORT_FIELD_FILE_PATH | value | description |
|---|---|
| SORT_DIRECTION_ASC | |
| SORT_DIRECTION_DESC |
Available options:
SORT_DIRECTION_ASC, SORT_DIRECTION_DESC Response
202 - application/json
Accepted
Show child attributes
Show child attributes
Was this page helpful?