Dependency Scanning (SCA)

Use the REST API to query dependency scanning (SCA) metrics

Table of Contents

• Introduction

• Endpoints

  • Get SCA Events

  • List SCA Vulnerabilities

  • Get SCA Finding

Introduction

The SCA API provides a RESTful interface for querying various metrics related to Dependency scanning findings and events. It offers endpoints to retrieve information about about SCA findings, events, and counts.

Get SCA Events

This endpoint returns the list of events that have occurred related to dependency findings.

Get SCA Events

Returns SCA events after a specified timestamp or event ID. All events are returned if no timestamp or event ID is provided. A maximum of 100 events can be returned per request.

GET/sca/events

Query parameters

Response

200400403500

OK

Body

application/json

events*nullable array of ModelsSCAEventInterface (object)

nextToken*string

numItems*integer

Request

JavaScriptCurlPython

const response = await fetch('/sca/events', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400403500

{
  "events": [
    {
      "branch": "text",
      "id": "text",
      "repository": "text",
      "time": "text",
      "type": "text"
    }
  ],
  "nextToken": "text"
}

Event types:

• new-branch-summary

• new-finding new-findings

• new-fix

• new-fixes

• new-allowlisted-finding

• new-allowlisted-findings

• new-pull-request-finding

• new-pull-request-findings

• new-pull-request-fix

• new-pull-request-fixes

curl -L \
   -H "Accept: application/json" \
   -H "Authorization: Bearer <YOUR-TOKEN>" \
   https://api.nullify.ai/sca/events?githubOwnerId=1234

List SCA Findings

This endpoint returns the list of current vulnerabilities in dependencies.

curl -L \
   -H "Accept: application/json" \
   -H "Authorization: Bearer <YOUR-TOKEN>" \
   https://api.nullify.ai/sca/findings?githubOwnerId=1234

Get SCA Finding

This endpoint returns the details of an SCA finding

curl -L \
   -H "Accept: application/json" \
   -H "Authorization: Bearer <YOUR-TOKEN>" \
   https://api.nullify.ai/sca/findings/01J6EEXK3NKYKWW9XTPQYAF41N?githubOwnerId=1234