Nullgap.dev Docs

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.

OperationMethod and pathWho may call it
Get the data-handling statementsGET /api/trustnone
Get the data protection overviewGET /api/orgs/{org}/complianceread
Export all dataGET /api/orgs/{org}/data/exportconsole only (owner)
Erase dataPOST /api/orgs/{org}/data/eraseconsole only (owner)
Before deleting the workspaceGET /api/orgs/{org}/deleteconsole only (owner)
Delete the workspacePOST /api/orgs/{org}/deleteconsole 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

NameTypeRequiredDescription
orgstringyesThe 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

NameTypeRequiredDescription
orgstringyesThe organisation slug.

Answer (200, application/json)

The export file.

FieldTypeAlways presentDescription
exportedAtstringyesWhen the file was made.
organisationobjectyesThe organisation and its settings.
organisation.idstringyesThe organisation's id.
organisation.slugstringyesIts slug.
organisation.namestringyesIts name.
organisation.planstringyesIts plan. One of: none, trial, pro, enterprise.
organisation.createdAtstringyesWhen it was created.
organisation.settingsOrgSettingsyes
repositoryarray of objectyesThe repositories.
applicationarray of objectyesThe applications, with their threat models.
reviewarray of objectyesThe pull request reviews.
pentestarray of objectyesThe pentests.
findingarray of objectyesThe findings.
dismissalarray of objectyesWhat Nullgap remembers about dismissed findings.
suppressionarray of objectyesFindings that were held back because they match an earlier dismissal.
reportarray of objectyesThe pentest reports.
automationarray of objectyesThe automations.
runarray of objectyesThe fix runs.
logarray of objectyesThe logs of reviews and pentests.
auditarray of objectyesThe audit log.
creditarray of objectyesThe credit ledger.
memberarray of objectyesThe memberships: who belongs to the organisation and with which role.
seatarray of objectyesThe assigned pull request review seats.
schedulearray of objectyesThe pentest schedules.
oauthgrantarray of objectnoThe 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.
supportarray of objectyesThe support requests, each with its messages.
supportgrantarray of objectyesThe times support was given access to the workspace.
customskillarray of objectyesThe organisation's own skills, each with the text of its SKILL.md.
skillsettingsarray of objectyesWhich skills are switched off, the per-repository overrides and the permitted tools. Empty until something was changed.
skillrunarray of objectyesThe on-demand skill runs with their output and the text that was supplied to them.
reportsnaparray of objectyesWhat 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

NameTypeRequiredDescription
orgstringyesThe organisation slug.

Request body (application/json)

FieldTypeRequiredDescription
scopestringyesHow much to erase. One of: findings, all.
confirmstringyesThe organisation's slug, typed out, to confirm.

Answer (200, application/json)

FieldTypeAlways presentDescription
deletedobjectyesHow 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

StatusCodeWhen
400bad_requestscope is not findings or all, or confirm is not the organisation's slug.
403step_up_requiredYour 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

NameTypeRequiredDescription
orgstringyesThe organisation slug.

Answer (200, application/json)

FieldTypeAlways presentDescription
activeJobsintegeryesJobs 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

NameTypeRequiredDescription
orgstringyesThe organisation slug.

Request body (application/json)

FieldTypeRequiredDescription
confirmstringyesThe organisation's slug, typed out, to confirm.
cancelJobsbooleannoCancel queued and running work first, instead of refusing while there is any. Default false.

Answer (200, application/json)

FieldTypeAlways presentDescription
slugstringyesThe slug of the organisation that was deleted.
namestringyesIts name.
deletedAtstringyesWhen the deletion finished.
removedobjectyesHow many records of each kind were removed, keyed by a plain plural name. Kinds with nothing to remove are left out.
slugHeldUntilstringyesUntil when nobody else can register the slug.
notifiedintegeryesHow 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

StatusCodeWhen
400bad_requestconfirm is not the organisation's slug, or cancelJobs is not true or false.
403step_up_requiredYour 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.
403org_suspendedThe organisation is suspended. Contact support to have it deleted.
409jobs_activeWork is queued or running and cancelJobs was not set. Nothing was changed.
409jobs_stoppingRunning 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.

FieldTypeAlways presentDescription
guaranteesarray of objectyesThe four headline statements about how code and AI processing are handled.
guarantees[].idstringyesThe statement's identifier.
guarantees[].titlestringyesThe statement in a few words.
guarantees[].detailstringyesThe statement in full.
frameworksarray of FrameworkInfoyesEvery framework an organisation can select.
storedarray of stringyesWhat Nullgap stores, in plain words.
neverStoredarray of stringyesWhat Nullgap does not store, in plain words.
disclaimerstringyesA 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.

FieldTypeAlways presentDescription
frameworkstringyesThe framework selected in the data protection settings, or none.
availablearray of FrameworkInfoyesEvery framework that can be selected.
clauseMappedbooleanyesTrue when a provision-by-provision mapping is published for the selected framework.
frameworkNamestringyesThe name of the selected framework, or a placeholder when none is selected.
frameworkSummarystringyesOne paragraph on what the framework is and what selecting it changes.
guaranteesarray of objectyesThe four headline statements about how code and AI processing are handled, each with whether it is in effect.
guarantees[].idstringyesThe statement's identifier.
guarantees[].titlestringyesThe statement in a few words.
guarantees[].detailstringyesThe statement in full.
guarantees[].activebooleanyesTrue when the statement is confirmed as in effect on this server for this organisation.
controlsarray of ComplianceControlyesEvery control, with its status for this organisation.
retentionDaysinteger or nullyesThe retention period from the data protection settings, in days. Null when data is kept until deleted by hand.
lastPurgeAtstring or nullyesWhen automatic deletion last ran for this organisation. Null when it never has.
zeroRetentionCoverageinteger or nullyesThe 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.
disclaimerstringyesA notice on what this overview is and is not. Show it wherever the overview is shown.

#OrgSettings

How Nullgap behaves for an organisation.

FieldTypeAlways presentDescription
postChecksbooleanyesShow progress and results as a check on the commit.
postCommentsbooleanyesPost the summary and the inline finding comments on the pull request.
postSystemCommentsbooleanyesPost notices about skipped reviews, limits and configuration problems on the pull request.
failCheckAtstringyesThe check fails when a finding is at or above this severity. off never fails it.
commentStylestringyesHow much detail pull request comments carry. One of: concise, standard, detailed.
filtersarray of ReviewFilteryesRules that decide which pull requests are reviewed. Empty means every pull request.
slaobjectyesThe resolution window and target for each severity.
sla.criticalobjectyesThe window and target for one severity.
sla.critical.daysintegeryesDays allowed to resolve a finding of this severity, counted from when it was first seen.
sla.critical.targetintegeryesThe share of findings, 0 to 100, that should be resolved within that many days.
sla.highobjectyesThe window and target for one severity.
sla.high.daysintegeryesDays allowed to resolve a finding of this severity, counted from when it was first seen.
sla.high.targetintegeryesThe share of findings, 0 to 100, that should be resolved within that many days.
sla.mediumobjectyesThe window and target for one severity.
sla.medium.daysintegeryesDays allowed to resolve a finding of this severity, counted from when it was first seen.
sla.medium.targetintegeryesThe share of findings, 0 to 100, that should be resolved within that many days.
sla.lowobjectyesThe window and target for one severity.
sla.low.daysintegeryesDays allowed to resolve a finding of this severity, counted from when it was first seen.
sla.low.targetintegeryesThe share of findings, 0 to 100, that should be resolved within that many days.
minSecurityScoreinteger or nullyesThe security score, 0 to 100, the organisation aims to stay above. Null when no minimum is set.
requireMfabooleanyesTrue when every member must have multi-factor sign-in.
overagebooleanyesTrue to allow pull request reviews beyond the included number, billed per review.
unverifiedFixesbooleannoWhether 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.
dataProtectionDataProtectionSettingsyes
supplyChainSupplyChainPolicynoThe 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.
customChecksarray of CustomChecknoThe 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.

FieldTypeAlways presentDescription
idstringyesThe identifier to send as dataProtection.framework.
namestringyesThe full name of the law or standard.
regionstringyesWhere it applies.
categorystringyesThe kind of framework: a privacy law, an AI governance framework, a security standard, or a sector regime. One of: privacy, ai, security, sector.
summarystringyesOne sentence on what it covers.
mappedbooleanyesTrue 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.

FieldTypeAlways presentDescription
idstringyesThe control's identifier.
titlestringyesThe control in a few words.
descriptionstringyesWhat Nullgap does, in plain words.
statusstringyesenforced: 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.
evidencestring or nullyesWhat backs the status for this organisation right now, in plain words. Null when there is nothing to add.
referencesarray of stringyesThe 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.

FieldTypeAlways presentDescription
kindstringyesWhat the filter looks at: a pull request label, its author, its branch, or a keyword. One of: label, author, branch, keyword.
modestringyesinclude: only matching pull requests are reviewed. exclude: matching pull requests are skipped.
valuestringyesThe label, login, branch or keyword to match. At most 200 characters.

#DataProtectionSettings

How long data is kept and who is contacted about it.

FieldTypeAlways presentDescription
frameworkstringyesThe law or standard the organisation has asked Nullgap to align its data handling with, or none. GET /api/trust lists them with their names.
retentionDaysinteger or nullyesReviews, 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.
privacyContactEmailstring or nullyesWho privacy questions and requests from data subjects go to at the organisation. Null when not set.
breachContactEmailstring or nullyesWho 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.

FieldTypeAlways presentDescription
blockedPackagesarray of stringyesPackages that must not be used. Each entry is a name, name@version, ecosystem:name, or a prefix ending in * such as @acme/*.
allowedPackagesarray of stringyesPackages exempt from the rules below and not raised as suspicious. Being listed here never clears a malicious verdict.
minAgeDaysinteger or nullyesVersions published fewer than this many days ago are blocked. Null means no minimum.
blockInstallScriptsbooleanyesTrue to block packages that run a script at install time, unless they are listed in installScriptAllowlist.
installScriptAllowlistarray of stringyesPackages that may run a script at install time even when blockInstallScripts is on.
allowedRegistriesarray of stringyesRegistry 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.

FieldTypeAlways presentDescription
idstringyesThe check id.
namestringyesShown on the findings this check produces. One line.
briefstringyesWhat to look for, in plain words.
notFindingstringyesWhat does not count as a finding. May be empty.
filePatternsarray of stringyesThe files the check runs on, as glob patterns. Empty means any file a run looks at.
matchstring or nullyesA regular expression a file must contain for the check to run on it. Null means no such condition.
severityGuidancestringyesHow to choose a severity, in plain words. May be empty.
enabledbooleanyesFalse while the check is switched off. Only enabled checks run.
createdAtstringyesWhen it was created.
updatedAtstringyesWhen it was last changed.

Nullgap documentation