Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Dependencies and SBOMs

Read the dependency inventory that Context builds from SBOMs, and generate, replay or delete the SBOMs behind it.

How dependency data is organised

Context stores a dependency inventory per repository and project. Each dependency is recorded as an occurrence with an exposure window: when it entered the project and, if it has been removed, when it left. Three views are available. Active calls return what is in the project now (at its latest commit). The at-commit and diff calls evaluate a project at a commit's timestamp. History and exposure calls return the windows during which a package version was present. Always keep the repositoryId, projectId and commit with any result you compare; take repositoryId and projectId from List projects. The /deps list calls page with cursor and pageSize and return nextCursor; pass it back as cursor to continue (this is not the nextToken scheme in Pagination). Except where noted, these reads need a valid tenant token and no extra permission.

Tenant-wide dependencies

List active dependencies

Returns the dependencies currently active across every repository and project in your tenant, with optional filters: search (free text), ecosystem, name, direct (true for direct dependencies only), repositoryId, projectId, and range (a version filter, semver range or hash). Page with cursor and pageSize.

curl -s \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <TOKEN>" \
  'https://api.<TENANT>.nullify.ai/context/deps/active?ecosystem=npm&name=lodash&pageSize=50'

List Tenant Wide Active Dependencies

get

Returns dependencies that are active across all repositories/projects.

Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

pageSizeinteger · int32Optional
cursorstringOptional
searchstringOptional
ecosystemstringOptional
namestringOptional
directboolean · nullableOptional
repositoryIdstringOptional
projectIdstringOptional
rangestringOptional
Responses
200

OK

application/json
nextCursorstringRequired
numItemsintegerRequired
versionstringRequired
get/context/deps/active
GET /context/deps/active HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "dependencies": [
    {
      "bomRef": "text",
      "depth": 1,
      "direct": true,
      "ecosystem": "text",
      "introducedAt": "2026-01-01T00:00:00.000Z",
      "introducedByCommit": "text",
      "name": "text",
      "parents": [
        "text"
      ],
      "projectId": "text",
      "projectName": "text",
      "purl": "text",
      "rangeUnverified": true,
      "removedAt": "2026-01-01T00:00:00.000Z",
      "removedByCommit": "text",
      "repoId": "text",
      "repositoryName": "text",
      "requestedRange": "text",
      "requestedRangeSource": "text",
      "version": "text"
    }
  ],
  "nextCursor": "text",
  "numItems": 1,
  "version": "text"
}

Summarize active dependencies

Returns aggregate counts and the oldest active dependency across the tenant. It accepts the same filters as the active list (search, ecosystem, name, direct, repositoryId, projectId, range), so the counts match the rows the same filters return.

Tenant Wide Active Dependency Summary

get

Returns aggregate counts and the oldest active dependency across all repositories/projects, search-aware.

Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

searchstringOptional
ecosystemstringOptional
namestringOptional
directboolean · nullableOptional
repositoryIdstringOptional
projectIdstringOptional
rangestringOptional
Responses
200

OK

application/json
directCountinteger · int64Required
totalCountinteger · int64Required
transitiveCountinteger · int64Required
versionstringRequired
get/context/deps/active/summary
GET /context/deps/active/summary HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "directCount": 1,
  "oldest": {
    "ecosystem": "text",
    "introducedAt": "2026-01-01T00:00:00.000Z",
    "name": "text",
    "version": "text"
  },
  "totalCount": 1,
  "transitiveCount": 1,
  "version": "text"
}

List dependency history

Returns dependency occurrences, including ones that have since been removed, across all repositories and projects, with their exposure windows. Requires the ConfigRead permission. Page with cursor and pageSize.

List Tenant Wide Dependencies (Historical)

get

Returns dependency history across all repositories/projects.

Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

pageSizeinteger · int32Optional
cursorstringOptional
Responses
200

OK

application/json
nextCursorstringRequired
numItemsintegerRequired
versionstringRequired
get/context/deps
GET /context/deps HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "dependencies": [
    {
      "bomRef": "text",
      "depth": 1,
      "direct": true,
      "ecosystem": "text",
      "introducedAt": "2026-01-01T00:00:00.000Z",
      "introducedByCommit": "text",
      "name": "text",
      "parents": [
        "text"
      ],
      "projectId": "text",
      "projectName": "text",
      "purl": "text",
      "rangeUnverified": true,
      "removedAt": "2026-01-01T00:00:00.000Z",
      "removedByCommit": "text",
      "repoId": "text",
      "repositoryName": "text",
      "requestedRange": "text",
      "requestedRangeSource": "text",
      "version": "text"
    }
  ],
  "nextCursor": "text",
  "numItems": 1,
  "version": "text"
}

Find package exposure across the tenant

Returns the exposure windows for one package across all repositories and projects that intersect a version filter. ecosystem, name and range are all required; range is a semver range such as >=1.2.0 <2.0.0 or a hash. Use it to answer which projects have used an affected version and when.

Global package exposure by version filter (semver or hash)

get

Returns exposure windows across all repositories/projects intersecting a version filter (server-side filtering).

Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

ecosystemstringOptional
namestringOptional
rangestringOptional
Responses
200

OK

application/json
numItemsintegerRequired
versionstringRequired
get/context/deps/exposure
GET /context/deps/exposure HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "numItems": 1,
  "version": "text",
  "windows": [
    {
      "ecosystem": "text",
      "fromCommit": "text",
      "fromTime": "2026-01-01T00:00:00.000Z",
      "isArchived": true,
      "lastScannedAt": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "projectId": "text",
      "projectName": "text",
      "repoId": "text",
      "repositoryName": "text",
      "resolvedWithoutLockfile": true,
      "toCommit": "text",
      "toTime": "2026-01-01T00:00:00.000Z",
      "version": "text"
    }
  ]
}

List dependencies without a lockfile

Returns projects, or repositories with level=repository, whose dependencies were resolved without a committed lockfile. level defaults to project. These are exposed to version drift during supply chain incidents because the resolved versions are not pinned. Requires the ConfigRead permission.

List projects/repos without lockfiles

get

Returns projects or repositories whose dependencies were resolved without a committed lockfile. These are at higher risk during supply chain incidents.

Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

levelstringOptional
Responses
200

OK

application/json
versionstringOptional
get/context/deps/without-lockfile
GET /context/deps/without-lockfile HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "projects": [
    {
      "ecosystem": "text",
      "projectId": "text",
      "projectName": "text",
      "repositoryId": "text",
      "repositoryName": "text"
    }
  ],
  "repositories": [
    {
      "depCount": 1,
      "ecosystems": [
        "text"
      ],
      "projectCount": 1,
      "repositoryId": "text",
      "repositoryName": "text"
    }
  ],
  "version": "text"
}

Walking the dependency graph

Each occurrence carries the SBOM bom-ref of its component. A bom-ref is unique within a project but can repeat across projects, so these reads return lists and page with cursor and pageSize.

Get dependencies by bom-ref

Returns the active occurrences whose SBOM bom-ref matches bomRef.

Get Dependencies by Bom Ref

get

Returns active dependency occurrences whose SBOM bom-ref matches. A bom-ref is unique within a project but can repeat across projects, so the result is a list.

Path parameters
bomRefstringRequired
Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

pageSizeinteger · int32Optional
cursorstringOptional
Responses
200

OK

application/json
nextCursorstringRequired
numItemsintegerRequired
versionstringRequired
get/context/deps/by-ref/{bomRef}
GET /context/deps/by-ref/{bomRef} HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "dependencies": [
    {
      "bomRef": "text",
      "depth": 1,
      "direct": true,
      "ecosystem": "text",
      "introducedAt": "2026-01-01T00:00:00.000Z",
      "introducedByCommit": "text",
      "name": "text",
      "parents": [
        "text"
      ],
      "projectId": "text",
      "projectName": "text",
      "purl": "text",
      "rangeUnverified": true,
      "removedAt": "2026-01-01T00:00:00.000Z",
      "removedByCommit": "text",
      "repoId": "text",
      "repositoryName": "text",
      "requestedRange": "text",
      "requestedRangeSource": "text",
      "version": "text"
    }
  ],
  "nextCursor": "text",
  "numItems": 1,
  "version": "text"
}

List dependents of a bom-ref

Returns the active occurrences whose parents include bomRef, which are its immediate dependents. Call it recursively on each result to walk the downstream subtree.

List Dependents of a Bom Ref

get

Returns active dependency occurrences whose parent chain includes the given bom-ref. Walk recursively to traverse the downstream dependency subtree.

Path parameters
bomRefstringRequired
Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

pageSizeinteger · int32Optional
cursorstringOptional
Responses
200

OK

application/json
nextCursorstringRequired
numItemsintegerRequired
versionstringRequired
get/context/deps/dependents/{bomRef}
GET /context/deps/dependents/{bomRef} HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "dependencies": [
    {
      "bomRef": "text",
      "depth": 1,
      "direct": true,
      "ecosystem": "text",
      "introducedAt": "2026-01-01T00:00:00.000Z",
      "introducedByCommit": "text",
      "name": "text",
      "parents": [
        "text"
      ],
      "projectId": "text",
      "projectName": "text",
      "purl": "text",
      "rangeUnverified": true,
      "removedAt": "2026-01-01T00:00:00.000Z",
      "removedByCommit": "text",
      "repoId": "text",
      "repositoryName": "text",
      "requestedRange": "text",
      "requestedRangeSource": "text",
      "version": "text"
    }
  ],
  "nextCursor": "text",
  "numItems": 1,
  "version": "text"
}

Per-project dependencies

List a project's active dependencies

Returns the dependencies active at the project's latest commit. Filter with search, ecosystem and direct.

List Active Dependencies

get

Returns dependencies that are active for the latest commit.

Path parameters
repositoryIdstringRequired
projectIdstringRequired
Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

searchstringOptional
ecosystemstringOptional
directboolean · nullableOptional
Responses
200

OK

application/json
numItemsintegerRequired
versionstringRequired
get/context/deps/repository/{repositoryId}/project/{projectId}/active
GET /context/deps/repository/{repositoryId}/project/{projectId}/active HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "dependencies": [
    {
      "bomRef": "text",
      "depth": 1,
      "direct": true,
      "ecosystem": "text",
      "introducedAt": "2026-01-01T00:00:00.000Z",
      "introducedByCommit": "text",
      "name": "text",
      "parents": [
        "text"
      ],
      "projectId": "text",
      "projectName": "text",
      "purl": "text",
      "rangeUnverified": true,
      "removedAt": "2026-01-01T00:00:00.000Z",
      "removedByCommit": "text",
      "repoId": "text",
      "repositoryName": "text",
      "requestedRange": "text",
      "requestedRangeSource": "text",
      "version": "text"
    }
  ],
  "numItems": 1,
  "version": "text"
}

Get dependencies at a commit

Returns the dependencies that were present at the given commit. The commit must have a stored SBOM for the project: its commit timestamp is read from that SBOM and used to evaluate the inventory at that moment, and the response includes commitTime. A commit without a stored SBOM is an error.

Dependencies at commit

get

Returns dependencies exposed at the specified commit (resolved to commit timestamp).

Path parameters
repositoryIdstringRequired
projectIdstringRequired
commitstringRequired
Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

Responses
200

OK

application/json
commitTimestampstring · date-timeRequired
numItemsintegerRequired
versionstringRequired
get/context/deps/repository/{repositoryId}/project/{projectId}/at/{commit}
GET /context/deps/repository/{repositoryId}/project/{projectId}/at/{commit} HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "commitTimestamp": "2026-01-01T00:00:00.000Z",
  "dependencies": [
    {
      "bomRef": "text",
      "depth": 1,
      "direct": true,
      "ecosystem": "text",
      "introducedAt": "2026-01-01T00:00:00.000Z",
      "introducedByCommit": "text",
      "name": "text",
      "parents": [
        "text"
      ],
      "projectId": "text",
      "projectName": "text",
      "purl": "text",
      "rangeUnverified": true,
      "removedAt": "2026-01-01T00:00:00.000Z",
      "removedByCommit": "text",
      "repoId": "text",
      "repositoryName": "text",
      "requestedRange": "text",
      "requestedRangeSource": "text",
      "version": "text"
    }
  ],
  "numItems": 1,
  "version": "text"
}

Diff dependencies between commits

Returns packages added, removed and upgraded between fromCommit and toCommit, both of which need stored SBOMs. If fromCommit is omitted the project's earliest stored SBOM is used; if toCommit is omitted the latest is used, and in that case the packages that were present at the start are also reported as added. A toCommit that is older than fromCommit is rejected as an invalid argument.

Dependency diff between two commits

get

Computes added, removed, upgraded, and downgraded packages by comparing dependency snapshots at the two commit timestamps.

Path parameters
repositoryIdstringRequired
projectIdstringRequired
Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

fromCommitstring · nullableOptional
toCommitstring · nullableOptional
Responses
200

OK

application/json
numItemsintegerRequired
versionstringRequired
get/context/deps/repository/{repositoryId}/project/{projectId}/diff
GET /context/deps/repository/{repositoryId}/project/{projectId}/diff HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "diff": {
    "added": [
      {
        "bomRef": "text",
        "depth": 1,
        "direct": true,
        "ecosystem": "text",
        "introducedAt": "2026-01-01T00:00:00.000Z",
        "introducedByCommit": "text",
        "name": "text",
        "parents": [
          "text"
        ],
        "projectId": "text",
        "projectName": "text",
        "purl": "text",
        "rangeUnverified": true,
        "removedAt": "2026-01-01T00:00:00.000Z",
        "removedByCommit": "text",
        "repoId": "text",
        "repositoryName": "text",
        "requestedRange": "text",
        "requestedRangeSource": "text",
        "version": "text"
      }
    ],
    "downgraded": [
      {
        "ecosystem": "text",
        "from": "text",
        "fromCommit": "text",
        "name": "text",
        "projectId": "text",
        "projectName": "text",
        "repoId": "text",
        "repositoryName": "text",
        "to": "text"
      }
    ],
    "removed": [
      {
        "bomRef": "text",
        "depth": 1,
        "direct": true,
        "ecosystem": "text",
        "introducedAt": "2026-01-01T00:00:00.000Z",
        "introducedByCommit": "text",
        "name": "text",
        "parents": [
          "text"
        ],
        "projectId": "text",
        "projectName": "text",
        "purl": "text",
        "rangeUnverified": true,
        "removedAt": "2026-01-01T00:00:00.000Z",
        "removedByCommit": "text",
        "repoId": "text",
        "repositoryName": "text",
        "requestedRange": "text",
        "requestedRangeSource": "text",
        "version": "text"
      }
    ],
    "upgraded": [
      {
        "ecosystem": "text",
        "from": "text",
        "fromCommit": "text",
        "name": "text",
        "projectId": "text",
        "projectName": "text",
        "repoId": "text",
        "repositoryName": "text",
        "to": "text"
      }
    ]
  },
  "numItems": 1,
  "version": "text"
}

Get package history in a project

Returns the exposure windows for one package, grouped by version, within the project. ecosystem and name are required.

Package exposure history (windows)

get

Returns exposure windows for a given package (ecosystem+name), grouped by version.

Path parameters
repositoryIdstringRequired
projectIdstringRequired
Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

ecosystemstringOptional
namestringOptional
Responses
200

OK

application/json
numItemsintegerRequired
versionstringRequired
get/context/deps/repository/{repositoryId}/project/{projectId}/history
GET /context/deps/repository/{repositoryId}/project/{projectId}/history HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "numItems": 1,
  "version": "text",
  "windows": [
    {
      "ecosystem": "text",
      "fromCommit": "text",
      "fromTime": "2026-01-01T00:00:00.000Z",
      "isArchived": true,
      "lastScannedAt": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "projectId": "text",
      "projectName": "text",
      "repoId": "text",
      "repositoryName": "text",
      "resolvedWithoutLockfile": true,
      "toCommit": "text",
      "toTime": "2026-01-01T00:00:00.000Z",
      "version": "text"
    }
  ]
}

Find package exposure in a project

Like the tenant-wide exposure call but limited to one project: returns windows for the package that intersect range. ecosystem, name and range are required.

Project package exposure by version filter (semver or hash)

get

Returns exposure windows for a repo/project intersecting a version filter (server-side filtering).

Path parameters
repositoryIdstringRequired
projectIdstringRequired
Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

ecosystemstringOptional
namestringOptional
rangestringOptional
Responses
200

OK

application/json
numItemsintegerRequired
versionstringRequired
get/context/deps/repository/{repositoryId}/project/{projectId}/exposure
GET /context/deps/repository/{repositoryId}/project/{projectId}/exposure HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "numItems": 1,
  "version": "text",
  "windows": [
    {
      "ecosystem": "text",
      "fromCommit": "text",
      "fromTime": "2026-01-01T00:00:00.000Z",
      "isArchived": true,
      "lastScannedAt": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "projectId": "text",
      "projectName": "text",
      "repoId": "text",
      "repositoryName": "text",
      "resolvedWithoutLockfile": true,
      "toCommit": "text",
      "toTime": "2026-01-01T00:00:00.000Z",
      "version": "text"
    }
  ]
}

Delete dependency data

Permanently deletes dependency occurrence records. The scope depends on which query parameters you send. Supply repositoryId, projectId, ecosystem, name, version and introducedAt (RFC 3339) to delete one entry; supply only repositoryId and projectId to delete everything for a project; supply no selectors and global=true to delete every dependency record in the tenant. Any other combination, or a tenant-wide delete without global=true, returns 400. The response reports the scope (entry, project or tenant) and deletedCount. This call needs only a valid tenant token, not ConfigWrite. Deletion cannot be undone here; the inventory is rebuilt only when SBOMs are ingested again (see Replay SBOM ingestion).

Delete dependency data

delete

Deletes dependency occurrence records. Scope is inferred from query parameters: single entry (repo+project+ecosystem+name+version+introducedAt), project-wide (repo+project), or tenant-wide (no selectors, global=true).

Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

repositoryIdstring · nullableOptional
projectIdstring · nullableOptional
ecosystemstring · nullableOptional
namestring · nullableOptional
versionstring · nullableOptional
introducedAtstring · nullableOptional
globalboolean · nullableOptional
Responses
200

OK

application/json
deletedCountintegerOptional
scopestringOptional
versionstringRequired
delete/context/deps
DELETE /context/deps HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "deletedCount": 1,
  "scope": "text",
  "version": "text"
}

SBOMs

A software bill of materials (SBOM) is the CycloneDX document that records a project's components at a commit. SBOMs are stored per tenant, repository, project and commit. The reads below list what is stored; the write operations start generation as background work.

Get the SBOM tree

Returns a tree of the tenant's stored SBOMs by repository, project and commit. Pass verbose=true to include repository and project names. Requires the ConfigRead permission.

Get SBOM key tree for tenant

get

Returns a tree structure of SBOM (software bill of materials) items for a tenant. Commits are paginated in time order. Add optional verbose=true query parameter to include repository and project names.

Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

verbosebooleanOptional
Responses
200

OK

application/json
tenantIdstringRequired
tenantNamestringOptional
versionstringOptional
get/context/sboms/tree
GET /context/sboms/tree HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "repositories": [
    {
      "projects": [
        {
          "commits": [
            "text"
          ],
          "projectId": "text",
          "projectName": "text"
        }
      ],
      "repositoryId": "text",
      "repositoryName": "text"
    }
  ],
  "tenantId": "text",
  "tenantName": "text",
  "version": "text"
}

Get the latest SBOMs for a repository

Returns the most recent SBOM of each project in the repository. Requires ConfigRead.

Get Latest SBOMs for Repository

get

Returns the most recent SBOM for each project within a repository.

Path parameters
repositoryIdstringRequired
Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

Responses
200

OK

application/json
versionstringOptional
get/context/sboms/repository/{repositoryId}/latest
GET /context/sboms/repository/{repositoryId}/latest HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "sboms": [
    {
      "authoritative": true,
      "authorityRevision": 1,
      "carryCount": 1,
      "cdxGen": {
        "bomFormat": "text",
        "components": [
          {
            "author": "text",
            "bom-ref": "text",
            "description": "text",
            "externalReferences": [
              {
                "type": "text",
                "url": "text"
              }
            ],
            "group": "text",
            "hashes": [
              {
                "alg": "text",
                "content": "text"
              }
            ],
            "licenses": [
              {
                "expression": "text",
                "license": {
                  "id": "text",
                  "url": "text"
                }
              }
            ],
            "name": "text",
            "properties": [
              {
                "name": "text",
                "value": "text"
              }
            ],
            "publisher": "text",
            "purl": "text",
            "scope": "text",
            "type": "text",
            "version": "text"
          }
        ],
        "dependencies": [
          {
            "dependsOn": [
              "text"
            ],
            "ref": "text"
          }
        ],
        "metadata": {
          "authors": [
            {
              "email": "text",
              "name": "text"
            }
          ],
          "component": {
            "author": "text",
            "bom-ref": "text",
            "description": "text",
            "externalReferences": [
              {
                "type": "text",
                "url": "text"
              }
            ],
            "group": "text",
            "hashes": [
              {
                "alg": "text",
                "content": "text"
              }
            ],
            "licenses": [
              {
                "expression": "text",
                "license": {
                  "id": "text",
                  "url": "text"
                }
              }
            ],
            "name": "text",
            "properties": [
              {
                "name": "text",
                "value": "text"
              }
            ],
            "publisher": "text",
            "purl": "text",
            "scope": "text",
            "type": "text",
            "version": "text"
          },
          "timestamp": "2026-01-01T00:00:00.000Z",
          "tools": {
            "ANY_ADDITIONAL_PROPERTY": [
              {
                "group": "text",
                "name": "text",
                "version": "text"
              }
            ]
          }
        },
        "serialNumber": "text",
        "services": [
          {
            "bom-ref": "text",
            "endpoints": [
              "text"
            ],
            "group": "text",
            "name": "text",
            "provider": "text",
            "version": "text"
          }
        ],
        "specVersion": "text",
        "version": 1
      },
      "commitSha": "text",
      "commitTimestamp": "2026-01-01T00:00:00.000Z",
      "completenessRecorded": true,
      "detectedEcosystems": [
        "text"
      ],
      "detectedLockfiles": [
        "text"
      ],
      "detectedManifests": [
        "text"
      ],
      "empty": true,
      "exclusions": [
        {
          "dir": "text",
          "ecosystems": [
            "text"
          ],
          "path": "text",
          "reason": "text"
        }
      ],
      "failedEcosystems": [
        "text"
      ],
      "failureClass": "oom",
      "failureReason": "text",
      "generatedAt": "2026-01-01T00:00:00.000Z",
      "incomplete": true,
      "incompleteScopes": [
        {
          "dir": "text",
          "ecosystems": [
            "text"
          ],
          "path": "text",
          "reason": "text"
        }
      ],
      "lockfileClassification": "text",
      "lockfileSetHash": "text",
      "manifestRangeSources": {
        "ANY_ADDITIONAL_PROPERTY": {
          "filePath": "text",
          "range": "text"
        }
      },
      "manifestRanges": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "packageAuth": [
        {
          "credential": "rejected",
          "dir": "text",
          "ecosystem": "text",
          "evidence": "text",
          "registry": "text",
          "tool": "text",
          "version": 1
        }
      ],
      "provenance": {
        "backend": "text",
        "cdxgenVersion": "text",
        "imageDigest": "text",
        "sandboxJobId": "text"
      },
      "repoContextCommitSha": "text",
      "repoContextStaleReason": "text",
      "repoContextVersion": "text",
      "scanScope": {
        "exclude": [
          "text"
        ],
        "include": [
          "text"
        ]
      },
      "scannerVersion": "text"
    }
  ],
  "version": "text"
}

List SBOMs for a project

Returns SBOMs for a repository and project, newest first. Page with page and pageSize (default: the 100 most recent), or select a range with fromCommit/untilCommit or fromTime/untilTime; a commit range cannot be combined with a time range. Setting fromCommit and untilCommit to the same commit returns that one SBOM, or 404 if none is stored.

Get Repository/Project SBOMs

get

Returns a list of SBOM (software bill of materials) items for a repository/project based on the query parameters. Responses are paginated in reverse-time order.

Path parameters
repositoryIdstringRequired
projectIdstringRequired
Query parameters
pageinteger · nullableOptional
pageSizeinteger · nullableOptional
fromCommitstring · nullableOptional
untilCommitstring · nullableOptional
fromTimestring · date-time · nullableOptional
untilTimestring · date-time · nullableOptional
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

Responses
200

OK

application/json
versionstringOptional
get/context/sboms/repository/{repositoryId}/project/{projectId}
GET /context/sboms/repository/{repositoryId}/project/{projectId} HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "sboms": [
    {
      "authoritative": true,
      "authorityRevision": 1,
      "carryCount": 1,
      "cdxGen": {
        "bomFormat": "text",
        "components": [
          {
            "author": "text",
            "bom-ref": "text",
            "description": "text",
            "externalReferences": [
              {
                "type": "text",
                "url": "text"
              }
            ],
            "group": "text",
            "hashes": [
              {
                "alg": "text",
                "content": "text"
              }
            ],
            "licenses": [
              {
                "expression": "text",
                "license": {
                  "id": "text",
                  "url": "text"
                }
              }
            ],
            "name": "text",
            "properties": [
              {
                "name": "text",
                "value": "text"
              }
            ],
            "publisher": "text",
            "purl": "text",
            "scope": "text",
            "type": "text",
            "version": "text"
          }
        ],
        "dependencies": [
          {
            "dependsOn": [
              "text"
            ],
            "ref": "text"
          }
        ],
        "metadata": {
          "authors": [
            {
              "email": "text",
              "name": "text"
            }
          ],
          "component": {
            "author": "text",
            "bom-ref": "text",
            "description": "text",
            "externalReferences": [
              {
                "type": "text",
                "url": "text"
              }
            ],
            "group": "text",
            "hashes": [
              {
                "alg": "text",
                "content": "text"
              }
            ],
            "licenses": [
              {
                "expression": "text",
                "license": {
                  "id": "text",
                  "url": "text"
                }
              }
            ],
            "name": "text",
            "properties": [
              {
                "name": "text",
                "value": "text"
              }
            ],
            "publisher": "text",
            "purl": "text",
            "scope": "text",
            "type": "text",
            "version": "text"
          },
          "timestamp": "2026-01-01T00:00:00.000Z",
          "tools": {
            "ANY_ADDITIONAL_PROPERTY": [
              {
                "group": "text",
                "name": "text",
                "version": "text"
              }
            ]
          }
        },
        "serialNumber": "text",
        "services": [
          {
            "bom-ref": "text",
            "endpoints": [
              "text"
            ],
            "group": "text",
            "name": "text",
            "provider": "text",
            "version": "text"
          }
        ],
        "specVersion": "text",
        "version": 1
      },
      "commitSha": "text",
      "commitTimestamp": "2026-01-01T00:00:00.000Z",
      "completenessRecorded": true,
      "detectedEcosystems": [
        "text"
      ],
      "detectedLockfiles": [
        "text"
      ],
      "detectedManifests": [
        "text"
      ],
      "empty": true,
      "exclusions": [
        {
          "dir": "text",
          "ecosystems": [
            "text"
          ],
          "path": "text",
          "reason": "text"
        }
      ],
      "failedEcosystems": [
        "text"
      ],
      "failureClass": "oom",
      "failureReason": "text",
      "generatedAt": "2026-01-01T00:00:00.000Z",
      "incomplete": true,
      "incompleteScopes": [
        {
          "dir": "text",
          "ecosystems": [
            "text"
          ],
          "path": "text",
          "reason": "text"
        }
      ],
      "lockfileClassification": "text",
      "lockfileSetHash": "text",
      "manifestRangeSources": {
        "ANY_ADDITIONAL_PROPERTY": {
          "filePath": "text",
          "range": "text"
        }
      },
      "manifestRanges": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "packageAuth": [
        {
          "credential": "rejected",
          "dir": "text",
          "ecosystem": "text",
          "evidence": "text",
          "registry": "text",
          "tool": "text",
          "version": 1
        }
      ],
      "provenance": {
        "backend": "text",
        "cdxgenVersion": "text",
        "imageDigest": "text",
        "sandboxJobId": "text"
      },
      "repoContextCommitSha": "text",
      "repoContextStaleReason": "text",
      "repoContextVersion": "text",
      "scanScope": {
        "exclude": [
          "text"
        ],
        "include": [
          "text"
        ]
      },
      "scannerVersion": "text"
    }
  ],
  "version": "text"
}

Run commit pipelines

POST /context/sboms/generate is the compatibility route for manually starting repository context (including schema reversing) and whole-repository SBOM generation in parallel, followed by the per-project split and dependency ingest. Use nullify context commit-pipelines run --repo <id> from the CLI. For an SBOM run alone, use Start an SBOM run.

The platform resolves the repository's clone URL, default branch and current head. Optional cloneUrl, defaultBranch and commitSha values must match those values; a mismatch returns 400. An active commit pipeline run is reused; a closed run is retried immediately. The response includes status and executionArn. Requires ConfigWrite.

Generate SBOM

post

Starts the commit pipelines for a repository head: repo context and one whole-repo SBOM in parallel, then the per-project split and dependency ingest. Returns status='generating' with the run's executionArn, or status='complete' when the commit's run already finished — poll GET /context/sboms/... for results.

Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

Body
cloneUrlstringOptional
commitShastringOptional
defaultBranchstringOptional
repositoryIdstringRequired
Responses
200

OK

application/json
commitShastringOptional
executionArnstringOptional
repositoryIdstringOptional
statusstringOptional
versionstringOptional
post/context/sboms/generate
POST /context/sboms/generate HTTP/1.1
Host: api.<TENANT>.nullify.ai
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "cloneUrl": "text",
  "commitSha": "text",
  "defaultBranch": "text",
  "repositoryId": "text"
}
{
  "commitSha": "text",
  "executionArn": "text",
  "repositoryId": "text",
  "status": "text",
  "version": "text"
}

Start an SBOM run

Generates, splits per project and ingests one SBOM for the repository's default branch head, and starts nothing else: no repository context, schema reversing or scan. If you pass commitSha it must be the current head. Returns runId and executionArn; once stored, the SBOM is readable from Get the latest SBOMs for a repository. Requires ConfigWrite.

Start SBOM Run

post

Generates, splits per project and ingests one SBOM for the repository's default branch head, and starts nothing else: no repo context, schema reversing or scan. commitSha, when given, must be the current head. Returns the run id and its executionArn; the SBOM is readable from GET /context/sboms/repository/{repositoryId}/latest once stored.

Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

Body
branchstring · max: 255Optional
commitShastringOptionalPattern: ^[0-9a-fA-F]{40}$
repositoryIdstring · min: 1 · max: 20RequiredPattern: ^[1-9][0-9]*$
Responses
200

OK

application/json
branchstringOptional
commitShastringRequired
executionArnstringRequired
repositoryIdstringRequired
runIdstringRequired
versionstringOptional
post/context/sboms/runs
POST /context/sboms/runs HTTP/1.1
Host: api.<TENANT>.nullify.ai
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "branch": "text",
  "commitSha": "text",
  "repositoryId": "text"
}
{
  "branch": "text",
  "commitSha": "text",
  "executionArn": "text",
  "repositoryId": "text",
  "runId": "text",
  "version": "text"
}

Scan an SBOM

Returns the stored SBOM for repositoryId, projectId and commitSha (all required) with status ready and cached true; if none exists, or forceRegenerate is true, it queues generation and returns status generating, and you poll List SBOMs for a project with the same commit. The project must already be known to SBOM storage and the commit must exist in the repository. Requires ConfigWrite.

Scan SBOM (get-or-generate)

post

Returns an existing SBOM if available, or enqueues generation and returns status='generating'. Callers can poll the GET endpoint to retrieve the result once ready.

Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

Body
commitShastringRequired
forceRegeneratebooleanOptional
projectIdstringRequired
repositoryIdstringRequired
Responses
200

OK

application/json
cachedbooleanOptional
statusstringOptional
versionstringOptional
post/context/sboms/scan
POST /context/sboms/scan HTTP/1.1
Host: api.<TENANT>.nullify.ai
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "commitSha": "text",
  "forceRegenerate": true,
  "projectId": "text",
  "repositoryId": "text"
}
{
  "cached": true,
  "sbom": {
    "authoritative": true,
    "authorityRevision": 1,
    "carryCount": 1,
    "cdxGen": {
      "bomFormat": "text",
      "components": [
        {
          "author": "text",
          "bom-ref": "text",
          "description": "text",
          "externalReferences": [
            {
              "type": "text",
              "url": "text"
            }
          ],
          "group": "text",
          "hashes": [
            {
              "alg": "text",
              "content": "text"
            }
          ],
          "licenses": [
            {
              "expression": "text",
              "license": {
                "id": "text",
                "url": "text"
              }
            }
          ],
          "name": "text",
          "properties": [
            {
              "name": "text",
              "value": "text"
            }
          ],
          "publisher": "text",
          "purl": "text",
          "scope": "text",
          "type": "text",
          "version": "text"
        }
      ],
      "dependencies": [
        {
          "dependsOn": [
            "text"
          ],
          "ref": "text"
        }
      ],
      "metadata": {
        "authors": [
          {
            "email": "text",
            "name": "text"
          }
        ],
        "component": {
          "author": "text",
          "bom-ref": "text",
          "description": "text",
          "externalReferences": [
            {
              "type": "text",
              "url": "text"
            }
          ],
          "group": "text",
          "hashes": [
            {
              "alg": "text",
              "content": "text"
            }
          ],
          "licenses": [
            {
              "expression": "text",
              "license": {
                "id": "text",
                "url": "text"
              }
            }
          ],
          "name": "text",
          "properties": [
            {
              "name": "text",
              "value": "text"
            }
          ],
          "publisher": "text",
          "purl": "text",
          "scope": "text",
          "type": "text",
          "version": "text"
        },
        "timestamp": "2026-01-01T00:00:00.000Z",
        "tools": {
          "ANY_ADDITIONAL_PROPERTY": [
            {
              "group": "text",
              "name": "text",
              "version": "text"
            }
          ]
        }
      },
      "serialNumber": "text",
      "services": [
        {
          "bom-ref": "text",
          "endpoints": [
            "text"
          ],
          "group": "text",
          "name": "text",
          "provider": "text",
          "version": "text"
        }
      ],
      "specVersion": "text",
      "version": 1
    },
    "commitSha": "text",
    "commitTimestamp": "2026-01-01T00:00:00.000Z",
    "completenessRecorded": true,
    "detectedEcosystems": [
      "text"
    ],
    "detectedLockfiles": [
      "text"
    ],
    "detectedManifests": [
      "text"
    ],
    "empty": true,
    "exclusions": [
      {
        "dir": "text",
        "ecosystems": [
          "text"
        ],
        "path": "text",
        "reason": "text"
      }
    ],
    "failedEcosystems": [
      "text"
    ],
    "failureClass": "oom",
    "failureReason": "text",
    "generatedAt": "2026-01-01T00:00:00.000Z",
    "incomplete": true,
    "incompleteScopes": [
      {
        "dir": "text",
        "ecosystems": [
          "text"
        ],
        "path": "text",
        "reason": "text"
      }
    ],
    "lockfileClassification": "text",
    "lockfileSetHash": "text",
    "manifestRangeSources": {
      "ANY_ADDITIONAL_PROPERTY": {
        "filePath": "text",
        "range": "text"
      }
    },
    "manifestRanges": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "packageAuth": [
      {
        "credential": "rejected",
        "dir": "text",
        "ecosystem": "text",
        "evidence": "text",
        "registry": "text",
        "tool": "text",
        "version": 1
      }
    ],
    "provenance": {
      "backend": "text",
      "cdxgenVersion": "text",
      "imageDigest": "text",
      "sandboxJobId": "text"
    },
    "repoContextCommitSha": "text",
    "repoContextStaleReason": "text",
    "repoContextVersion": "text",
    "scanScope": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    },
    "scannerVersion": "text"
  },
  "status": "text",
  "version": "text"
}

Resolve an SBOM

Returns the storage key of the SBOM for a repository and commit, generating it on demand if it is not cached. The request is a detailed object (lockfile-set hash, scanner version, CycloneDX generator major version, clone URL, owner and repository provider) that the dependency scanning pipeline builds, so most integrators use the other SBOM calls instead. The response gives the sbomS3Key, a source that names which cache tier served it, the component count, and a presigned sbomUrl with its SHA-256 and size; incomplete is true when generation did not cover every manifest. Requires ConfigRead.

Get or generate SBOM

post

Returns the storage key of the SBOM for the given (tenant, repo, commit). Generates the SBOM on demand if it is not already cached. Single source of truth for the SBOM lifecycle.

Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

Body
baselineOnlybooleanOptional
branchstringOptional
cdxgenMajorintegerOptional
cloneURLstringOptional
commitSHAstringOptional
isDefaultBranchPushbooleanOptional
lockfileSetHashstringOptional
manifestOnlybooleanOptional
repositoryIDstringOptional
scannerVersionstringOptional
tenantIDstringOptional
timestampstringOptional
Responses
200

OK

application/json
componentsintegerOptional
coverageRegressionbooleanOptional
failedEcosystemsstring[]Optional
failureClassstring · enumOptionalPossible values:
failureReasonstringOptional
incompletebooleanOptional
sbomS3KeystringOptional
sbomSha256stringOptional
sbomSizeBytesinteger · int64Optional
sbomUrlstringOptional
sourcestringOptional
post/context/sboms/resolve
POST /context/sboms/resolve HTTP/1.1
Host: api.<TENANT>.nullify.ai
Content-Type: application/json
Accept: */*
Content-Length: 1682

{
  "baselineOnly": true,
  "branch": "text",
  "cdxgenMajor": 1,
  "cloneURL": "text",
  "commitSHA": "text",
  "isDefaultBranchPush": true,
  "lockfileSetHash": "text",
  "manifestOnly": true,
  "ownerProvider": {
    "asana": {
      "accessToken": "text",
      "workspaceId": "text",
      "workspaceName": "text"
    },
    "azure": {
      "baseUrl": "text",
      "organizationId": "text",
      "organizationName": "text",
      "tenantId": "text"
    },
    "azureEntra": {
      "clientId": "text",
      "clientSecret": "text",
      "tenantId": "text"
    },
    "bitbucket": {
      "appKey": "text",
      "baseUrl": "text",
      "clientKey": "text",
      "ownerId": "text",
      "ownerName": "text",
      "sharedSecret": "text"
    },
    "external": {
      "installationId": "text"
    },
    "github": {
      "baseUrl": "text",
      "executionIdentity": {
        "appID": 1,
        "proof": "text",
        "source": "dedicated_direct"
      },
      "installationId": 1,
      "owner": "text",
      "ownerId": 1,
      "ownerType": "text"
    },
    "gitlab": {
      "baseUrl": "text",
      "groupId": 1,
      "groupName": "text",
      "oauth": true
    },
    "googleWorkspace": {
      "adminEmail": "text",
      "domain": "text",
      "serviceAccountJson": "text"
    },
    "id": "DX",
    "jira": {
      "baseUrl": "text",
      "installationId": "text",
      "ownerId": "text"
    },
    "linear": {
      "accessToken": "text",
      "clientId": "text",
      "clientSecret": "text",
      "urlKey": "text",
      "workspaceId": "text",
      "workspaceName": "text"
    },
    "okta": {
      "apiToken": "text",
      "domain": "text"
    },
    "slack": {
      "teamId": "text"
    },
    "teams": {
      "teamId": "text"
    }
  },
  "repositoryID": "text",
  "repositoryProvider": {
    "azure": {
      "projectId": "text",
      "projectName": "text",
      "repositoryId": "text",
      "repositoryName": "text"
    },
    "bitbucket": {
      "projectKey": "text",
      "projectName": "text",
      "repositoryId": "text",
      "repositoryName": "text"
    },
    "github": {
      "hasIssue": true,
      "nodeId": "text",
      "owner": "text",
      "ownerId": 1,
      "repositoryId": 1,
      "repositoryName": "text"
    },
    "gitlab": {
      "projectId": 1,
      "projectName": "text"
    },
    "id": "DX"
  },
  "scannerVersion": "text",
  "tenantID": "text",
  "timestamp": "text"
}
{
  "components": 1,
  "coverageRegression": true,
  "exclusions": [
    {
      "dir": "text",
      "ecosystems": [
        "text"
      ],
      "path": "text",
      "reason": "text"
    }
  ],
  "failedEcosystems": [
    "text"
  ],
  "failureClass": "oom",
  "failureReason": "text",
  "incomplete": true,
  "incompleteScopes": [
    {
      "dir": "text",
      "ecosystems": [
        "text"
      ],
      "path": "text",
      "reason": "text"
    }
  ],
  "packageAuth": [
    {
      "credential": "rejected",
      "dir": "text",
      "ecosystem": "text",
      "evidence": "text",
      "registry": "text",
      "tool": "text",
      "version": 1
    }
  ],
  "sbomS3Key": "text",
  "sbomSha256": "text",
  "sbomSizeBytes": 1,
  "sbomUrl": "text",
  "scanScope": {
    "exclude": [
      "text"
    ],
    "include": [
      "text"
    ]
  },
  "source": "text"
}

Replay SBOM ingestion

Enqueues a replay of dependency ingestion from stored SBOMs, which rebuilds the dependency inventory without regenerating SBOMs. Send repositoryID and projectID to replay one project up to its head commit, or globalReplay: true to replay every repository in the tenant. Without globalReplay, both ids are required or the call returns 400. The call returns once messages are queued, not when ingestion finishes. Requires ConfigWrite.

Compute Dependencies Repository/Project SBOM Ingest Replay

post

Enqueue a full SBOM ingest replay; either global or for a specific repository and project

Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

Body
globalReplaybooleanOptional
projectIDstringOptional
repositoryIDstringOptional
Responses
200

OK

application/json
messagestringOptional
versionstringOptional
post/context/sbomingestor/replay
POST /context/sbomingestor/replay HTTP/1.1
Host: api.<TENANT>.nullify.ai
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "globalReplay": true,
  "projectID": "text",
  "repositoryID": "text"
}
{
  "message": "text",
  "version": "text"
}

Delete SBOMs

Permanently deletes stored SBOMs for the tenant. Narrow the scope with repositoryId (and projectId, which requires repositoryId), restrict it to invalid SBOM objects with invalidOnly=true, and use dryRun=true first to list what would be deleted without removing anything. With no selectors it covers every SBOM in the tenant. The response lists deletedKeys and the resulting tree. Requires ConfigWrite.

Delete SBOMs for tenant

delete

Deletes SBOM (software bill of materials) items for a tenant. Scope can be limited by repository/project, and you can optionally restrict deletions to invalid SBOM objects only.

Query parameters
azureOrganizationIdstringOptional

The Azure organization ID

bitbucketWorkspaceIdstringOptional

The Bitbucket workspace ID

githubOwnerIdinteger · int64Optional

The Github owner ID

githubInstallationIdinteger · int64Optional

Operator routes only: the GitHub App installation ID to use alongside githubOwnerId when the tenant's stored record has none. Ignored on customer routes.

gitlabGroupIdinteger · int64Optional

The GitLab group ID

installationIdstringOptional

The Nullify installation ID

azureRepositoryIdstring[]Optional

Filter by Azure repository IDs

githubRepositoryIdinteger · int64[]Optional

Filter by GitHub repository IDs

githubTeamIdinteger · int64Optional

Filter by GitHub team ID

bitbucketRepositoryIdstring[]Optional

Filter by Bitbucket repository IDs

repositoryIdstringOptional
projectIdstringOptional
invalidOnlybooleanOptional
dryRunbooleanOptional
Responses
200

OK

application/json
deletedKeysstring[]Optional
tenantIdstringRequired
tenantNamestringOptional
versionstringOptional
delete/context/sboms
DELETE /context/sboms HTTP/1.1
Host: api.<TENANT>.nullify.ai
Accept: */*
{
  "deletedKeys": [
    "text"
  ],
  "repositories": [
    {
      "projects": [
        {
          "commits": [
            "text"
          ],
          "projectId": "text",
          "projectName": "text"
        }
      ],
      "repositoryId": "text",
      "repositoryName": "text"
    }
  ],
  "tenantId": "text",
  "tenantName": "text",
  "version": "text"
}

Last updated