Secrets Scanning

Use the REST API to query secrets detection metrics

Table of Contents

• Introduction

• Endpoints

  • Get Secret Events

  • Get Secrets

  • Get Secret Counts By Type

Introduction

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

Get Secret Events

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

Get Secret Events

Returns events after a specified timestamp or event ID. All events are returned if no timestamp or event ID is provided

GET/secrets/events

Query parameters

Response

200400403500

OK

Body

application/json

events*nullable array of ModelsSecretsEventInterface (object)

nextEventId*string

numItems*integer

Request

JavaScriptCurl

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

Response

{
  "events": [
    {
      "id": "text",
      "time": "text",
      "type": "text"
    }
  ],
  "nextEventId": "text"
}

Event types:

• new-finding

• new-findings

• new-allowlisted-finding

• new-allowlisted-findings

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

Get Secrets

This endpoint returns the list of current secrets in the repository.

Get Summary

Returns secrets summary. One unique secret hash per repository

GET/secrets/summary

Query parameters

Response

200400403500

OK

Body

application/json

numItems*integer

secrets*nullable array of ModelsSecretsScannerFindingEvent (object)

Request

JavaScriptCurl

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

Response

{
  "secrets": [
    {
      "author": "text",
      "branches": [
        "text"
      ],
      "commit": "text",
      "entropy": 0,
      "filePath": "text",
      "firstCommitTimestamp": "text",
      "hyperlink": "text",
      "id": "text",
      "isAllowlisted": false,
      "isBranchHead": false,
      "ruleId": "text",
      "secretHash": "text",
      "secretType": "text",
      "timeStamp": "text"
    }
  ]
}

curl -L \
   -H "Accept: application/json" \
   -H "Authorization: Bearer <YOUR-TOKEN>" \
   https://api.nullify.ai/secrets/summary?githubOwnerId=1234&githubRepositoryId=5678

Get Secret Counts By Type

This endpoint returns the count of secrets per type.

Get Latest Counts

Retrieve the latest secret counts broken down by secret type. If no repositoryId is given, counts org wide will be returned

GET/secrets/counts/type/latest

Query parameters

Response

200400403500

OK

Body

application/json

counts*nullable object

Request

JavaScriptCurl

const response = await fetch('/secrets/counts/type/latest', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

curl -L \
   -H "Accept: application/json" \
   -H "Authorization: Bearer <YOUR-TOKEN>" \
   https://api.nullify.ai/secrets/counts/type/latest?githubOwnerId=1234&githubRepositoryId=5678