Book a Demo

Dependency Scanning (SCA)

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

Table of Contents

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.

Base URL

All API endpoints are accessed through the base URL: https://api.<YOUR-TENANT-NAME>.nullify.ai

Replace <YOUR-TENANT-NAME> with your organization's tenant name. For example, if your tenant name is "acme", the base URL would be https://api.acme.nullify.ai.

Get SCA Events

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

Get SCA Events

get

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.

Query parameters
nextTokenstringOptional
limitintegerOptional
fromTimestringOptional
eventTypestring[]Optional
fileOwnerNamestring[]Optional
sortstringOptional
azureOrganizationIdstringOptional

The Azure organization ID

githubOwnerIdintegerOptional

The Github owner ID

gitlabGroupIdintegerOptional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional
githubRepositoryIdinteger[]Optional
githubTeamIdintegerOptional
Responses
200
OK
application/json
get
GET /sca/events HTTP/1.1
Host: api.<YOUR-TENANT>.nullify.com
Accept: */*

{
  "events": [
    {
      "branch": "text",
      "data": null,
      "id": "text",
      "repository": "text",
      "time": "text",
      "timestampUnix": 1,
      "type": "text"
    }
  ],
  "nextToken": "text",
  "numItems": 1
}

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.<YOUR-TENANT-NAME>.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.<YOUR-TENANT-NAME>.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.<YOUR-TENANT-NAME>.nullify.ai/sca/findings/01J6EEXK3NKYKWW9XTPQYAF41N?githubOwnerId=1234
PreviousCode Scanning (SAST)NextSecrets Scanning

Last updated

Was this helpful?