API reference
Data protection
What Nullgap publishes about its handling of data, and exporting or erasing your own.
Paths are relative to the address of your Nullgap console. Authentication, errors, paging and rate limits are the same for every call and are described in the API overview.
| Operation | Method and path | Who may call it |
|---|---|---|
| Get the data-handling statements | GET /api/trust | none |
| Get the data protection overview | GET /api/orgs/{org}/compliance | read |
| Export all data | GET /api/orgs/{org}/data/export | console only (owner) |
| Erase data | POST /api/orgs/{org}/data/erase | console only (owner) |
| Before deleting the workspace | GET /api/orgs/{org}/delete | console only (owner) |
| Delete the workspace | POST /api/orgs/{org}/delete | console only (owner) |
#Get the data-handling statements
GET /api/trust
Answers Nullgap's public statements about what it stores and does not store, and the frameworks an organisation can select. It needs no authentication and is the same for everyone.
Who may call it: None. No key is needed.
Example request
curl -s \
"$NULLGAP_URL/api/trust"
Answer (200, application/json)
A TrustInfo object.
{
"guarantees": [
{
"id": "no-source-storage",
"title": "Your source code is not kept",
"detail": "A repository is checked out for the duration of a run and deleted when it ends."
}
],
"frameworks": [
{
"id": "gdpr",
"name": "EU — General Data Protection Regulation",
"region": "European Union",
"category": "privacy",
"summary": "Personal data of people in the EU: minimisation, storage limitation, security, breach notification and data subject rights.",
"mapped": true
}
],
"stored": [
"An audit log of changes made in your organisation"
],
"neverStored": [
"The prompts sent to the AI"
],
"disclaimer": "This shows how Nullgap handles your data against the selected law or standard. It is not legal advice."
}
#Get the data protection overview
GET /api/orgs/{org}/compliance
Answers how Nullgap handles this organisation's data, control by control, set against the framework selected in the settings. Each control carries its status and, where there is one, the evidence behind it for this organisation right now. The overview states what the product does; it is not legal advice and not an assessment of your organisation. Show the disclaimer with it.
Who may call it: An API key with the read scope or higher.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
Example request
curl -s -H "Authorization: Bearer $NULLGAP_API_KEY" \
"$NULLGAP_URL/api/orgs/$NULLGAP_ORG/compliance"
Answer (200, application/json)
A ComplianceOverview object.
{
"framework": "gdpr",
"available": [
{
"id": "gdpr",
"name": "EU — General Data Protection Regulation",
"region": "European Union",
"category": "privacy",
"summary": "Personal data of people in the EU: minimisation, storage limitation, security, breach notification and data subject rights.",
"mapped": true
}
],
"clauseMapped": true,
"frameworkName": "EU — General Data Protection Regulation",
"frameworkSummary": "Applies when you process personal data of people in the EU. Nullgap acts as your processor under Article 28.",
"guarantees": [
{
"id": "source",
"title": "Your source code is not kept",
"detail": "A repository is checked out for the duration of a run and deleted when it ends.",
"active": true
}
],
"controls": [
{
"id": "retention",
"title": "Automatic deletion after a set period",
"description": "Reviews, pentests, their logs and reports, and resolved findings are deleted automatically once older than the period you choose.",
"status": "configurable",
"evidence": "Deleting after 365 days. Last run 2026-11-16.",
"references": [
"Art. 5(1)(e) storage limitation"
]
}
],
"retentionDays": 365,
"lastPurgeAt": "2026-11-16T03:00:00.000Z",
"zeroRetentionCoverage": 100,
"disclaimer": "This shows how Nullgap handles your data against the selected law or standard. It is not legal advice."
}
#Export all data
GET /api/orgs/{org}/data/export
Downloads everything stored for the organisation as one JSON file named nullgap-<slug>-export.json, indented for reading. The records that hold credentials are left out: code-host connections, integrations, webhook endpoints, API keys, the Slack assistant and pending invitations are not in the file. Each record is written in the form the other routes of this API give it, not as it is stored: sealed values (a pentest's test account among them) and the tokens of report share links are left out, and so are the usage and cost fields of runs. A report says whether it is shared (shared) without its link. Only an owner signed in to the console can call it, and the export is recorded in the audit log.
Who may call it: A signed-in owner in the console. No API key may call it.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
Answer (200, application/json)
The export file.
| Field | Type | Always present | Description |
|---|---|---|---|
exportedAt | string | yes | When the file was made. |
organisation | object | yes | The organisation and its settings. |
organisation.id | string | yes | The organisation's id. |
organisation.slug | string | yes | Its slug. |
organisation.name | string | yes | Its name. |
organisation.plan | string | yes | Its plan. One of: none, trial, pro, enterprise. |
organisation.createdAt | string | yes | When it was created. |
organisation.settings | OrgSettings | yes | |
repository | array of object | yes | The repositories. |
application | array of object | yes | The applications, with their threat models. |
review | array of object | yes | The pull request reviews. |
pentest | array of object | yes | The pentests. |
finding | array of object | yes | The findings. |
dismissal | array of object | yes | What Nullgap remembers about dismissed findings. |
suppression | array of object | yes | Findings that were held back because they match an earlier dismissal. |
report | array of object | yes | The pentest reports. |
automation | array of object | yes | The automations. |
run | array of object | yes | The fix runs. |
log | array of object | yes | The logs of reviews and pentests. |
audit | array of object | yes | The audit log. |
credit | array of object | yes | The credit ledger. |
member | array of object | yes | The memberships: who belongs to the organisation and with which role. |
seat | array of object | yes | The assigned pull request review seats. |
schedule | array of object | yes | The pentest schedules. |
oauthgrant | array of object | no | The apps members connected in the browser: which app, whose connection (by user id), the access it was given and when it was last used. Tokens are never exported. |
support | array of object | yes | The support requests, each with its messages. |
supportgrant | array of object | yes | The times support was given access to the workspace. |
customskill | array of object | yes | The organisation's own skills, each with the text of its SKILL.md. |
skillsettings | array of object | yes | Which skills are switched off, the per-repository overrides and the permitted tools. Empty until something was changed. |
skillrun | array of object | yes | The on-demand skill runs with their output and the text that was supplied to them. |
reportsnap | array of object | yes | What each pentest's reports are produced from: the pentest and its findings as they were when the reports were issued. |
{
"exportedAt": "2026-11-16T09:30:00.000Z",
"organisation": {
"id": "org_3f9a1c2b7d4e",
"slug": "acme",
"name": "Acme",
"plan": "trial",
"createdAt": "2026-09-01T08:20:00.000Z",
"settings": {
"postChecks": true,
"postComments": true,
"postSystemComments": true,
"failCheckAt": "high",
"commentStyle": "standard",
"filters": [
{
"kind": "branch",
"mode": "exclude",
"value": "dependabot/*"
}
],
"sla": {
"critical": {
"days": 7,
"target": 95
},
"high": {
"days": 30,
"target": 90
},
"medium": {
"days": 90,
"target": 80
},
"low": {
"days": 180,
"target": 70
}
},
"minSecurityScore": 80,
"requireMfa": false,
"overage": false,
"unverifiedFixes": true,
"dataProtection": {
"framework": "gdpr",
"retentionDays": 365,
"privacyContactEmail": "privacy@acme.example",
"breachContactEmail": "security@acme.example"
},
"supplyChain": {
"blockedPackages": [
"event-stream@3.3.6"
],
"allowedPackages": [
"@acme/*"
],
"minAgeDays": 7,
"blockInstallScripts": true,
"installScriptAllowlist": [
"esbuild"
],
"allowedRegistries": [
"npm.acme.example"
]
},
"customChecks": [
{
"id": "cc_9d4e1f7a2b60",
"name": "Tenant id taken from the request",
"brief": "Flag any database query in a request handler that filters by a tenant id read from the request body or query string instead of from the signed-in session.",
"notFinding": "Admin tools under /internal, which are allowed to name any tenant.",
"filePatterns": [
"services/api/**"
],
"match": "tenant_?[iI]d",
"severityGuidance": "High when the query writes, medium when it only reads.",
"enabled": true,
"createdAt": "2026-11-16T09:30:00.000Z",
"updatedAt": "2026-11-16T09:30:00.000Z"
}
]
}
},
"repository": [
{}
],
"application": [
{}
],
"review": [
{}
],
"pentest": [
{}
],
"finding": [
{}
],
"dismissal": [
{}
],
"suppression": [
{}
],
"report": [
{}
],
"automation": [
{}
],
"run": [
{}
],
"log": [
{}
],
"audit": [
{}
],
"credit": [
{}
],
"member": [
{}
],
"seat": [
{}
],
"schedule": [
{}
],
"oauthgrant": [
{}
],
"support": [
{}
],
"supportgrant": [
{}
],
"customskill": [
{}
],
"skillsettings": [
{}
],
"skillrun": [
{}
],
"reportsnap": [
{}
]
}
#Erase data
POST /api/orgs/{org}/data/erase
Permanently deletes the organisation's data. This cannot be undone. findings deletes findings, what is remembered about dismissed ones, reviews, pentests, their logs and reports, fix runs and on-demand skill runs. all deletes those and also applications, automations, integrations, webhook endpoints, the Slack assistant, pentest schedules, repositories, code-host connections, uploaded archives, custom skills with their switches, files uploaded for a skill run, and support requests with the access given for them, and replaces the key that protects the organisation's stored secrets. Reviews, pentests, fix runs and skill runs that are queued or running are left in place. The organisation itself, its members, settings, API keys, billing records and audit log are kept in both cases. Only an owner signed in to the console can call it, with a recent second-factor check when their account has one.
Who may call it: A signed-in owner in the console. No API key may call it.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
Request body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
scope | string | yes | How much to erase. One of: findings, all. |
confirm | string | yes | The organisation's slug, typed out, to confirm. |
Answer (200, application/json)
| Field | Type | Always present | Description |
|---|---|---|---|
deleted | object | yes | How many records of each kind were deleted, keyed by a plain plural name such as findings, reviews, pentests, reports, logs or fix runs. Kinds with nothing to delete are left out, so the object is empty when there was nothing to erase. |
{
"deleted": {
"findings": 42,
"reviews": 61,
"pentests": 1,
"reports": 3,
"logs": 62,
"fix runs": 9
}
}
Errors specific to this call
| Status | Code | When |
|---|---|---|
| 400 | bad_request | scope is not findings or all, or confirm is not the organisation's slug. |
| 403 | step_up_required | Your account has multi-factor sign-in and this session has not passed a second-factor check in the last 15 minutes. Confirm with your authenticator and try again. |
#Before deleting the workspace
GET /api/orgs/{org}/delete
What the console shows before an owner deletes the workspace: how many reviews, pentests, fix runs and skill runs are queued or running. While there are any, POST /api/orgs/{org}/delete is refused unless cancelJobs is true.
Who may call it: A signed-in owner in the console. No API key may call it.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
Answer (200, application/json)
| Field | Type | Always present | Description |
|---|---|---|---|
activeJobs | integer | yes | Jobs queued or running now. |
{
"activeJobs": 0
}
#Delete the workspace
POST /api/orgs/{org}/delete
Permanently deletes the organisation itself and everything stored for it. This cannot be undone. Removed: findings, reviews, pentests, fix runs, reports and logs; repositories, code-host connections and uploaded files; applications with their threat models and rules, custom checks, custom skills and skill runs; integrations, webhook endpoints, the Slack assistant, API keys and every stored credential; memberships, invitations, seats, single sign-on and provisioning settings; schedules, automations, credits, support requests and the organisation's audit log. Kept: one entry in Nullgap's own operations log (the organisation's name, slug and id, who deleted it and when, how many records of each kind were removed and the final hash of its audit log); the slug, which nobody else can register for 90 days; the user accounts of its members; and whatever a payment provider holds. The Nullgap GitHub App is not uninstalled from your GitHub account: uninstall it there. Backups made before the deletion still contain the organisation until they expire. Take an export first with GET /api/orgs/{org}/data/export if you need a copy. Refused while a review, pentest, fix run or skill run is queued or running, unless cancelJobs is true, in which case that work is cancelled first. Only an owner signed in to the console can call it, with a recent second-factor check when their account has one. A suspended organisation cannot delete itself: contact support. Owners are told by e-mail when the deletion is done.
Who may call it: A signed-in owner in the console. No API key may call it.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
Request body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
confirm | string | yes | The organisation's slug, typed out, to confirm. |
cancelJobs | boolean | no | Cancel queued and running work first, instead of refusing while there is any. Default false. |
Answer (200, application/json)
| Field | Type | Always present | Description |
|---|---|---|---|
slug | string | yes | The slug of the organisation that was deleted. |
name | string | yes | Its name. |
deletedAt | string | yes | When the deletion finished. |
removed | object | yes | How many records of each kind were removed, keyed by a plain plural name. Kinds with nothing to remove are left out. |
slugHeldUntil | string | yes | Until when nobody else can register the slug. |
notified | integer | yes | How many owners were sent the e-mail saying the organisation was deleted. 0 when the service sends no e-mail. |
{
"slug": "acme",
"name": "Acme",
"deletedAt": "2026-11-16T10:00:00.000Z",
"removed": {
"members": 4,
"repositories": 6,
"findings": 42,
"reviews": 61,
"audit log entries": 230
},
"slugHeldUntil": "2027-02-14T10:00:00.000Z",
"notified": 1
}
Errors specific to this call
| Status | Code | When |
|---|---|---|
| 400 | bad_request | confirm is not the organisation's slug, or cancelJobs is not true or false. |
| 403 | step_up_required | Your account has multi-factor sign-in and this session has not passed a second-factor check in the last 15 minutes. Confirm with your authenticator and try again. |
| 403 | org_suspended | The organisation is suspended. Contact support to have it deleted. |
| 409 | jobs_active | Work is queued or running and cancelJobs was not set. Nothing was changed. |
| 409 | jobs_stopping | Running work was told to stop and has not stopped yet. The deletion has begun and finishes by itself; the organisation answers org_deleting meanwhile. |
#Objects
The objects the operations above take and return.
#TrustInfo
Nullgap's public statements about data handling. The same for everyone: nothing in it is about a particular organisation.
| Field | Type | Always present | Description |
|---|---|---|---|
guarantees | array of object | yes | The four headline statements about how code and AI processing are handled. |
guarantees[].id | string | yes | The statement's identifier. |
guarantees[].title | string | yes | The statement in a few words. |
guarantees[].detail | string | yes | The statement in full. |
frameworks | array of FrameworkInfo | yes | Every framework an organisation can select. |
stored | array of string | yes | What Nullgap stores, in plain words. |
neverStored | array of string | yes | What Nullgap does not store, in plain words. |
disclaimer | string | yes | A notice on what these statements are and are not. Show it wherever they are shown. |
#ComplianceOverview
Nullgap's own published statements about how it handles this organisation's data, set against the framework the organisation selected. It describes the product's behaviour; it is not an assessment of the organisation or of Nullgap.
| Field | Type | Always present | Description |
|---|---|---|---|
framework | string | yes | The framework selected in the data protection settings, or none. |
available | array of FrameworkInfo | yes | Every framework that can be selected. |
clauseMapped | boolean | yes | True when a provision-by-provision mapping is published for the selected framework. |
frameworkName | string | yes | The name of the selected framework, or a placeholder when none is selected. |
frameworkSummary | string | yes | One paragraph on what the framework is and what selecting it changes. |
guarantees | array of object | yes | The four headline statements about how code and AI processing are handled, each with whether it is in effect. |
guarantees[].id | string | yes | The statement's identifier. |
guarantees[].title | string | yes | The statement in a few words. |
guarantees[].detail | string | yes | The statement in full. |
guarantees[].active | boolean | yes | True when the statement is confirmed as in effect on this server for this organisation. |
controls | array of ComplianceControl | yes | Every control, with its status for this organisation. |
retentionDays | integer or null | yes | The retention period from the data protection settings, in days. Null when data is kept until deleted by hand. |
lastPurgeAt | string or null | yes | When automatic deletion last ran for this organisation. Null when it never has. |
zeroRetentionCoverage | integer or null | yes | The share of AI calls in the last 30 days that were confirmed as zero-retention, 0 to 100. Null when there were no runs to report on. |
disclaimer | string | yes | A notice on what this overview is and is not. Show it wherever the overview is shown. |
#OrgSettings
How Nullgap behaves for an organisation.
| Field | Type | Always present | Description |
|---|---|---|---|
postChecks | boolean | yes | Show progress and results as a check on the commit. |
postComments | boolean | yes | Post the summary and the inline finding comments on the pull request. |
postSystemComments | boolean | yes | Post notices about skipped reviews, limits and configuration problems on the pull request. |
failCheckAt | string | yes | The check fails when a finding is at or above this severity. off never fails it. |
commentStyle | string | yes | How much detail pull request comments carry. One of: concise, standard, detailed. |
filters | array of ReviewFilter | yes | Rules that decide which pull requests are reviewed. Empty means every pull request. |
sla | object | yes | The resolution window and target for each severity. |
sla.critical | object | yes | The window and target for one severity. |
sla.critical.days | integer | yes | Days allowed to resolve a finding of this severity, counted from when it was first seen. |
sla.critical.target | integer | yes | The share of findings, 0 to 100, that should be resolved within that many days. |
sla.high | object | yes | The window and target for one severity. |
sla.high.days | integer | yes | Days allowed to resolve a finding of this severity, counted from when it was first seen. |
sla.high.target | integer | yes | The share of findings, 0 to 100, that should be resolved within that many days. |
sla.medium | object | yes | The window and target for one severity. |
sla.medium.days | integer | yes | Days allowed to resolve a finding of this severity, counted from when it was first seen. |
sla.medium.target | integer | yes | The share of findings, 0 to 100, that should be resolved within that many days. |
sla.low | object | yes | The window and target for one severity. |
sla.low.days | integer | yes | Days allowed to resolve a finding of this severity, counted from when it was first seen. |
sla.low.target | integer | yes | The share of findings, 0 to 100, that should be resolved within that many days. |
minSecurityScore | integer or null | yes | The security score, 0 to 100, the organisation aims to stay above. Null when no minimum is set. |
requireMfa | boolean | yes | True when every member must have multi-factor sign-in. |
overage | boolean | yes | True to allow pull request reviews beyond the included number, billed per review. |
unverifiedFixes | boolean | no | Whether a fix may be proposed when a finding cannot be reproduced: a draft pull request marked "[Not proven]", never counted as a verified fix. True unless an admin switched it off. Always present in the answers of the settings routes; it can be absent inside an Org saved before the switch existed, which reads as true. |
dataProtection | DataProtectionSettings | yes | |
supplyChain | SupplyChainPolicy | no | The package rules. Always present in the answers of the settings routes. It can be absent inside an Org created before the rules existed: read that as no rules. |
customChecks | array of CustomCheck | no | The organisation's own checks, when it has saved any. Managed through the custom-checks routes, not through the settings routes. |
#FrameworkInfo
A law or standard that can be selected in the data protection settings.
| Field | Type | Always present | Description |
|---|---|---|---|
id | string | yes | The identifier to send as dataProtection.framework. |
name | string | yes | The full name of the law or standard. |
region | string | yes | Where it applies. |
category | string | yes | The kind of framework: a privacy law, an AI governance framework, a security standard, or a sector regime. One of: privacy, ai, security, sector. |
summary | string | yes | One sentence on what it covers. |
mapped | boolean | yes | True when Nullgap publishes a provision-by-provision mapping of its controls for this framework. When false, the controls are listed without references. |
#ComplianceControl
One data-handling control and where it stands for this organisation.
| Field | Type | Always present | Description |
|---|---|---|---|
id | string | yes | The control's identifier. |
title | string | yes | The control in a few words. |
description | string | yes | What Nullgap does, in plain words. |
status | string | yes | enforced: built in and cannot be switched off. configurable: built in and set by your own settings. contract: covered by an agreement or process rather than by the product. customer: your own obligation, for which Nullgap provides what you need. planned: not available yet. |
evidence | string or null | yes | What backs the status for this organisation right now, in plain words. Null when there is nothing to add. |
references | array of string | yes | The provisions of the selected framework this control relates to. Empty when no framework is selected or no mapping is published for it. |
#ReviewFilter
A rule that decides which pull requests are reviewed.
| Field | Type | Always present | Description |
|---|---|---|---|
kind | string | yes | What the filter looks at: a pull request label, its author, its branch, or a keyword. One of: label, author, branch, keyword. |
mode | string | yes | include: only matching pull requests are reviewed. exclude: matching pull requests are skipped. |
value | string | yes | The label, login, branch or keyword to match. At most 200 characters. |
#DataProtectionSettings
How long data is kept and who is contacted about it.
| Field | Type | Always present | Description |
|---|---|---|---|
framework | string | yes | The law or standard the organisation has asked Nullgap to align its data handling with, or none. GET /api/trust lists them with their names. |
retentionDays | integer or null | yes | Reviews, pentests, their logs and reports, and resolved findings older than this many days are deleted automatically. Null keeps them until they are deleted by hand. |
privacyContactEmail | string or null | yes | Who privacy questions and requests from data subjects go to at the organisation. Null when not set. |
breachContactEmail | string or null | yes | Who Nullgap notifies about a security incident that affects the organisation's data. Null when not set. |
#SupplyChainPolicy
The organisation's rules about which packages may be used. They are applied by the package check and by the pull request check.
| Field | Type | Always present | Description |
|---|---|---|---|
blockedPackages | array of string | yes | Packages that must not be used. Each entry is a name, name@version, ecosystem:name, or a prefix ending in * such as @acme/*. |
allowedPackages | array of string | yes | Packages exempt from the rules below and not raised as suspicious. Being listed here never clears a malicious verdict. |
minAgeDays | integer or null | yes | Versions published fewer than this many days ago are blocked. Null means no minimum. |
blockInstallScripts | boolean | yes | True to block packages that run a script at install time, unless they are listed in installScriptAllowlist. |
installScriptAllowlist | array of string | yes | Packages that may run a script at install time even when blockInstallScripts is on. |
allowedRegistries | array of string | yes | Registry hosts packages may come from besides the public registries. Empty means any. |
#CustomCheck
A check an organisation writes for its own code. Enabled checks run in every review and pentest of its repositories.
| Field | Type | Always present | Description |
|---|---|---|---|
id | string | yes | The check id. |
name | string | yes | Shown on the findings this check produces. One line. |
brief | string | yes | What to look for, in plain words. |
notFinding | string | yes | What does not count as a finding. May be empty. |
filePatterns | array of string | yes | The files the check runs on, as glob patterns. Empty means any file a run looks at. |
match | string or null | yes | A regular expression a file must contain for the check to run on it. Null means no such condition. |
severityGuidance | string | yes | How to choose a severity, in plain words. May be empty. |
enabled | boolean | yes | False while the check is switched off. Only enabled checks run. |
createdAt | string | yes | When it was created. |
updatedAt | string | yes | When it was last changed. |
Nullgap documentation