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.
| Group | What it covers | Operations |
|---|---|---|
| Findings | List, read, triage and export findings, and see what was held back because of an earlier decision. | 16 |
| Fixes | Start a verified fix, see what it would cover, follow a fix run, and manage automatic fix rules. | 10 |
| Pull request reviews | Read pull request reviews and their logs, and request a review of one pull request. | 5 |
| Pentests | Estimate, start, follow, cancel and retest pentests, and check a live-testing sign-in. | 12 |
| Pentest schedules | Run pentests on a timetable. | 4 |
| Reports | List a pentest’s reports, download one, and share it by link. | 3 |
| Code hosts and repositories | Connect code hosts, list repositories, add a public repository or upload an archive. | 17 |
| Applications | The context Nullgap keeps for an application: its threat model and project rules. | 6 |
| Dependencies | Check package versions for malware, known vulnerabilities and your own package rules. | 1 |
| Custom checks | Checks you write for your own code, run in every review and pentest. | 4 |
| Skills | The catalogue of skills, its switches and per-repository overrides, and the skills you write yourself. | 10 |
| Skill runs | Run one skill on demand, follow the run, and upload two versions of an artefact to compare. | 8 |
| Tools | The scanners, linters, SBOM generator and decompilers Nullgap can run in its sandbox, and whether each can run here. | 1 |
| Tool runs | Run one scanning tool on a repository, an uploaded archive or an address on the scope list, and read its leads or its document. | 5 |
| Organisation | The organisation, its settings, its overview figures, and the signed-in person. | 10 |
| People | Members, roles, seats and invitations. | 9 |
| Audit log | Read, export and verify the organisation’s audit log. | 3 |
| API keys | List, create, rotate and revoke API keys. | 5 |
| Integrations | Slack notifications, Jira and Linear. | 6 |
| Outbound webhooks | Endpoints of yours that Nullgap sends events to. | 7 |
| Slack assistant | Set up the Slack assistant and link Slack users to Nullgap accounts. | 8 |
| Billing and usage | The plan, credits and usage of the organisation. | 4 |
| Data protection | What Nullgap publishes about its handling of data, and exporting or erasing your own. | 6 |
| Background jobs | See background jobs that failed and retry them. | 2 |
| Getting started | The guided first-run steps of a new organisation, as the console shows them. | 3 |
| Support | How to reach Nullgap support, the requests you sent, and the permission for support to look at your workspace. | 19 |
| Multi-factor sign-in | The signed-in person’s authenticator app and recovery codes. | 5 |
| Passkeys | The signed-in person’s passkeys. | 5 |
| Sessions | Console sessions: list them, end one, end all. | 4 |
| Single sign-on | Configure OpenID Connect or SAML sign-in and verify e-mail domains. | 5 |
| SCIM provisioning | The SCIM 2.0 endpoints an identity provider calls, and the token that opens them. | 14 |
| Service | The API’s own description. | 1 |
| AI app tests | 7 | |
| Connected apps (OAuth) | 4 | |
| Connected apps | 7 |
#Who may call an operation
Each operation says who may call it, in one of these words:
| Word | Meaning |
|---|---|
| read | An API key with the read scope or higher. |
| write | An API key with the write scope or higher. |
| admin | An API key with the admin scope. |
| none | None. No key is needed. |
| console session | A signed-in person in the console. This is about your own account, so no API key may call it. |
| console only | A 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 token | The organisation’s SCIM token as a bearer token, not an API key. |
Nullgap documentation