Export Issues

curl --request POST \
  --url https://api.example.com/api/agent/deployments/{deploymentId}/issues/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deploymentId": "<string>",
  "limit": 123,
  "cursor": "<string>",
  "filter": {
    "ids": [
      "<string>"
    ],
    "since": "2023-11-07T05:31:56Z",
    "until": "2023-11-07T05:31:56Z",
    "repositoryNames": [
      "<string>"
    ],
    "repositoryIds": [
      "<string>"
    ],
    "repositoryTags": [
      "<string>"
    ],
    "refs": [
      "<string>"
    ],
    "repositoryRefIds": [
      "<string>"
    ],
    "aiSensitivities": [
      "<string>"
    ],
    "teamNames": [
      "<string>"
    ],
    "policySlugs": [
      "<string>"
    ],
    "rules": [
      "<string>"
    ],
    "ruleIds": [
      "<string>"
    ],
    "rulesets": [
      "<string>"
    ],
    "categories": [
      "<string>"
    ],
    "dependencies": [
      "<string>"
    ],
    "cves": [
      "<string>"
    ],
    "issueParentIds": [
      "<string>"
    ],
    "secretTypes": [
      "<string>"
    ],
    "excludeHistorical": true,
    "onPrimaryBranch": true,
    "includeTicketed": true,
    "aiMemoryWillFlipVerdict": "<string>",
    "aiMemoryReferenced": "<string>",
    "includeAiMemoryRendered": true,
    "aiMemoryRendered": "<string>",
    "memoryIdInScope": "<string>",
    "advisoryIds": [
      "<string>"
    ],
    "filePaths": [
      "<string>"
    ],
    "includeArchived": true
  },
  "includeRemediation": true,
  "includeActivityHistory": true,
  "includeIsArchived": true
}
'

import requests

url = "https://api.example.com/api/agent/deployments/{deploymentId}/issues/export"

payload = {
    "deploymentId": "<string>",
    "limit": 123,
    "cursor": "<string>",
    "filter": {
        "ids": ["<string>"],
        "since": "2023-11-07T05:31:56Z",
        "until": "2023-11-07T05:31:56Z",
        "repositoryNames": ["<string>"],
        "repositoryIds": ["<string>"],
        "repositoryTags": ["<string>"],
        "refs": ["<string>"],
        "repositoryRefIds": ["<string>"],
        "aiSensitivities": ["<string>"],
        "teamNames": ["<string>"],
        "policySlugs": ["<string>"],
        "rules": ["<string>"],
        "ruleIds": ["<string>"],
        "rulesets": ["<string>"],
        "categories": ["<string>"],
        "dependencies": ["<string>"],
        "cves": ["<string>"],
        "issueParentIds": ["<string>"],
        "secretTypes": ["<string>"],
        "excludeHistorical": True,
        "onPrimaryBranch": True,
        "includeTicketed": True,
        "aiMemoryWillFlipVerdict": "<string>",
        "aiMemoryReferenced": "<string>",
        "includeAiMemoryRendered": True,
        "aiMemoryRendered": "<string>",
        "memoryIdInScope": "<string>",
        "advisoryIds": ["<string>"],
        "filePaths": ["<string>"],
        "includeArchived": True
    },
    "includeRemediation": True,
    "includeActivityHistory": True,
    "includeIsArchived": True
}
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>',
    limit: 123,
    cursor: '<string>',
    filter: {
      ids: ['<string>'],
      since: '2023-11-07T05:31:56Z',
      until: '2023-11-07T05:31:56Z',
      repositoryNames: ['<string>'],
      repositoryIds: ['<string>'],
      repositoryTags: ['<string>'],
      refs: ['<string>'],
      repositoryRefIds: ['<string>'],
      aiSensitivities: ['<string>'],
      teamNames: ['<string>'],
      policySlugs: ['<string>'],
      rules: ['<string>'],
      ruleIds: ['<string>'],
      rulesets: ['<string>'],
      categories: ['<string>'],
      dependencies: ['<string>'],
      cves: ['<string>'],
      issueParentIds: ['<string>'],
      secretTypes: ['<string>'],
      excludeHistorical: true,
      onPrimaryBranch: true,
      includeTicketed: true,
      aiMemoryWillFlipVerdict: '<string>',
      aiMemoryReferenced: '<string>',
      includeAiMemoryRendered: true,
      aiMemoryRendered: '<string>',
      memoryIdInScope: '<string>',
      advisoryIds: ['<string>'],
      filePaths: ['<string>'],
      includeArchived: true
    },
    includeRemediation: true,
    includeActivityHistory: true,
    includeIsArchived: true
  })
};

fetch('https://api.example.com/api/agent/deployments/{deploymentId}/issues/export', 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://api.example.com/api/agent/deployments/{deploymentId}/issues/export",
  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>',
    'limit' => 123,
    'cursor' => '<string>',
    'filter' => [
        'ids' => [
                '<string>'
        ],
        'since' => '2023-11-07T05:31:56Z',
        'until' => '2023-11-07T05:31:56Z',
        'repositoryNames' => [
                '<string>'
        ],
        'repositoryIds' => [
                '<string>'
        ],
        'repositoryTags' => [
                '<string>'
        ],
        'refs' => [
                '<string>'
        ],
        'repositoryRefIds' => [
                '<string>'
        ],
        'aiSensitivities' => [
                '<string>'
        ],
        'teamNames' => [
                '<string>'
        ],
        'policySlugs' => [
                '<string>'
        ],
        'rules' => [
                '<string>'
        ],
        'ruleIds' => [
                '<string>'
        ],
        'rulesets' => [
                '<string>'
        ],
        'categories' => [
                '<string>'
        ],
        'dependencies' => [
                '<string>'
        ],
        'cves' => [
                '<string>'
        ],
        'issueParentIds' => [
                '<string>'
        ],
        'secretTypes' => [
                '<string>'
        ],
        'excludeHistorical' => true,
        'onPrimaryBranch' => true,
        'includeTicketed' => true,
        'aiMemoryWillFlipVerdict' => '<string>',
        'aiMemoryReferenced' => '<string>',
        'includeAiMemoryRendered' => true,
        'aiMemoryRendered' => '<string>',
        'memoryIdInScope' => '<string>',
        'advisoryIds' => [
                '<string>'
        ],
        'filePaths' => [
                '<string>'
        ],
        'includeArchived' => true
    ],
    'includeRemediation' => true,
    'includeActivityHistory' => true,
    'includeIsArchived' => true
  ]),
  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://api.example.com/api/agent/deployments/{deploymentId}/issues/export"

	payload := strings.NewReader("{\n  \"deploymentId\": \"<string>\",\n  \"limit\": 123,\n  \"cursor\": \"<string>\",\n  \"filter\": {\n    \"ids\": [\n      \"<string>\"\n    ],\n    \"since\": \"2023-11-07T05:31:56Z\",\n    \"until\": \"2023-11-07T05:31:56Z\",\n    \"repositoryNames\": [\n      \"<string>\"\n    ],\n    \"repositoryIds\": [\n      \"<string>\"\n    ],\n    \"repositoryTags\": [\n      \"<string>\"\n    ],\n    \"refs\": [\n      \"<string>\"\n    ],\n    \"repositoryRefIds\": [\n      \"<string>\"\n    ],\n    \"aiSensitivities\": [\n      \"<string>\"\n    ],\n    \"teamNames\": [\n      \"<string>\"\n    ],\n    \"policySlugs\": [\n      \"<string>\"\n    ],\n    \"rules\": [\n      \"<string>\"\n    ],\n    \"ruleIds\": [\n      \"<string>\"\n    ],\n    \"rulesets\": [\n      \"<string>\"\n    ],\n    \"categories\": [\n      \"<string>\"\n    ],\n    \"dependencies\": [\n      \"<string>\"\n    ],\n    \"cves\": [\n      \"<string>\"\n    ],\n    \"issueParentIds\": [\n      \"<string>\"\n    ],\n    \"secretTypes\": [\n      \"<string>\"\n    ],\n    \"excludeHistorical\": true,\n    \"onPrimaryBranch\": true,\n    \"includeTicketed\": true,\n    \"aiMemoryWillFlipVerdict\": \"<string>\",\n    \"aiMemoryReferenced\": \"<string>\",\n    \"includeAiMemoryRendered\": true,\n    \"aiMemoryRendered\": \"<string>\",\n    \"memoryIdInScope\": \"<string>\",\n    \"advisoryIds\": [\n      \"<string>\"\n    ],\n    \"filePaths\": [\n      \"<string>\"\n    ],\n    \"includeArchived\": true\n  },\n  \"includeRemediation\": true,\n  \"includeActivityHistory\": true,\n  \"includeIsArchived\": true\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://api.example.com/api/agent/deployments/{deploymentId}/issues/export")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"deploymentId\": \"<string>\",\n  \"limit\": 123,\n  \"cursor\": \"<string>\",\n  \"filter\": {\n    \"ids\": [\n      \"<string>\"\n    ],\n    \"since\": \"2023-11-07T05:31:56Z\",\n    \"until\": \"2023-11-07T05:31:56Z\",\n    \"repositoryNames\": [\n      \"<string>\"\n    ],\n    \"repositoryIds\": [\n      \"<string>\"\n    ],\n    \"repositoryTags\": [\n      \"<string>\"\n    ],\n    \"refs\": [\n      \"<string>\"\n    ],\n    \"repositoryRefIds\": [\n      \"<string>\"\n    ],\n    \"aiSensitivities\": [\n      \"<string>\"\n    ],\n    \"teamNames\": [\n      \"<string>\"\n    ],\n    \"policySlugs\": [\n      \"<string>\"\n    ],\n    \"rules\": [\n      \"<string>\"\n    ],\n    \"ruleIds\": [\n      \"<string>\"\n    ],\n    \"rulesets\": [\n      \"<string>\"\n    ],\n    \"categories\": [\n      \"<string>\"\n    ],\n    \"dependencies\": [\n      \"<string>\"\n    ],\n    \"cves\": [\n      \"<string>\"\n    ],\n    \"issueParentIds\": [\n      \"<string>\"\n    ],\n    \"secretTypes\": [\n      \"<string>\"\n    ],\n    \"excludeHistorical\": true,\n    \"onPrimaryBranch\": true,\n    \"includeTicketed\": true,\n    \"aiMemoryWillFlipVerdict\": \"<string>\",\n    \"aiMemoryReferenced\": \"<string>\",\n    \"includeAiMemoryRendered\": true,\n    \"aiMemoryRendered\": \"<string>\",\n    \"memoryIdInScope\": \"<string>\",\n    \"advisoryIds\": [\n      \"<string>\"\n    ],\n    \"filePaths\": [\n      \"<string>\"\n    ],\n    \"includeArchived\": true\n  },\n  \"includeRemediation\": true,\n  \"includeActivityHistory\": true,\n  \"includeIsArchived\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/agent/deployments/{deploymentId}/issues/export")

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  \"limit\": 123,\n  \"cursor\": \"<string>\",\n  \"filter\": {\n    \"ids\": [\n      \"<string>\"\n    ],\n    \"since\": \"2023-11-07T05:31:56Z\",\n    \"until\": \"2023-11-07T05:31:56Z\",\n    \"repositoryNames\": [\n      \"<string>\"\n    ],\n    \"repositoryIds\": [\n      \"<string>\"\n    ],\n    \"repositoryTags\": [\n      \"<string>\"\n    ],\n    \"refs\": [\n      \"<string>\"\n    ],\n    \"repositoryRefIds\": [\n      \"<string>\"\n    ],\n    \"aiSensitivities\": [\n      \"<string>\"\n    ],\n    \"teamNames\": [\n      \"<string>\"\n    ],\n    \"policySlugs\": [\n      \"<string>\"\n    ],\n    \"rules\": [\n      \"<string>\"\n    ],\n    \"ruleIds\": [\n      \"<string>\"\n    ],\n    \"rulesets\": [\n      \"<string>\"\n    ],\n    \"categories\": [\n      \"<string>\"\n    ],\n    \"dependencies\": [\n      \"<string>\"\n    ],\n    \"cves\": [\n      \"<string>\"\n    ],\n    \"issueParentIds\": [\n      \"<string>\"\n    ],\n    \"secretTypes\": [\n      \"<string>\"\n    ],\n    \"excludeHistorical\": true,\n    \"onPrimaryBranch\": true,\n    \"includeTicketed\": true,\n    \"aiMemoryWillFlipVerdict\": \"<string>\",\n    \"aiMemoryReferenced\": \"<string>\",\n    \"includeAiMemoryRendered\": true,\n    \"aiMemoryRendered\": \"<string>\",\n    \"memoryIdInScope\": \"<string>\",\n    \"advisoryIds\": [\n      \"<string>\"\n    ],\n    \"filePaths\": [\n      \"<string>\"\n    ],\n    \"includeArchived\": true\n  },\n  \"includeRemediation\": true,\n  \"includeActivityHistory\": true,\n  \"includeIsArchived\": true\n}"

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

{
  "taskTokenJwt": "<string>"
}

POST

api

agent

deployments

{deploymentId}

issues

export

Export Issues

curl --request POST \
  --url https://api.example.com/api/agent/deployments/{deploymentId}/issues/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deploymentId": "<string>",
  "limit": 123,
  "cursor": "<string>",
  "filter": {
    "ids": [
      "<string>"
    ],
    "since": "2023-11-07T05:31:56Z",
    "until": "2023-11-07T05:31:56Z",
    "repositoryNames": [
      "<string>"
    ],
    "repositoryIds": [
      "<string>"
    ],
    "repositoryTags": [
      "<string>"
    ],
    "refs": [
      "<string>"
    ],
    "repositoryRefIds": [
      "<string>"
    ],
    "aiSensitivities": [
      "<string>"
    ],
    "teamNames": [
      "<string>"
    ],
    "policySlugs": [
      "<string>"
    ],
    "rules": [
      "<string>"
    ],
    "ruleIds": [
      "<string>"
    ],
    "rulesets": [
      "<string>"
    ],
    "categories": [
      "<string>"
    ],
    "dependencies": [
      "<string>"
    ],
    "cves": [
      "<string>"
    ],
    "issueParentIds": [
      "<string>"
    ],
    "secretTypes": [
      "<string>"
    ],
    "excludeHistorical": true,
    "onPrimaryBranch": true,
    "includeTicketed": true,
    "aiMemoryWillFlipVerdict": "<string>",
    "aiMemoryReferenced": "<string>",
    "includeAiMemoryRendered": true,
    "aiMemoryRendered": "<string>",
    "memoryIdInScope": "<string>",
    "advisoryIds": [
      "<string>"
    ],
    "filePaths": [
      "<string>"
    ],
    "includeArchived": true
  },
  "includeRemediation": true,
  "includeActivityHistory": true,
  "includeIsArchived": true
}
'

import requests

url = "https://api.example.com/api/agent/deployments/{deploymentId}/issues/export"

payload = {
    "deploymentId": "<string>",
    "limit": 123,
    "cursor": "<string>",
    "filter": {
        "ids": ["<string>"],
        "since": "2023-11-07T05:31:56Z",
        "until": "2023-11-07T05:31:56Z",
        "repositoryNames": ["<string>"],
        "repositoryIds": ["<string>"],
        "repositoryTags": ["<string>"],
        "refs": ["<string>"],
        "repositoryRefIds": ["<string>"],
        "aiSensitivities": ["<string>"],
        "teamNames": ["<string>"],
        "policySlugs": ["<string>"],
        "rules": ["<string>"],
        "ruleIds": ["<string>"],
        "rulesets": ["<string>"],
        "categories": ["<string>"],
        "dependencies": ["<string>"],
        "cves": ["<string>"],
        "issueParentIds": ["<string>"],
        "secretTypes": ["<string>"],
        "excludeHistorical": True,
        "onPrimaryBranch": True,
        "includeTicketed": True,
        "aiMemoryWillFlipVerdict": "<string>",
        "aiMemoryReferenced": "<string>",
        "includeAiMemoryRendered": True,
        "aiMemoryRendered": "<string>",
        "memoryIdInScope": "<string>",
        "advisoryIds": ["<string>"],
        "filePaths": ["<string>"],
        "includeArchived": True
    },
    "includeRemediation": True,
    "includeActivityHistory": True,
    "includeIsArchived": True
}
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>',
    limit: 123,
    cursor: '<string>',
    filter: {
      ids: ['<string>'],
      since: '2023-11-07T05:31:56Z',
      until: '2023-11-07T05:31:56Z',
      repositoryNames: ['<string>'],
      repositoryIds: ['<string>'],
      repositoryTags: ['<string>'],
      refs: ['<string>'],
      repositoryRefIds: ['<string>'],
      aiSensitivities: ['<string>'],
      teamNames: ['<string>'],
      policySlugs: ['<string>'],
      rules: ['<string>'],
      ruleIds: ['<string>'],
      rulesets: ['<string>'],
      categories: ['<string>'],
      dependencies: ['<string>'],
      cves: ['<string>'],
      issueParentIds: ['<string>'],
      secretTypes: ['<string>'],
      excludeHistorical: true,
      onPrimaryBranch: true,
      includeTicketed: true,
      aiMemoryWillFlipVerdict: '<string>',
      aiMemoryReferenced: '<string>',
      includeAiMemoryRendered: true,
      aiMemoryRendered: '<string>',
      memoryIdInScope: '<string>',
      advisoryIds: ['<string>'],
      filePaths: ['<string>'],
      includeArchived: true
    },
    includeRemediation: true,
    includeActivityHistory: true,
    includeIsArchived: true
  })
};

fetch('https://api.example.com/api/agent/deployments/{deploymentId}/issues/export', 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://api.example.com/api/agent/deployments/{deploymentId}/issues/export",
  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>',
    'limit' => 123,
    'cursor' => '<string>',
    'filter' => [
        'ids' => [
                '<string>'
        ],
        'since' => '2023-11-07T05:31:56Z',
        'until' => '2023-11-07T05:31:56Z',
        'repositoryNames' => [
                '<string>'
        ],
        'repositoryIds' => [
                '<string>'
        ],
        'repositoryTags' => [
                '<string>'
        ],
        'refs' => [
                '<string>'
        ],
        'repositoryRefIds' => [
                '<string>'
        ],
        'aiSensitivities' => [
                '<string>'
        ],
        'teamNames' => [
                '<string>'
        ],
        'policySlugs' => [
                '<string>'
        ],
        'rules' => [
                '<string>'
        ],
        'ruleIds' => [
                '<string>'
        ],
        'rulesets' => [
                '<string>'
        ],
        'categories' => [
                '<string>'
        ],
        'dependencies' => [
                '<string>'
        ],
        'cves' => [
                '<string>'
        ],
        'issueParentIds' => [
                '<string>'
        ],
        'secretTypes' => [
                '<string>'
        ],
        'excludeHistorical' => true,
        'onPrimaryBranch' => true,
        'includeTicketed' => true,
        'aiMemoryWillFlipVerdict' => '<string>',
        'aiMemoryReferenced' => '<string>',
        'includeAiMemoryRendered' => true,
        'aiMemoryRendered' => '<string>',
        'memoryIdInScope' => '<string>',
        'advisoryIds' => [
                '<string>'
        ],
        'filePaths' => [
                '<string>'
        ],
        'includeArchived' => true
    ],
    'includeRemediation' => true,
    'includeActivityHistory' => true,
    'includeIsArchived' => true
  ]),
  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://api.example.com/api/agent/deployments/{deploymentId}/issues/export"

	payload := strings.NewReader("{\n  \"deploymentId\": \"<string>\",\n  \"limit\": 123,\n  \"cursor\": \"<string>\",\n  \"filter\": {\n    \"ids\": [\n      \"<string>\"\n    ],\n    \"since\": \"2023-11-07T05:31:56Z\",\n    \"until\": \"2023-11-07T05:31:56Z\",\n    \"repositoryNames\": [\n      \"<string>\"\n    ],\n    \"repositoryIds\": [\n      \"<string>\"\n    ],\n    \"repositoryTags\": [\n      \"<string>\"\n    ],\n    \"refs\": [\n      \"<string>\"\n    ],\n    \"repositoryRefIds\": [\n      \"<string>\"\n    ],\n    \"aiSensitivities\": [\n      \"<string>\"\n    ],\n    \"teamNames\": [\n      \"<string>\"\n    ],\n    \"policySlugs\": [\n      \"<string>\"\n    ],\n    \"rules\": [\n      \"<string>\"\n    ],\n    \"ruleIds\": [\n      \"<string>\"\n    ],\n    \"rulesets\": [\n      \"<string>\"\n    ],\n    \"categories\": [\n      \"<string>\"\n    ],\n    \"dependencies\": [\n      \"<string>\"\n    ],\n    \"cves\": [\n      \"<string>\"\n    ],\n    \"issueParentIds\": [\n      \"<string>\"\n    ],\n    \"secretTypes\": [\n      \"<string>\"\n    ],\n    \"excludeHistorical\": true,\n    \"onPrimaryBranch\": true,\n    \"includeTicketed\": true,\n    \"aiMemoryWillFlipVerdict\": \"<string>\",\n    \"aiMemoryReferenced\": \"<string>\",\n    \"includeAiMemoryRendered\": true,\n    \"aiMemoryRendered\": \"<string>\",\n    \"memoryIdInScope\": \"<string>\",\n    \"advisoryIds\": [\n      \"<string>\"\n    ],\n    \"filePaths\": [\n      \"<string>\"\n    ],\n    \"includeArchived\": true\n  },\n  \"includeRemediation\": true,\n  \"includeActivityHistory\": true,\n  \"includeIsArchived\": true\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://api.example.com/api/agent/deployments/{deploymentId}/issues/export")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"deploymentId\": \"<string>\",\n  \"limit\": 123,\n  \"cursor\": \"<string>\",\n  \"filter\": {\n    \"ids\": [\n      \"<string>\"\n    ],\n    \"since\": \"2023-11-07T05:31:56Z\",\n    \"until\": \"2023-11-07T05:31:56Z\",\n    \"repositoryNames\": [\n      \"<string>\"\n    ],\n    \"repositoryIds\": [\n      \"<string>\"\n    ],\n    \"repositoryTags\": [\n      \"<string>\"\n    ],\n    \"refs\": [\n      \"<string>\"\n    ],\n    \"repositoryRefIds\": [\n      \"<string>\"\n    ],\n    \"aiSensitivities\": [\n      \"<string>\"\n    ],\n    \"teamNames\": [\n      \"<string>\"\n    ],\n    \"policySlugs\": [\n      \"<string>\"\n    ],\n    \"rules\": [\n      \"<string>\"\n    ],\n    \"ruleIds\": [\n      \"<string>\"\n    ],\n    \"rulesets\": [\n      \"<string>\"\n    ],\n    \"categories\": [\n      \"<string>\"\n    ],\n    \"dependencies\": [\n      \"<string>\"\n    ],\n    \"cves\": [\n      \"<string>\"\n    ],\n    \"issueParentIds\": [\n      \"<string>\"\n    ],\n    \"secretTypes\": [\n      \"<string>\"\n    ],\n    \"excludeHistorical\": true,\n    \"onPrimaryBranch\": true,\n    \"includeTicketed\": true,\n    \"aiMemoryWillFlipVerdict\": \"<string>\",\n    \"aiMemoryReferenced\": \"<string>\",\n    \"includeAiMemoryRendered\": true,\n    \"aiMemoryRendered\": \"<string>\",\n    \"memoryIdInScope\": \"<string>\",\n    \"advisoryIds\": [\n      \"<string>\"\n    ],\n    \"filePaths\": [\n      \"<string>\"\n    ],\n    \"includeArchived\": true\n  },\n  \"includeRemediation\": true,\n  \"includeActivityHistory\": true,\n  \"includeIsArchived\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/agent/deployments/{deploymentId}/issues/export")

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  \"limit\": 123,\n  \"cursor\": \"<string>\",\n  \"filter\": {\n    \"ids\": [\n      \"<string>\"\n    ],\n    \"since\": \"2023-11-07T05:31:56Z\",\n    \"until\": \"2023-11-07T05:31:56Z\",\n    \"repositoryNames\": [\n      \"<string>\"\n    ],\n    \"repositoryIds\": [\n      \"<string>\"\n    ],\n    \"repositoryTags\": [\n      \"<string>\"\n    ],\n    \"refs\": [\n      \"<string>\"\n    ],\n    \"repositoryRefIds\": [\n      \"<string>\"\n    ],\n    \"aiSensitivities\": [\n      \"<string>\"\n    ],\n    \"teamNames\": [\n      \"<string>\"\n    ],\n    \"policySlugs\": [\n      \"<string>\"\n    ],\n    \"rules\": [\n      \"<string>\"\n    ],\n    \"ruleIds\": [\n      \"<string>\"\n    ],\n    \"rulesets\": [\n      \"<string>\"\n    ],\n    \"categories\": [\n      \"<string>\"\n    ],\n    \"dependencies\": [\n      \"<string>\"\n    ],\n    \"cves\": [\n      \"<string>\"\n    ],\n    \"issueParentIds\": [\n      \"<string>\"\n    ],\n    \"secretTypes\": [\n      \"<string>\"\n    ],\n    \"excludeHistorical\": true,\n    \"onPrimaryBranch\": true,\n    \"includeTicketed\": true,\n    \"aiMemoryWillFlipVerdict\": \"<string>\",\n    \"aiMemoryReferenced\": \"<string>\",\n    \"includeAiMemoryRendered\": true,\n    \"aiMemoryRendered\": \"<string>\",\n    \"memoryIdInScope\": \"<string>\",\n    \"advisoryIds\": [\n      \"<string>\"\n    ],\n    \"filePaths\": [\n      \"<string>\"\n    ],\n    \"includeArchived\": true\n  },\n  \"includeRemediation\": true,\n  \"includeActivityHistory\": true,\n  \"includeIsArchived\": true\n}"

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

{
  "taskTokenJwt": "<string>"
}

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

required

Specifies the deployment to which the issues belong.

Body

application/json

deploymentId

string

Specifies the deployment to which the issues belong.

issueType

enum<string>

Deprecated: use issue_types instead. Filters issues to those with the specified type.

value	description
ISSUE_TYPE_SAST	Detected by Code rules
ISSUE_TYPE_SCA	Detected by Supply Chain rules
ISSUE_TYPE_SECRETS	Detected by Secrets rules
ISSUE_TYPE_RESEARCH	Detected by research rules or scanners
ISSUE_TYPE_AI_SAST	Detected by AI detection code scanning

Available options:

ISSUE_TYPE_SAST,

ISSUE_TYPE_SCA,

ISSUE_TYPE_SECRETS,

ISSUE_TYPE_RESEARCH,

ISSUE_TYPE_AI_SAST

sortBy

enum<string>

Specifies the field to sort the results by.

value	description
SORT_BY_SEVERITY
SORT_BY_REF
SORT_BY_REPO
SORT_BY_RULE
SORT_BY_RELEVANT_SINCE
SORT_BY_STATE

Available options:

SORT_BY_SEVERITY,

SORT_BY_REF,

SORT_BY_REPO,

SORT_BY_RULE,

SORT_BY_RELEVANT_SINCE,

SORT_BY_STATE

sortDirection

enum<string>

Specifies the direction to sort the results.

value	description
SORT_DIRECTION_ASC
SORT_DIRECTION_DESC

Available options:

SORT_DIRECTION_ASC,

SORT_DIRECTION_DESC

limit

integer<int64>

Sets the page size of the paginated list of issues.

cursor

string

Cursor used for pagination -- passing no value or an empty string effectively requests the first page.

filter

object

Filters the issues to list.

Show child attributes

issueTypes

enum<string>[]

Filters issues to those with any of the specified types (based on the product which produced these issues). When empty, falls back to the deprecated issue_type field for backward compatibility.

value	description
ISSUE_TYPE_SAST	Detected by Code rules
ISSUE_TYPE_SCA	Detected by Supply Chain rules
ISSUE_TYPE_SECRETS	Detected by Secrets rules
ISSUE_TYPE_RESEARCH	Detected by research rules or scanners
ISSUE_TYPE_AI_SAST	Detected by AI detection code scanning

Available options:

ISSUE_TYPE_UNSPECIFIED,

ISSUE_TYPE_SAST,

ISSUE_TYPE_SCA,

ISSUE_TYPE_SECRETS,

ISSUE_TYPE_RESEARCH,

ISSUE_TYPE_AI_SAST

includeRemediation

boolean

When true, include AI remediation info (autofix and guidance) for each issue in the response. Defaults to false.

includeActivityHistory

boolean

When true, include activity history (status changes, triage events, etc.) for each issue in the response. Defaults to false.

includeIsArchived

boolean

When true, populate the is_archived field on each issue in the response. Defaults to false.

Response

202 - application/json

Accepted

taskTokenJwt

string

List Issues List Issue Groups

⌘I

Overview

Endpoints

Export Issues

Authorizations

Path Parameters

Body

Response