Nullgap.dev Docs

API reference

Support

How to reach Nullgap support, the requests you sent, and the permission for support to look at your workspace.

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 how to reach supportGET /api/support/infonone
List support requestsGET /api/orgs/{org}/support/requestsconsole only
Open a support requestPOST /api/orgs/{org}/support/requestsconsole only
Get a support requestGET /api/orgs/{org}/support/requests/{id}console only
Reply on a support requestPOST /api/orgs/{org}/support/requests/{id}/messagesconsole only
Resolve a support requestPOST /api/orgs/{org}/support/requests/{id}/resolveconsole only
Reopen a support requestPOST /api/orgs/{org}/support/requests/{id}/reopenconsole only
Get support accessGET /api/orgs/{org}/support/accessadmin
Give support accessPOST /api/orgs/{org}/support/accessconsole only (admin)
End support accessDELETE /api/orgs/{org}/support/access/{id}admin
List requests by support for accessGET /api/orgs/{org}/support/access-requestsadmin
Approve a request by support for accessPOST /api/orgs/{org}/support/access-requests/{id}/approveconsole only (admin)
Decline a request by support for accessPOST /api/orgs/{org}/support/access-requests/{id}/declineconsole only (admin)
Create a diagnostic bundlePOST /api/orgs/{org}/support/diagnosticsconsole only (admin)
Get a diagnostic bundleGET /api/orgs/{org}/support/diagnostics/{diagnostic}admin
List the diagnostic bundles of a requestGET /api/orgs/{org}/support/requests/{id}/diagnosticsadmin
Attach a diagnostic bundle to a requestPOST /api/orgs/{org}/support/requests/{id}/diagnostics/{diagnostic}console only (admin)
Get a pending ownership transferGET /api/orgs/{org}/ownership-transferconsole only (owner)
Cancel a pending ownership transferPOST /api/orgs/{org}/ownership-transfer/cancelconsole only (owner)

#Get how to reach support

GET /api/support/info

Returns the support address, the status page and the documentation address as the operator of this server set them. No key is needed, so an error page can show it to someone who cannot sign in.

Who may call it: None. No key is needed.

Example request

curl -s \
  "$NULLGAP_URL/api/support/info"

Answer (200, application/json)

A SupportInfo object.

{
  "email": "support@nullgap.example",
  "statusUrl": "https://status.nullgap.example",
  "docsUrl": "https://app.nullgap.example/docs",
  "emailNotices": true
}

#List support requests

GET /api/orgs/{org}/support/requests

Returns support requests, most recently changed first, without their messages. A member sees the requests they opened; an admin or owner sees all of the organisation's. Support is a conversation between people, so no API key may call any of the support request routes.

Who may call it: A signed-in person in the console. No API key may call it.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.

Query parameters

NameTypeRequiredDescription
statusstringnoOnly requests with this status. One of: open, waiting_customer, waiting_support, resolved.
limitintegernoHow many to return, 1 to 200. Default 50.
offsetintegernoHow many to skip from the start. Default 0.

Answer (200, application/json)

FieldTypeAlways presentDescription
itemsarray of SupportRequestyesSupport requests, at most limit of them.
totalintegeryesHow many match in all, before limit and offset.
{
  "items": [
    {
      "id": "sup_6b2f9d1c4a7e",
      "subject": "A review has been queued for an hour",
      "category": "not_working",
      "urgency": "blocking",
      "status": "waiting_customer",
      "context": {
        "page": "/acme/findings/fnd_8f3a2c9d1b4e",
        "findingId": "fnd_8f3a2c9d1b4e",
        "reviewId": "rev_2a6d9f1c4b7e",
        "pentestId": "pen_7c2e9a41b6d0",
        "requestRef": "req_Zk3vQp81LmNx"
      },
      "openedBy": {
        "userId": "usr_4c1d9a7be203",
        "name": "Dana Okafor",
        "email": "dana@acme.example"
      },
      "createdAt": "2026-11-16T09:30:00.000Z",
      "updatedAt": "2026-11-16T10:05:00.000Z",
      "resolvedAt": "2026-11-16T11:00:00.000Z",
      "messageCount": 3,
      "lastMessageAt": "2026-11-16T10:05:00.000Z",
      "lastFrom": "support"
    }
  ],
  "total": 42
}

Errors specific to this call

StatusCodeWhen
403forbiddenThe call was made with an API key. This is something a signed-in person does.
400bad_requeststatus is not one of the statuses.

#Open a support request

POST /api/orgs/{org}/support/requests

Sends a request to Nullgap support and starts its thread with your message. You get an e-mail confirming it when this server sends e-mail; replies appear in the console under Help and are announced the same way. Attaching a finding, review or pentest in context tells support what you are looking at; it does not let them open it. For that, give support access. An attached id that is not one of the organisation's is left out, not refused. This works while a workspace is suspended. One person can open 5 requests an hour and an organisation 20, unless the operator of the server set other limits.

Who may call it: A signed-in person in the console. No API key may call it.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.

Request body (application/json)

FieldTypeRequiredDescription
subjectstringyesOne line saying what it is about. 3 to 150 characters.
categorystringyesWhat kind of request it is. One of: how_to, not_working, finding_wrong, billing, security, other.
urgencystringyesnormal, blocking (it stops your work) or incident (a security incident in production).
messagestringyesThe message, in plain text. 1 to 5000 characters.
contextSupportContextno
supportAccessobjectnoAdmins only: let support look at the workspace for this request as well. The access ends when the request is resolved. Needs a second-factor check in the last 15 minutes, like giving access under Help.
supportAccess.hoursintegeryesHow long support may look: 1 hour, 24 hours or 168 hours (7 days). One of: 1, 24, 168.
supportAccess.actionsbooleannoAlso let support carry out the listed support actions (start a failed job again, cancel a stuck run, refresh a connection's repositories, send an invitation again). Left out: reading only.

Answer (200, application/json)

A SupportRequestDetail object.

{
  "id": "sup_6b2f9d1c4a7e",
  "subject": "A review has been queued for an hour",
  "category": "not_working",
  "urgency": "blocking",
  "status": "waiting_customer",
  "context": {
    "page": "/acme/findings/fnd_8f3a2c9d1b4e",
    "findingId": "fnd_8f3a2c9d1b4e",
    "reviewId": "rev_2a6d9f1c4b7e",
    "pentestId": "pen_7c2e9a41b6d0",
    "requestRef": "req_Zk3vQp81LmNx"
  },
  "openedBy": {
    "userId": "usr_4c1d9a7be203",
    "name": "Dana Okafor",
    "email": "dana@acme.example"
  },
  "createdAt": "2026-11-16T09:30:00.000Z",
  "updatedAt": "2026-11-16T10:05:00.000Z",
  "resolvedAt": "2026-11-16T11:00:00.000Z",
  "messageCount": 3,
  "lastMessageAt": "2026-11-16T10:05:00.000Z",
  "lastFrom": "support",
  "messages": [
    {
      "id": "msg_1f8c3a7d9b2e",
      "at": "2026-11-16T09:30:00.000Z",
      "from": "customer",
      "author": "Dana Okafor",
      "text": "The review of pull request 128 has shown \"queued\" since nine this morning."
    }
  ]
}

Errors specific to this call

StatusCodeWhen
403forbiddenThe call was made with an API key. This is something a signed-in person does.
400bad_requestA field is missing or outside its limits, context.page is not a path inside the console, or an id in context is not shaped like an id.
403forbiddensupportAccess was sent by someone who is not an admin or owner.
403step_up_requiredsupportAccess was sent and your second factor was last checked more than 15 minutes ago on this session.
429rate_limitedToo many new requests in the last hour, by you or by your organisation as a whole. Wait and try again.

#Get a support request

GET /api/orgs/{org}/support/requests/{id}

Returns one request with its whole thread, oldest message first.

Who may call it: A signed-in person in the console. No API key may call it.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.
idstringyesThe support request id.

Answer (200, application/json)

A SupportRequestDetail object.

{
  "id": "sup_6b2f9d1c4a7e",
  "subject": "A review has been queued for an hour",
  "category": "not_working",
  "urgency": "blocking",
  "status": "waiting_customer",
  "context": {
    "page": "/acme/findings/fnd_8f3a2c9d1b4e",
    "findingId": "fnd_8f3a2c9d1b4e",
    "reviewId": "rev_2a6d9f1c4b7e",
    "pentestId": "pen_7c2e9a41b6d0",
    "requestRef": "req_Zk3vQp81LmNx"
  },
  "openedBy": {
    "userId": "usr_4c1d9a7be203",
    "name": "Dana Okafor",
    "email": "dana@acme.example"
  },
  "createdAt": "2026-11-16T09:30:00.000Z",
  "updatedAt": "2026-11-16T10:05:00.000Z",
  "resolvedAt": "2026-11-16T11:00:00.000Z",
  "messageCount": 3,
  "lastMessageAt": "2026-11-16T10:05:00.000Z",
  "lastFrom": "support",
  "messages": [
    {
      "id": "msg_1f8c3a7d9b2e",
      "at": "2026-11-16T09:30:00.000Z",
      "from": "customer",
      "author": "Dana Okafor",
      "text": "The review of pull request 128 has shown \"queued\" since nine this morning."
    }
  ]
}

Errors specific to this call

StatusCodeWhen
403forbiddenThe call was made with an API key. This is something a signed-in person does.
404not_foundNo request with that id, or it was opened by someone else and you are not an admin of the organisation.

#Reply on a support request

POST /api/orgs/{org}/support/requests/{id}/messages

Adds your message to the thread and sets the request to waiting_support. Writing on a resolved request reopens it. A thread holds up to 200 messages. One person can send 30 replies an hour and an organisation 100, unless the operator of the server set other limits.

Who may call it: A signed-in person in the console. No API key may call it.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.
idstringyesThe support request id.

Request body (application/json)

FieldTypeRequiredDescription
messagestringyesThe message, in plain text. 1 to 5000 characters.

Answer (200, application/json)

A SupportRequestDetail object.

{
  "id": "sup_6b2f9d1c4a7e",
  "subject": "A review has been queued for an hour",
  "category": "not_working",
  "urgency": "blocking",
  "status": "waiting_customer",
  "context": {
    "page": "/acme/findings/fnd_8f3a2c9d1b4e",
    "findingId": "fnd_8f3a2c9d1b4e",
    "reviewId": "rev_2a6d9f1c4b7e",
    "pentestId": "pen_7c2e9a41b6d0",
    "requestRef": "req_Zk3vQp81LmNx"
  },
  "openedBy": {
    "userId": "usr_4c1d9a7be203",
    "name": "Dana Okafor",
    "email": "dana@acme.example"
  },
  "createdAt": "2026-11-16T09:30:00.000Z",
  "updatedAt": "2026-11-16T10:05:00.000Z",
  "resolvedAt": "2026-11-16T11:00:00.000Z",
  "messageCount": 3,
  "lastMessageAt": "2026-11-16T10:05:00.000Z",
  "lastFrom": "support",
  "messages": [
    {
      "id": "msg_1f8c3a7d9b2e",
      "at": "2026-11-16T09:30:00.000Z",
      "from": "customer",
      "author": "Dana Okafor",
      "text": "The review of pull request 128 has shown \"queued\" since nine this morning."
    }
  ]
}

Errors specific to this call

StatusCodeWhen
403forbiddenThe call was made with an API key. This is something a signed-in person does.
404not_foundNo request with that id, or it was opened by someone else and you are not an admin of the organisation.
409thread_fullThe thread has 200 messages. Open a new request and mention this one.
429rate_limitedToo many replies in the last hour, by you or by your organisation as a whole. Wait and try again.

#Resolve a support request

POST /api/orgs/{org}/support/requests/{id}/resolve

Closes the request from your side. Support access that was given for this request ends at the same moment. Resolving a request that is already resolved changes nothing but its resolution time. Takes no body.

Who may call it: A signed-in person in the console. No API key may call it.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.
idstringyesThe support request id.

Answer (200, application/json)

A SupportRequestDetail object.

{
  "id": "sup_6b2f9d1c4a7e",
  "subject": "A review has been queued for an hour",
  "category": "not_working",
  "urgency": "blocking",
  "status": "waiting_customer",
  "context": {
    "page": "/acme/findings/fnd_8f3a2c9d1b4e",
    "findingId": "fnd_8f3a2c9d1b4e",
    "reviewId": "rev_2a6d9f1c4b7e",
    "pentestId": "pen_7c2e9a41b6d0",
    "requestRef": "req_Zk3vQp81LmNx"
  },
  "openedBy": {
    "userId": "usr_4c1d9a7be203",
    "name": "Dana Okafor",
    "email": "dana@acme.example"
  },
  "createdAt": "2026-11-16T09:30:00.000Z",
  "updatedAt": "2026-11-16T10:05:00.000Z",
  "resolvedAt": "2026-11-16T11:00:00.000Z",
  "messageCount": 3,
  "lastMessageAt": "2026-11-16T10:05:00.000Z",
  "lastFrom": "support",
  "messages": [
    {
      "id": "msg_1f8c3a7d9b2e",
      "at": "2026-11-16T09:30:00.000Z",
      "from": "customer",
      "author": "Dana Okafor",
      "text": "The review of pull request 128 has shown \"queued\" since nine this morning."
    }
  ]
}

Errors specific to this call

StatusCodeWhen
403forbiddenThe call was made with an API key. This is something a signed-in person does.
404not_foundNo request with that id, or it was opened by someone else and you are not an admin of the organisation.

#Reopen a support request

POST /api/orgs/{org}/support/requests/{id}/reopen

Puts a resolved request back to waiting_support. Takes no body.

Who may call it: A signed-in person in the console. No API key may call it.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.
idstringyesThe support request id.

Answer (200, application/json)

A SupportRequestDetail object.

{
  "id": "sup_6b2f9d1c4a7e",
  "subject": "A review has been queued for an hour",
  "category": "not_working",
  "urgency": "blocking",
  "status": "waiting_customer",
  "context": {
    "page": "/acme/findings/fnd_8f3a2c9d1b4e",
    "findingId": "fnd_8f3a2c9d1b4e",
    "reviewId": "rev_2a6d9f1c4b7e",
    "pentestId": "pen_7c2e9a41b6d0",
    "requestRef": "req_Zk3vQp81LmNx"
  },
  "openedBy": {
    "userId": "usr_4c1d9a7be203",
    "name": "Dana Okafor",
    "email": "dana@acme.example"
  },
  "createdAt": "2026-11-16T09:30:00.000Z",
  "updatedAt": "2026-11-16T10:05:00.000Z",
  "resolvedAt": "2026-11-16T11:00:00.000Z",
  "messageCount": 3,
  "lastMessageAt": "2026-11-16T10:05:00.000Z",
  "lastFrom": "support",
  "messages": [
    {
      "id": "msg_1f8c3a7d9b2e",
      "at": "2026-11-16T09:30:00.000Z",
      "from": "customer",
      "author": "Dana Okafor",
      "text": "The review of pull request 128 has shown \"queued\" since nine this morning."
    }
  ]
}

Errors specific to this call

StatusCodeWhen
403forbiddenThe call was made with an API key. This is something a signed-in person does.
404not_foundNo request with that id, or it was opened by someone else and you are not an admin of the organisation.
409not_resolvedThe request is not resolved.

#Get support access

GET /api/orgs/{org}/support/access

Returns whether Nullgap support can look at the workspace now, and up to 10 earlier grants. Without an active grant, the people at Nullgap can read the messages of a support request and nothing else of the organisation's.

Who may call it: An API key with the admin scope.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.

Example request

curl -s -H "Authorization: Bearer $NULLGAP_API_KEY" \
  "$NULLGAP_URL/api/orgs/$NULLGAP_ORG/support/access"

Answer (200, application/json)

A SupportAccess object.

{
  "active": {
    "id": "sgr_8d3b1f6a2c9e",
    "grantedBy": "dana@acme.example",
    "createdAt": "2026-11-16T09:30:00.000Z",
    "expiresAt": "2026-11-17T09:30:00.000Z",
    "requestId": "sup_6b2f9d1c4a7e",
    "revokedAt": "2026-11-16T09:30:00.000Z",
    "revokedBy": "dana@acme.example",
    "active": true,
    "actions": false
  },
  "history": [
    {
      "id": "sgr_8d3b1f6a2c9e",
      "grantedBy": "dana@acme.example",
      "createdAt": "2026-11-16T09:30:00.000Z",
      "expiresAt": "2026-11-17T09:30:00.000Z",
      "requestId": "sup_6b2f9d1c4a7e",
      "revokedAt": "2026-11-16T09:30:00.000Z",
      "revokedBy": "dana@acme.example",
      "active": true,
      "actions": false
    }
  ],
  "pendingRequest": {
    "id": "sar_4c1e7b9d2a6f",
    "status": "pending",
    "reason": "To see why the nightly pentest stops at the checkout step.",
    "hours": 24,
    "actions": false,
    "requestId": "sup_6b2f9d1c4a7e",
    "createdAt": "2026-11-16T09:30:00.000Z",
    "expiresAt": "2026-11-19T09:30:00.000Z",
    "decidedAt": "2026-11-16T09:30:00.000Z",
    "decidedBy": "dana@acme.example"
  }
}

#Give support access

POST /api/orgs/{org}/support/access

Lets Nullgap support read the workspace for 1 hour, 24 hours or 7 days: findings, reviews, pentests, the organisation's review settings and its list of repositories. Stored credentials are not reachable and nothing can be changed. There is one grant at a time: a new one replaces the one before it. A grant tied to a support request ends when that request is resolved; any grant can be ended early. Giving and ending access are written to the audit log, and so is each time support opens something under it. This is a decision a person takes: it needs an admin or owner signed in to the console, with a second-factor check in the last 15 minutes when their account has one.

Who may call it: A signed-in admin or owner in the console. No API key may call it.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.

Request body (application/json)

FieldTypeRequiredDescription
hoursintegeryesHow long the access lasts: 1 hour, 24 hours or 168 hours (7 days). One of: 1, 24, 168.
requestIdstringnoA support request to tie the grant to. Left out: the grant runs its full time unless ended.
actionsbooleannoAlso allow the listed support actions. Left out: reading only.

Answer (200, application/json)

A SupportGrant object.

{
  "id": "sgr_8d3b1f6a2c9e",
  "grantedBy": "dana@acme.example",
  "createdAt": "2026-11-16T09:30:00.000Z",
  "expiresAt": "2026-11-17T09:30:00.000Z",
  "requestId": "sup_6b2f9d1c4a7e",
  "revokedAt": "2026-11-16T09:30:00.000Z",
  "revokedBy": "dana@acme.example",
  "active": true,
  "actions": false
}

Errors specific to this call

StatusCodeWhen
403forbiddenThe call was made with an API key. This is something a signed-in person does.
403step_up_requiredYour account has a second factor and it was last checked more than 15 minutes ago on this session.
400bad_requesthours is not 1, 24 or 168.
404not_foundNo support request of this organisation has the requestId sent.
409request_resolvedThe request named is resolved. Reopen it first, or give access without naming a request.

#End support access

DELETE /api/orgs/{org}/support/access/{id}

Ends a grant now. From that moment support can open nothing in the workspace. Ending a grant that has already ended or expired changes nothing. Answers with the grant as it now is.

Who may call it: An API key with the admin scope.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.
idstringyesThe grant id.

Example request

curl -s -X DELETE -H "Authorization: Bearer $NULLGAP_API_KEY" \
  "$NULLGAP_URL/api/orgs/$NULLGAP_ORG/support/access/ID"

Answer (200, application/json)

A SupportGrant object.

{
  "id": "sgr_8d3b1f6a2c9e",
  "grantedBy": "dana@acme.example",
  "createdAt": "2026-11-16T09:30:00.000Z",
  "expiresAt": "2026-11-17T09:30:00.000Z",
  "requestId": "sup_6b2f9d1c4a7e",
  "revokedAt": "2026-11-16T09:30:00.000Z",
  "revokedBy": "dana@acme.example",
  "active": true,
  "actions": false
}

Errors specific to this call

StatusCodeWhen
404not_foundNo grant of this organisation has that id.

#List requests by support for access

GET /api/orgs/{org}/support/access-requests

Nullgap support can ask to look at the workspace, giving a reason, a duration and whether it would also like to carry out support actions. Nothing is opened by asking. Returns the request waiting for an answer, if any, and up to 10 earlier ones. A request nobody answers lapses after 72 hours.

Who may call it: An API key with the admin scope.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.

Example request

curl -s -H "Authorization: Bearer $NULLGAP_API_KEY" \
  "$NULLGAP_URL/api/orgs/$NULLGAP_ORG/support/access-requests"

Answer (200, application/json)

A SupportAccessRequests object.

{
  "pending": {
    "id": "sar_4c1e7b9d2a6f",
    "status": "pending",
    "reason": "To see why the nightly pentest stops at the checkout step.",
    "hours": 24,
    "actions": false,
    "requestId": "sup_6b2f9d1c4a7e",
    "createdAt": "2026-11-16T09:30:00.000Z",
    "expiresAt": "2026-11-19T09:30:00.000Z",
    "decidedAt": "2026-11-16T09:30:00.000Z",
    "decidedBy": "dana@acme.example"
  },
  "history": [
    {
      "id": "sar_4c1e7b9d2a6f",
      "status": "pending",
      "reason": "To see why the nightly pentest stops at the checkout step.",
      "hours": 24,
      "actions": false,
      "requestId": "sup_6b2f9d1c4a7e",
      "createdAt": "2026-11-16T09:30:00.000Z",
      "expiresAt": "2026-11-19T09:30:00.000Z",
      "decidedAt": "2026-11-16T09:30:00.000Z",
      "decidedBy": "dana@acme.example"
    }
  ]
}

#Approve a request by support for access

POST /api/orgs/{org}/support/access-requests/{id}/approve

Gives support access, exactly as giving it under Help does: you choose how long and whether support actions are included, whatever the request asked for. The grant is written to the audit log and can be ended at any time. It needs an admin or owner signed in to the console, with a second-factor check in the last 15 minutes when their account has one.

Who may call it: A signed-in admin or owner in the console. No API key may call it.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.
idstringyesThe id of the request for access.

Request body (application/json)

FieldTypeRequiredDescription
hoursintegeryesHow long the access lasts. One of: 1, 24, 168.
actionsbooleanyesAlso allow the listed support actions.

Answer (200, application/json)

FieldTypeAlways presentDescription
requestSupportAccessRequestyes
grantSupportGrantyes
{
  "request": {
    "id": "sar_4c1e7b9d2a6f",
    "status": "pending",
    "reason": "To see why the nightly pentest stops at the checkout step.",
    "hours": 24,
    "actions": false,
    "requestId": "sup_6b2f9d1c4a7e",
    "createdAt": "2026-11-16T09:30:00.000Z",
    "expiresAt": "2026-11-19T09:30:00.000Z",
    "decidedAt": "2026-11-16T09:30:00.000Z",
    "decidedBy": "dana@acme.example"
  },
  "grant": {
    "id": "sgr_8d3b1f6a2c9e",
    "grantedBy": "dana@acme.example",
    "createdAt": "2026-11-16T09:30:00.000Z",
    "expiresAt": "2026-11-17T09:30:00.000Z",
    "requestId": "sup_6b2f9d1c4a7e",
    "revokedAt": "2026-11-16T09:30:00.000Z",
    "revokedBy": "dana@acme.example",
    "active": true,
    "actions": false
  }
}

Errors specific to this call

StatusCodeWhen
403forbiddenThe call was made with an API key. This is something a signed-in person does.
403step_up_requiredYour account has a second factor and it was last checked more than 15 minutes ago on this session.
404not_foundNo request for access of this organisation has that id.
409not_pendingThe request has already been answered, was withdrawn, or has lapsed.

#Decline a request by support for access

POST /api/orgs/{org}/support/access-requests/{id}/decline

Says no. Nothing is opened, and support cannot ask again for 24 hours. Written to the audit log.

Who may call it: A signed-in admin or owner in the console. No API key may call it.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.
idstringyesThe id of the request for access.

Answer (200, application/json)

A SupportAccessRequest object.

{
  "id": "sar_4c1e7b9d2a6f",
  "status": "pending",
  "reason": "To see why the nightly pentest stops at the checkout step.",
  "hours": 24,
  "actions": false,
  "requestId": "sup_6b2f9d1c4a7e",
  "createdAt": "2026-11-16T09:30:00.000Z",
  "expiresAt": "2026-11-19T09:30:00.000Z",
  "decidedAt": "2026-11-16T09:30:00.000Z",
  "decidedBy": "dana@acme.example"
}

Errors specific to this call

StatusCodeWhen
403forbiddenThe call was made with an API key. This is something a signed-in person does.
404not_foundNo request for access of this organisation has that id.
409not_pendingThe request has already been answered, was withdrawn, or has lapsed.

#Create a diagnostic bundle

POST /api/orgs/{org}/support/diagnostics

Builds a summary of the workspace for support to read: versions, the set-up as switches and counts (no names, no secrets), connection and integration health, and recent failures with names, code and secrets removed from the reasons. Finding titles are in it only with includeFindings; code and proof never are. Nothing is sent by creating one: read it, then attach it to a support request. One that is not attached is removed after a day.

Who may call it: A signed-in admin or owner in the console. No API key may call it.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.

Request body (application/json)

FieldTypeRequiredDescription
includeFindingsbooleannoAlso list finding titles, severities and states.

Answer (200, application/json)

A DiagnosticBundle object.

{
  "id": "diag_5e2a8c1f7b3d",
  "createdAt": "2026-11-16T09:30:00.000Z",
  "createdBy": "dana@acme.example",
  "requestId": "sup_6b2f9d1c4a7e",
  "expiresAt": "2026-11-16T09:30:00.000Z",
  "versions": {
    "server": "0.1.0",
    "api": 1
  },
  "workspace": {
    "name": "Acme",
    "slug": "acme",
    "plan": "pro",
    "suspended": false,
    "members": 4,
    "repositories": 3,
    "reviewEnabledRepositories": 2
  },
  "configuration": {},
  "connections": [
    {
      "provider": "github",
      "state": "connected",
      "repositories": 3,
      "lastActivityAt": "2026-11-16T09:30:00.000Z",
      "lastErrorClass": "checkout"
    }
  ],
  "integrations": [
    {
      "kind": "jira",
      "state": "configured"
    }
  ],
  "jobs": {
    "queued": 0,
    "running": 0,
    "failed": 1,
    "dead": 0
  },
  "recentFailures": [
    {
      "at": "2026-11-16T09:30:00.000Z",
      "kind": "review",
      "error": {
        "class": "timeout",
        "text": "The review took too long"
      }
    }
  ],
  "findings": [
    {
      "id": "fnd_1",
      "title": "SQL injection in order lookup",
      "severity": "high",
      "state": "open"
    }
  ]
}

Errors specific to this call

StatusCodeWhen
403forbiddenThe call was made with an API key. This is something a signed-in person does.
429rate_limitedTen bundles are waiting to be attached. Attach one, or wait a day.

#Get a diagnostic bundle

GET /api/orgs/{org}/support/diagnostics/{diagnostic}

Returns one bundle exactly as support would read it.

Who may call it: An API key with the admin scope.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.
diagnosticstringyesThe bundle id.

Example request

curl -s -H "Authorization: Bearer $NULLGAP_API_KEY" \
  "$NULLGAP_URL/api/orgs/$NULLGAP_ORG/support/diagnostics/DIAGNOSTIC"

Answer (200, application/json)

A DiagnosticBundle object.

{
  "id": "diag_5e2a8c1f7b3d",
  "createdAt": "2026-11-16T09:30:00.000Z",
  "createdBy": "dana@acme.example",
  "requestId": "sup_6b2f9d1c4a7e",
  "expiresAt": "2026-11-16T09:30:00.000Z",
  "versions": {
    "server": "0.1.0",
    "api": 1
  },
  "workspace": {
    "name": "Acme",
    "slug": "acme",
    "plan": "pro",
    "suspended": false,
    "members": 4,
    "repositories": 3,
    "reviewEnabledRepositories": 2
  },
  "configuration": {},
  "connections": [
    {
      "provider": "github",
      "state": "connected",
      "repositories": 3,
      "lastActivityAt": "2026-11-16T09:30:00.000Z",
      "lastErrorClass": "checkout"
    }
  ],
  "integrations": [
    {
      "kind": "jira",
      "state": "configured"
    }
  ],
  "jobs": {
    "queued": 0,
    "running": 0,
    "failed": 1,
    "dead": 0
  },
  "recentFailures": [
    {
      "at": "2026-11-16T09:30:00.000Z",
      "kind": "review",
      "error": {
        "class": "timeout",
        "text": "The review took too long"
      }
    }
  ],
  "findings": [
    {
      "id": "fnd_1",
      "title": "SQL injection in order lookup",
      "severity": "high",
      "state": "open"
    }
  ]
}

Errors specific to this call

StatusCodeWhen
404not_foundNo bundle of this organisation has that id, or it was never attached and has been removed.

#List the diagnostic bundles of a request

GET /api/orgs/{org}/support/requests/{id}/diagnostics

The bundles attached to one support request, which support can read.

Who may call it: An API key with the admin scope.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.
idstringyesThe support request id.

Example request

curl -s -H "Authorization: Bearer $NULLGAP_API_KEY" \
  "$NULLGAP_URL/api/orgs/$NULLGAP_ORG/support/requests/ID/diagnostics"

Answer (200, application/json)

An array of DiagnosticBundle.

[
  {
    "id": "diag_5e2a8c1f7b3d",
    "createdAt": "2026-11-16T09:30:00.000Z",
    "createdBy": "dana@acme.example",
    "requestId": "sup_6b2f9d1c4a7e",
    "expiresAt": "2026-11-16T09:30:00.000Z",
    "versions": {
      "server": "0.1.0",
      "api": 1
    },
    "workspace": {
      "name": "Acme",
      "slug": "acme",
      "plan": "pro",
      "suspended": false,
      "members": 4,
      "repositories": 3,
      "reviewEnabledRepositories": 2
    },
    "configuration": {},
    "connections": [
      {
        "provider": "github",
        "state": "connected",
        "repositories": 3,
        "lastActivityAt": "2026-11-16T09:30:00.000Z",
        "lastErrorClass": "checkout"
      }
    ],
    "integrations": [
      {
        "kind": "jira",
        "state": "configured"
      }
    ],
    "jobs": {
      "queued": 0,
      "running": 0,
      "failed": 1,
      "dead": 0
    },
    "recentFailures": [
      {
        "at": "2026-11-16T09:30:00.000Z",
        "kind": "review",
        "error": {
          "class": "timeout",
          "text": "The review took too long"
        }
      }
    ],
    "findings": [
      {
        "id": "fnd_1",
        "title": "SQL injection in order lookup",
        "severity": "high",
        "state": "open"
      }
    ]
  }
]

Errors specific to this call

StatusCodeWhen
404not_foundNo request of this organisation has that id.

#Attach a diagnostic bundle to a request

POST /api/orgs/{org}/support/requests/{id}/diagnostics/{diagnostic}

Sends the bundle to support with the request. From then on support can read it, and it is kept with the request.

Who may call it: A signed-in admin or owner in the console. No API key may call it.

Path parameters

NameTypeRequiredDescription
orgstringyesThe organisation slug.
idstringyesThe support request id.
diagnosticstringyesThe bundle id.

Answer (200, application/json)

A DiagnosticBundle object.

{
  "id": "diag_5e2a8c1f7b3d",
  "createdAt": "2026-11-16T09:30:00.000Z",
  "createdBy": "dana@acme.example",
  "requestId": "sup_6b2f9d1c4a7e",
  "expiresAt": "2026-11-16T09:30:00.000Z",
  "versions": {
    "server": "0.1.0",
    "api": 1
  },
  "workspace": {
    "name": "Acme",
    "slug": "acme",
    "plan": "pro",
    "suspended": false,
    "members": 4,
    "repositories": 3,
    "reviewEnabledRepositories": 2
  },
  "configuration": {},
  "connections": [
    {
      "provider": "github",
      "state": "connected",
      "repositories": 3,
      "lastActivityAt": "2026-11-16T09:30:00.000Z",
      "lastErrorClass": "checkout"
    }
  ],
  "integrations": [
    {
      "kind": "jira",
      "state": "configured"
    }
  ],
  "jobs": {
    "queued": 0,
    "running": 0,
    "failed": 1,
    "dead": 0
  },
  "recentFailures": [
    {
      "at": "2026-11-16T09:30:00.000Z",
      "kind": "review",
      "error": {
        "class": "timeout",
        "text": "The review took too long"
      }
    }
  ],
  "findings": [
    {
      "id": "fnd_1",
      "title": "SQL injection in order lookup",
      "severity": "high",
      "state": "open"
    }
  ]
}

Errors specific to this call

StatusCodeWhen
403forbiddenThe call was made with an API key. This is something a signed-in person does.
404not_foundNo request or bundle of this organisation has that id.
409already_attachedThe bundle is attached to another request.

#Get a pending ownership transfer

GET /api/orgs/{org}/ownership-transfer

When the owners of an organisation have all left, Nullgap support can, on a verified request, make an existing member an owner. The owners are e-mailed and the change waits 72 hours, during which any owner can cancel it. Owners only.

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
pendingOwnershipTransfer or nullyes
{
  "pending": {
    "id": "otr_7a2c9e1b4d6f",
    "status": "pending",
    "toEmail": "sam@acme.example",
    "createdAt": "2026-11-16T09:30:00.000Z",
    "effectiveAt": "2026-11-19T09:30:00.000Z",
    "completedAt": "2026-11-16T09:30:00.000Z",
    "cancelledAt": "2026-11-16T09:30:00.000Z"
  }
}

#Cancel a pending ownership transfer

POST /api/orgs/{org}/ownership-transfer/cancel

Stops a change of owner that support started. Owners only; written to 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)

A OwnershipTransfer object.

{
  "id": "otr_7a2c9e1b4d6f",
  "status": "pending",
  "toEmail": "sam@acme.example",
  "createdAt": "2026-11-16T09:30:00.000Z",
  "effectiveAt": "2026-11-19T09:30:00.000Z",
  "completedAt": "2026-11-16T09:30:00.000Z",
  "cancelledAt": "2026-11-16T09:30:00.000Z"
}

Errors specific to this call

StatusCodeWhen
403forbiddenThe call was made with an API key. This is something a signed-in person does.
409no_transferNo ownership transfer is waiting.

#Objects

The objects the operations above take and return.

#SupportInfo

How to reach support, as the operator of this server configured it.

FieldTypeAlways presentDescription
emailstring or nullyesThe support address. Null when the operator of this server set none: requests are then made and answered in the console only.
statusUrlstring or nullyesThe address of the service status page, when there is one.
docsUrlstring or nullyesThe address of the documentation, when the operator set one.
emailNoticesbooleanyesWhether this server sends e-mail at all, and so whether a reply from support is announced by e-mail.

#SupportRequest

A request to Nullgap support, without its messages.

FieldTypeAlways presentDescription
idstringyesThe request id. Quote it in any other conversation with support.
subjectstringyesOne line saying what it is about.
categorystringyesWhat kind of request it is. One of: how_to, not_working, finding_wrong, billing, security, other.
urgencystringyesnormal, blocking (it stops the person's work) or incident (a security incident in production).
statusstringyesopen: sent, not answered yet. waiting_customer: support answered and waits for you. waiting_support: you answered and wait for support. resolved: closed by either side.
contextSupportContextyes
openedByobjectyesThe member who sent it.
openedBy.userIdstringyesTheir user id.
openedBy.namestringyesTheir name.
openedBy.emailstringyesTheir e-mail address.
createdAtstringyesWhen it was sent.
updatedAtstringyesWhen it last changed.
resolvedAtstring or nullyesWhen it was resolved. Null while it is not.
messageCountintegeryesHow many messages the thread has.
lastMessageAtstringyesWhen the newest message was written.
lastFromstringyesWho wrote the newest message. One of: customer, support.

#SupportContext

What a support request is about. Every field is optional. Attaching an item does not let support open it: that needs support access, given separately.

FieldTypeAlways presentDescription
pagestringnoThe console page the person was on, as a path. Up to 200 characters.
findingIdstringnoA finding the request is about.
reviewIdstringnoA review the request is about.
pentestIdstringnoA pentest the request is about.
requestRefstringnoThe reference of a request that failed (the requestId of an error answer).

#SupportRequestDetail

A support request with its messages.

FieldTypeAlways presentDescription
idstringyesThe request id. Quote it in any other conversation with support.
subjectstringyesOne line saying what it is about.
categorystringyesWhat kind of request it is. One of: how_to, not_working, finding_wrong, billing, security, other.
urgencystringyesnormal, blocking (it stops the person's work) or incident (a security incident in production).
statusstringyesopen: sent, not answered yet. waiting_customer: support answered and waits for you. waiting_support: you answered and wait for support. resolved: closed by either side.
contextSupportContextyes
openedByobjectyesThe member who sent it.
openedBy.userIdstringyesTheir user id.
openedBy.namestringyesTheir name.
openedBy.emailstringyesTheir e-mail address.
createdAtstringyesWhen it was sent.
updatedAtstringyesWhen it last changed.
resolvedAtstring or nullyesWhen it was resolved. Null while it is not.
messageCountintegeryesHow many messages the thread has.
lastMessageAtstringyesWhen the newest message was written.
lastFromstringyesWho wrote the newest message. One of: customer, support.
messagesarray of SupportMessageyesThe thread, oldest first.

#SupportAccess

Whether Nullgap support can look at the workspace now, and when it could before.

FieldTypeAlways presentDescription
activeSupportGrant or nullyes
historyarray of SupportGrantyesUp to 10 earlier grants.
pendingRequestSupportAccessRequest or nullyes

#SupportGrant

An organisation's permission for Nullgap support to look at its workspace, read-only, for a limited time.

FieldTypeAlways presentDescription
idstringyesThe grant id.
grantedBystringyesWho gave it.
createdAtstringyesWhen it was given.
expiresAtstringyesWhen it ends by itself.
requestIdstring or nullyesThe support request it was given for. It ends when that request is resolved.
revokedAtstring or nullyesWhen it was ended early. Null when it was not.
revokedBystring or nullyesWho ended it early.
activebooleanyesTrue when it is neither ended nor expired at the time of the answer.
actionsbooleanyesSupport may also carry out the listed support actions. False: reading only.

#SupportAccessRequests

Requests by support for access: the one waiting for an answer, and earlier ones.

FieldTypeAlways presentDescription
pendingSupportAccessRequest or nullyes
historyarray of SupportAccessRequestyesUp to 10 earlier requests.

#SupportAccessRequest

A request by Nullgap support to look at the workspace. Opens nothing until an admin approves it.

FieldTypeAlways presentDescription
idstringyesThe id of the request.
statusstringyesWhere it stands. One of: pending, approved, declined, expired, withdrawn.
reasonstringyesWhy support would like to look, in support's words.
hoursintegeryesHow long support asked for. One of: 1, 24, 168.
actionsbooleanyesWhether support also asked to carry out support actions.
requestIdstring or nullyesThe support request it belongs to.
createdAtstringyesWhen support asked.
expiresAtstringyesWhen it lapses if nobody answers.
decidedAtstring or nullyesWhen it was answered.
decidedBystring or nullyesWho answered it.

#DiagnosticBundle

A summary of the workspace an admin can attach to a support request. Never holds secrets or code.

FieldTypeAlways presentDescription
idstringyesThe bundle id.
createdAtstringyesWhen it was made.
createdBystringyesWho made it.
requestIdstring or nullyesThe support request it is attached to. Null while it is only a preview.
expiresAtstring or nullyesWhen an unattached bundle is removed. Null once attached.
versionsobjectyes
versions.serverstringyesThe server version.
versions.apiintegeryesThe API version.
workspaceobjectyes
workspace.namestringyesThe workspace name.
workspace.slugstringyesThe workspace address.
workspace.planstringyesThe plan.
workspace.suspendedbooleanyesWhether it is suspended.
workspace.membersintegeryesHow many members.
workspace.repositoriesintegeryesHow many repositories are connected.
workspace.reviewEnabledRepositoriesintegeryesHow many have reviews switched on.
configurationobjectyesThe settings as switches, numbers, short values and counts. No free text, names or secrets.
connectionsarray of objectyes
connections[].providerstringyesThe kind of code host.
connections[].statestringyesWhether it works. One of: connected, failing.
connections[].repositoriesintegeryesHow many repositories it brings.
connections[].lastActivityAtstring or nullyesThe newest review that came through it.
connections[].lastErrorClassstring or nullyesWhat kind of failure, when it is failing.
integrationsarray of objectyes
integrations[].kindstringyesThe kind.
integrations[].statestringyesWhether it works. One of: configured, failing, disabled.
jobsobjectyes
jobs.queuedintegeryesWaiting.
jobs.runningintegeryesRunning.
jobs.failedintegeryesFailed in the last 14 days.
jobs.deadintegeryesGave up after retries.
recentFailuresarray of objectyes
recentFailures[].atstringyesWhen.
recentFailures[].kindstringyesThe kind of work.
recentFailures[].errorobjectyes
recentFailures[].error.classstringyesWhat kind of failure.
recentFailures[].error.textstringyesThe reason with names, code and secrets removed.
findingsarray of object or nullyes

#OwnershipTransfer

A change of owner started by Nullgap support at the organisation's request.

FieldTypeAlways presentDescription
idstringyesThe id.
statusstringyesWhere it stands. One of: pending, completed, cancelled.
toEmailstringyesThe member who becomes an owner.
createdAtstringyesWhen support started it.
effectiveAtstringyesThe earliest it can take effect.
completedAtstring or nullyesWhen it took effect.
cancelledAtstring or nullyesWhen it was cancelled.

#SupportMessage

One message of a support request.

FieldTypeAlways presentDescription
idstringyesThe message id.
atstringyesWhen it was written.
fromstringyesWhich side wrote it. One of: customer, support.
authorstringyesThe member's name, or Nullgap support. The name of the person at Nullgap is never given.
textstringyesThe message.

Nullgap documentation