Nullgap.dev Docs

Administration

Deleting a workspace

What deleting a workspace removes, what is kept, who can do it, and what happens to its members, its address and its GitHub App installation.

Deleting a workspace removes the organisation itself and everything Nullgap stores for it. It is different from erasing data, which empties a workspace and keeps the workspace, its members and its audit log.

#Who can do it

WhoWhereWhat is asked
An owner of the workspaceSettings, General, Delete workspaceThe workspace address typed out, and a fresh second-factor check if the account has a second factor
Nullgap operationsOn a written request from an owner, or at the end of a contractThe same address, and a reason that is recorded

An admin or a member cannot delete a workspace, and neither can an API key of any scope.

A suspended workspace cannot be deleted by its owner. Contact support and it is deleted for you.

#Delete your workspace

  1. Open Settings, stay on General and scroll to Delete workspace.
  2. Choose Delete workspace…. The dialog lists what is removed and what is kept.
  3. Optional: choose Export everything first to download a copy.
  4. Type the workspace address, for example acme, and choose Delete permanently.

If a pull request review, a pentest, a fix run, a skill run, a tool run or a threat model being drafted from the code (on the Context page) is queued or running, the workspace is not deleted and the dialog says so. Wait for the work to finish, or tick Cancel that work, then delete and choose Delete permanently again.

When it is done you are signed in with no workspace. The owners get an e-mail saying that the workspace was deleted, by whom and when.

#What is removed

  • Findings, pull request reviews, pentests, fix runs, reports and their logs.
  • Repositories, code-host connections, uploaded archives and files.
  • Applications with their threat models and project rules, custom checks, custom skills, skill runs and scanning tool runs.
  • Integrations, webhook endpoints, the Slack assistant, API keys and every stored credential. Stored credentials are made unreadable first and then removed.
  • Memberships, invitations, seats, single sign-on and provisioning (SCIM) settings, and verified e-mail domains.
  • Schedules, automations, credits, support requests and the workspace's audit log.

Share links to reports stop working. Outbound webhooks are no longer called, including for events that were waiting to be sent.

#What is kept

KeptWhyFor how long
One entry in Nullgap's own operations log: the workspace's name, address and ID, who deleted it and when, the reason an operator gave, how many records of each kind were removed, and the final checksum of the workspace's audit logSo that the deletion itself is on record, and the removal of the audit log is evidencedAs long as the operations log is kept
The workspace addressSo nobody else can register it and receive links, sign-in pages or installations meant for you90 days, then it is free again
The user accounts of the membersAn account belongs to a person, not to a workspaceUntil the person removes it
The Nullgap GitHub App on your GitHub account, and on our side the installation number and account name, attached to no workspaceOnly you can uninstall an app from your GitHub accountUntil you uninstall it
Invoices and payment records at a payment provider, where there are anyThey are the provider's recordsAs the provider and the law require
Copies inside backups of the service made before the deletionA backup is a copy of the whole service at a point in timeUntil those backups expire

No code, findings, reports or credentials of the workspace are kept outside those backups.

#What happens to people

  • Everyone keeps their account and can still sign in.
  • Someone who belongs to other workspaces keeps working in them. The deleted workspace is simply no longer in their list.
  • Someone for whom this was the only workspace is signed in with none, and can create a new one or accept an invitation to another.
  • Sessions that came through the workspace's own single sign-on end, because they were valid in that workspace only.
  • Pending invitations stop working.

#What happens to the address

The address (the part after the first /, for example acme) is held for 90 days. During that time a new workspace called "Acme" gets another address, such as acme-2, and no existing workspace can be renamed to it. Old links to /acme/… lead nowhere.

After 90 days the address is free for anyone, including you.

#The GitHub App

Deleting a workspace does not uninstall the Nullgap GitHub App from your GitHub account or organisation: an app can only be uninstalled there. Until you do, GitHub keeps sending Nullgap events for the installation. They are accepted and ignored: nothing is reviewed and nothing is stored.

To finish, uninstall the app under Settings, GitHub Apps on GitHub. See connect GitHub.

For GitLab, Bitbucket and Azure DevOps the access token Nullgap held is removed. Webhooks you created in those services for Nullgap stay there until you remove them; deliveries to Nullgap are refused.

#While a deletion is under way

Deleting normally takes a moment. If work had to be cancelled first, or the service was restarted in the middle, it can take longer and finishes by itself. During that time every request to the workspace answers 409 org_deleting, and afterwards 404.

#Through the API

The console sends POST /api/orgs/:org/delete. It needs a console session of an owner; an API key is refused.

{ "confirm": "acme", "cancelJobs": false }
AnswerMeaning
200Deleted. The body has removed (counts by kind), deletedAt, slugHeldUntil and notified (owners e-mailed).
400 bad_requestconfirm is not the workspace address.
403 step_up_requiredConfirm with your second factor and send the request again.
403 org_suspendedThe workspace is suspended. Contact support.
409 jobs_activeWork is queued or running and cancelJobs was not true. Nothing was changed.
409 jobs_stoppingRunning work was told to stop and has not stopped yet. The deletion has begun and finishes by itself.

See the data protection reference.

Nullgap documentation