Nullgap.dev Docs

API reference

API reference

Every operation of the Nullgap REST API, with parameters, bodies, examples and errors.

Every operation of the Nullgap REST API, grouped by what it works on. Each page lists the operations of one group with their parameters, request body, an example request, an example answer and the errors specific to it, followed by the objects involved.

This reference is generated from the API’s own description, which the server builds from its route table. The same description is served, as OpenAPI 3.1, at GET /api/openapi.json on your Nullgap console’s address; it needs no key.

Start with the API overview for authentication, errors, paging, rate limits and idempotency, and API keys for scopes.

GroupWhat it coversOperations
FindingsList, read, triage and export findings, and see what was held back because of an earlier decision.16
FixesStart a verified fix, see what it would cover, follow a fix run, and manage automatic fix rules.10
Pull request reviewsRead pull request reviews and their logs, and request a review of one pull request.5
PentestsEstimate, start, follow, cancel and retest pentests, and check a live-testing sign-in.12
Pentest schedulesRun pentests on a timetable.4
ReportsList a pentest’s reports, download one, and share it by link.3
Code hosts and repositoriesConnect code hosts, list repositories, add a public repository or upload an archive.17
ApplicationsThe context Nullgap keeps for an application: its threat model and project rules.6
DependenciesCheck package versions for malware, known vulnerabilities and your own package rules.1
Custom checksChecks you write for your own code, run in every review and pentest.4
SkillsThe catalogue of skills, its switches and per-repository overrides, and the skills you write yourself.10
Skill runsRun one skill on demand, follow the run, and upload two versions of an artefact to compare.8
ToolsThe scanners, linters, SBOM generator and decompilers Nullgap can run in its sandbox, and whether each can run here.1
Tool runsRun one scanning tool on a repository, an uploaded archive or an address on the scope list, and read its leads or its document.5
OrganisationThe organisation, its settings, its overview figures, and the signed-in person.10
PeopleMembers, roles, seats and invitations.9
Audit logRead, export and verify the organisation’s audit log.3
API keysList, create, rotate and revoke API keys.5
IntegrationsSlack notifications, Jira and Linear.6
Outbound webhooksEndpoints of yours that Nullgap sends events to.7
Slack assistantSet up the Slack assistant and link Slack users to Nullgap accounts.8
Billing and usageThe plan, credits and usage of the organisation.4
Data protectionWhat Nullgap publishes about its handling of data, and exporting or erasing your own.6
Background jobsSee background jobs that failed and retry them.2
Getting startedThe guided first-run steps of a new organisation, as the console shows them.3
SupportHow to reach Nullgap support, the requests you sent, and the permission for support to look at your workspace.19
Multi-factor sign-inThe signed-in person’s authenticator app and recovery codes.5
PasskeysThe signed-in person’s passkeys.5
SessionsConsole sessions: list them, end one, end all.4
Single sign-onConfigure OpenID Connect or SAML sign-in and verify e-mail domains.5
SCIM provisioningThe SCIM 2.0 endpoints an identity provider calls, and the token that opens them.14
ServiceThe API’s own description.1
AI app tests7
Connected apps (OAuth)4
Connected apps7

#Who may call an operation

Each operation says who may call it, in one of these words:

WordMeaning
readAn API key with the read scope or higher.
writeAn API key with the write scope or higher.
adminAn API key with the admin scope.
noneNone. No key is needed.
console sessionA signed-in person in the console. This is about your own account, so no API key may call it.
console onlyA signed-in person in the console. No API key may call it.
console only (admin)A signed-in admin or owner in the console. No API key may call it.
console only (owner)A signed-in owner in the console. No API key may call it.
SCIM tokenThe organisation’s SCIM token as a bearer token, not an API key.

Nullgap documentation