Skip to main content
POST
/
api
/
v1
/
sca
/
alerts
/
search
List SCA alerts
curl --request POST \
  --url https://zeropath.com/api/v1/sca/alerts/search \
  --header 'Content-Type: application/json' \
  --header 'X-ZeroPath-API-Token-Id: <api-key>' \
  --header 'X-ZeroPath-API-Token-Secret: <api-key>' \
  --data '{
  "organizationId": "<string>",
  "repositoryIds": [
    "<string>"
  ],
  "page": 1,
  "pageSize": 50,
  "query": "<string>",
  "languages": [
    "<string>"
  ],
  "severities": [
    "critical"
  ],
  "reachability": [
    "reachable"
  ]
}'
{
  "alerts": [
    {
      "id": "<string>",
      "isAlerted": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "metadata": {
        "id": "<string>",
        "packageIdentifier": "<string>",
        "aliases": [
          "<string>"
        ],
        "references": [
          "<string>"
        ],
        "summary": "<string>",
        "description": "<string>",
        "severityScore": 123,
        "severity": "critical"
      },
      "languages": [
        "<string>"
      ],
      "reachabilityCounts": {
        "reachable": 123,
        "needsReview": 123,
        "unreachable": 123
      }
    }
  ],
  "totalCount": 123,
  "page": 123,
  "pageSize": 123
}

Authorizations

​
X-ZeroPath-API-Token-Id
string
header
required
​
X-ZeroPath-API-Token-Secret
string
header
required

Body

application/json
​
organizationId
string
​
repositoryIds
string[]
​
page
integer
default:1
Required range: x >= 1
​
pageSize
integer
default:50
Required range: x >= 1
​
query
string

Filter by advisory identifier, aliases, or title

​
languages
string[]

Filter by programming languages associated with reachability

​
severities
enum<string>[]
​
reachability
enum<string>[]

Reachability classification for grouped issues

Response

Successful response

​
alerts
object[]
​
totalCount
integer
​
page
integer
​
pageSize
integer