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.
| Operation | Method and path | Who may call it |
|---|---|---|
| Get how to reach support | GET /api/support/info | none |
| List support requests | GET /api/orgs/{org}/support/requests | console only |
| Open a support request | POST /api/orgs/{org}/support/requests | console only |
| Get a support request | GET /api/orgs/{org}/support/requests/{id} | console only |
| Reply on a support request | POST /api/orgs/{org}/support/requests/{id}/messages | console only |
| Resolve a support request | POST /api/orgs/{org}/support/requests/{id}/resolve | console only |
| Reopen a support request | POST /api/orgs/{org}/support/requests/{id}/reopen | console only |
| Get support access | GET /api/orgs/{org}/support/access | admin |
| Give support access | POST /api/orgs/{org}/support/access | console only (admin) |
| End support access | DELETE /api/orgs/{org}/support/access/{id} | admin |
| List requests by support for access | GET /api/orgs/{org}/support/access-requests | admin |
| Approve a request by support for access | POST /api/orgs/{org}/support/access-requests/{id}/approve | console only (admin) |
| Decline a request by support for access | POST /api/orgs/{org}/support/access-requests/{id}/decline | console only (admin) |
| Create a diagnostic bundle | POST /api/orgs/{org}/support/diagnostics | console only (admin) |
| Get a diagnostic bundle | GET /api/orgs/{org}/support/diagnostics/{diagnostic} | admin |
| List the diagnostic bundles of a request | GET /api/orgs/{org}/support/requests/{id}/diagnostics | admin |
| Attach a diagnostic bundle to a request | POST /api/orgs/{org}/support/requests/{id}/diagnostics/{diagnostic} | console only (admin) |
| Get a pending ownership transfer | GET /api/orgs/{org}/ownership-transfer | console only (owner) |
| Cancel a pending ownership transfer | POST /api/orgs/{org}/ownership-transfer/cancel | console 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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
status | string | no | Only requests with this status. One of: open, waiting_customer, waiting_support, resolved. |
limit | integer | no | How many to return, 1 to 200. Default 50. |
offset | integer | no | How many to skip from the start. Default 0. |
Answer (200, application/json)
| Field | Type | Always present | Description |
|---|---|---|---|
items | array of SupportRequest | yes | Support requests, at most limit of them. |
total | integer | yes | How 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
| Status | Code | When |
|---|---|---|
| 403 | forbidden | The call was made with an API key. This is something a signed-in person does. |
| 400 | bad_request | status 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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
Request body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
subject | string | yes | One line saying what it is about. 3 to 150 characters. |
category | string | yes | What kind of request it is. One of: how_to, not_working, finding_wrong, billing, security, other. |
urgency | string | yes | normal, blocking (it stops your work) or incident (a security incident in production). |
message | string | yes | The message, in plain text. 1 to 5000 characters. |
context | SupportContext | no | |
supportAccess | object | no | Admins 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.hours | integer | yes | How long support may look: 1 hour, 24 hours or 168 hours (7 days). One of: 1, 24, 168. |
supportAccess.actions | boolean | no | Also 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
| Status | Code | When |
|---|---|---|
| 403 | forbidden | The call was made with an API key. This is something a signed-in person does. |
| 400 | bad_request | A 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. |
| 403 | forbidden | supportAccess was sent by someone who is not an admin or owner. |
| 403 | step_up_required | supportAccess was sent and your second factor was last checked more than 15 minutes ago on this session. |
| 429 | rate_limited | Too 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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
id | string | yes | The 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
| Status | Code | When |
|---|---|---|
| 403 | forbidden | The call was made with an API key. This is something a signed-in person does. |
| 404 | not_found | No 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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
id | string | yes | The support request id. |
Request body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
message | string | yes | The 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
| Status | Code | When |
|---|---|---|
| 403 | forbidden | The call was made with an API key. This is something a signed-in person does. |
| 404 | not_found | No request with that id, or it was opened by someone else and you are not an admin of the organisation. |
| 409 | thread_full | The thread has 200 messages. Open a new request and mention this one. |
| 429 | rate_limited | Too 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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
id | string | yes | The 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
| Status | Code | When |
|---|---|---|
| 403 | forbidden | The call was made with an API key. This is something a signed-in person does. |
| 404 | not_found | No 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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
id | string | yes | The 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
| Status | Code | When |
|---|---|---|
| 403 | forbidden | The call was made with an API key. This is something a signed-in person does. |
| 404 | not_found | No request with that id, or it was opened by someone else and you are not an admin of the organisation. |
| 409 | not_resolved | The 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
| 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/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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
Request body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
hours | integer | yes | How long the access lasts: 1 hour, 24 hours or 168 hours (7 days). One of: 1, 24, 168. |
requestId | string | no | A support request to tie the grant to. Left out: the grant runs its full time unless ended. |
actions | boolean | no | Also 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
| Status | Code | When |
|---|---|---|
| 403 | forbidden | The call was made with an API key. This is something a signed-in person does. |
| 403 | step_up_required | Your account has a second factor and it was last checked more than 15 minutes ago on this session. |
| 400 | bad_request | hours is not 1, 24 or 168. |
| 404 | not_found | No support request of this organisation has the requestId sent. |
| 409 | request_resolved | The 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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
id | string | yes | The 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
| Status | Code | When |
|---|---|---|
| 404 | not_found | No 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
| 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/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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
id | string | yes | The id of the request for access. |
Request body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
hours | integer | yes | How long the access lasts. One of: 1, 24, 168. |
actions | boolean | yes | Also allow the listed support actions. |
Answer (200, application/json)
| Field | Type | Always present | Description |
|---|---|---|---|
request | SupportAccessRequest | yes | |
grant | SupportGrant | yes |
{
"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
| Status | Code | When |
|---|---|---|
| 403 | forbidden | The call was made with an API key. This is something a signed-in person does. |
| 403 | step_up_required | Your account has a second factor and it was last checked more than 15 minutes ago on this session. |
| 404 | not_found | No request for access of this organisation has that id. |
| 409 | not_pending | The 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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
id | string | yes | The 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
| Status | Code | When |
|---|---|---|
| 403 | forbidden | The call was made with an API key. This is something a signed-in person does. |
| 404 | not_found | No request for access of this organisation has that id. |
| 409 | not_pending | The 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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
Request body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
includeFindings | boolean | no | Also 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
| Status | Code | When |
|---|---|---|
| 403 | forbidden | The call was made with an API key. This is something a signed-in person does. |
| 429 | rate_limited | Ten 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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
diagnostic | string | yes | The 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
| Status | Code | When |
|---|---|---|
| 404 | not_found | No 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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
id | string | yes | The 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
| Status | Code | When |
|---|---|---|
| 404 | not_found | No 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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
id | string | yes | The support request id. |
diagnostic | string | yes | The 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
| Status | Code | When |
|---|---|---|
| 403 | forbidden | The call was made with an API key. This is something a signed-in person does. |
| 404 | not_found | No request or bundle of this organisation has that id. |
| 409 | already_attached | The 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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation slug. |
Answer (200, application/json)
| Field | Type | Always present | Description |
|---|---|---|---|
pending | OwnershipTransfer or null | yes |
{
"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
| Name | Type | Required | Description |
|---|---|---|---|
org | string | yes | The 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
| Status | Code | When |
|---|---|---|
| 403 | forbidden | The call was made with an API key. This is something a signed-in person does. |
| 409 | no_transfer | No 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.
| Field | Type | Always present | Description |
|---|---|---|---|
email | string or null | yes | The support address. Null when the operator of this server set none: requests are then made and answered in the console only. |
statusUrl | string or null | yes | The address of the service status page, when there is one. |
docsUrl | string or null | yes | The address of the documentation, when the operator set one. |
emailNotices | boolean | yes | Whether 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.
| Field | Type | Always present | Description |
|---|---|---|---|
id | string | yes | The request id. Quote it in any other conversation with support. |
subject | string | yes | One line saying what it is about. |
category | string | yes | What kind of request it is. One of: how_to, not_working, finding_wrong, billing, security, other. |
urgency | string | yes | normal, blocking (it stops the person's work) or incident (a security incident in production). |
status | string | yes | open: 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. |
context | SupportContext | yes | |
openedBy | object | yes | The member who sent it. |
openedBy.userId | string | yes | Their user id. |
openedBy.name | string | yes | Their name. |
openedBy.email | string | yes | Their e-mail address. |
createdAt | string | yes | When it was sent. |
updatedAt | string | yes | When it last changed. |
resolvedAt | string or null | yes | When it was resolved. Null while it is not. |
messageCount | integer | yes | How many messages the thread has. |
lastMessageAt | string | yes | When the newest message was written. |
lastFrom | string | yes | Who 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.
| Field | Type | Always present | Description |
|---|---|---|---|
page | string | no | The console page the person was on, as a path. Up to 200 characters. |
findingId | string | no | A finding the request is about. |
reviewId | string | no | A review the request is about. |
pentestId | string | no | A pentest the request is about. |
requestRef | string | no | The reference of a request that failed (the requestId of an error answer). |
#SupportRequestDetail
A support request with its messages.
| Field | Type | Always present | Description |
|---|---|---|---|
id | string | yes | The request id. Quote it in any other conversation with support. |
subject | string | yes | One line saying what it is about. |
category | string | yes | What kind of request it is. One of: how_to, not_working, finding_wrong, billing, security, other. |
urgency | string | yes | normal, blocking (it stops the person's work) or incident (a security incident in production). |
status | string | yes | open: 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. |
context | SupportContext | yes | |
openedBy | object | yes | The member who sent it. |
openedBy.userId | string | yes | Their user id. |
openedBy.name | string | yes | Their name. |
openedBy.email | string | yes | Their e-mail address. |
createdAt | string | yes | When it was sent. |
updatedAt | string | yes | When it last changed. |
resolvedAt | string or null | yes | When it was resolved. Null while it is not. |
messageCount | integer | yes | How many messages the thread has. |
lastMessageAt | string | yes | When the newest message was written. |
lastFrom | string | yes | Who wrote the newest message. One of: customer, support. |
messages | array of SupportMessage | yes | The thread, oldest first. |
#SupportAccess
Whether Nullgap support can look at the workspace now, and when it could before.
| Field | Type | Always present | Description |
|---|---|---|---|
active | SupportGrant or null | yes | |
history | array of SupportGrant | yes | Up to 10 earlier grants. |
pendingRequest | SupportAccessRequest or null | yes |
#SupportGrant
An organisation's permission for Nullgap support to look at its workspace, read-only, for a limited time.
| Field | Type | Always present | Description |
|---|---|---|---|
id | string | yes | The grant id. |
grantedBy | string | yes | Who gave it. |
createdAt | string | yes | When it was given. |
expiresAt | string | yes | When it ends by itself. |
requestId | string or null | yes | The support request it was given for. It ends when that request is resolved. |
revokedAt | string or null | yes | When it was ended early. Null when it was not. |
revokedBy | string or null | yes | Who ended it early. |
active | boolean | yes | True when it is neither ended nor expired at the time of the answer. |
actions | boolean | yes | Support 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.
| Field | Type | Always present | Description |
|---|---|---|---|
pending | SupportAccessRequest or null | yes | |
history | array of SupportAccessRequest | yes | Up to 10 earlier requests. |
#SupportAccessRequest
A request by Nullgap support to look at the workspace. Opens nothing until an admin approves it.
| Field | Type | Always present | Description |
|---|---|---|---|
id | string | yes | The id of the request. |
status | string | yes | Where it stands. One of: pending, approved, declined, expired, withdrawn. |
reason | string | yes | Why support would like to look, in support's words. |
hours | integer | yes | How long support asked for. One of: 1, 24, 168. |
actions | boolean | yes | Whether support also asked to carry out support actions. |
requestId | string or null | yes | The support request it belongs to. |
createdAt | string | yes | When support asked. |
expiresAt | string | yes | When it lapses if nobody answers. |
decidedAt | string or null | yes | When it was answered. |
decidedBy | string or null | yes | Who answered it. |
#DiagnosticBundle
A summary of the workspace an admin can attach to a support request. Never holds secrets or code.
| Field | Type | Always present | Description |
|---|---|---|---|
id | string | yes | The bundle id. |
createdAt | string | yes | When it was made. |
createdBy | string | yes | Who made it. |
requestId | string or null | yes | The support request it is attached to. Null while it is only a preview. |
expiresAt | string or null | yes | When an unattached bundle is removed. Null once attached. |
versions | object | yes | |
versions.server | string | yes | The server version. |
versions.api | integer | yes | The API version. |
workspace | object | yes | |
workspace.name | string | yes | The workspace name. |
workspace.slug | string | yes | The workspace address. |
workspace.plan | string | yes | The plan. |
workspace.suspended | boolean | yes | Whether it is suspended. |
workspace.members | integer | yes | How many members. |
workspace.repositories | integer | yes | How many repositories are connected. |
workspace.reviewEnabledRepositories | integer | yes | How many have reviews switched on. |
configuration | object | yes | The settings as switches, numbers, short values and counts. No free text, names or secrets. |
connections | array of object | yes | |
connections[].provider | string | yes | The kind of code host. |
connections[].state | string | yes | Whether it works. One of: connected, failing. |
connections[].repositories | integer | yes | How many repositories it brings. |
connections[].lastActivityAt | string or null | yes | The newest review that came through it. |
connections[].lastErrorClass | string or null | yes | What kind of failure, when it is failing. |
integrations | array of object | yes | |
integrations[].kind | string | yes | The kind. |
integrations[].state | string | yes | Whether it works. One of: configured, failing, disabled. |
jobs | object | yes | |
jobs.queued | integer | yes | Waiting. |
jobs.running | integer | yes | Running. |
jobs.failed | integer | yes | Failed in the last 14 days. |
jobs.dead | integer | yes | Gave up after retries. |
recentFailures | array of object | yes | |
recentFailures[].at | string | yes | When. |
recentFailures[].kind | string | yes | The kind of work. |
recentFailures[].error | object | yes | |
recentFailures[].error.class | string | yes | What kind of failure. |
recentFailures[].error.text | string | yes | The reason with names, code and secrets removed. |
findings | array of object or null | yes |
#OwnershipTransfer
A change of owner started by Nullgap support at the organisation's request.
| Field | Type | Always present | Description |
|---|---|---|---|
id | string | yes | The id. |
status | string | yes | Where it stands. One of: pending, completed, cancelled. |
toEmail | string | yes | The member who becomes an owner. |
createdAt | string | yes | When support started it. |
effectiveAt | string | yes | The earliest it can take effect. |
completedAt | string or null | yes | When it took effect. |
cancelledAt | string or null | yes | When it was cancelled. |
#SupportMessage
One message of a support request.
| Field | Type | Always present | Description |
|---|---|---|---|
id | string | yes | The message id. |
at | string | yes | When it was written. |
from | string | yes | Which side wrote it. One of: customer, support. |
author | string | yes | The member's name, or Nullgap support. The name of the person at Nullgap is never given. |
text | string | yes | The message. |
Nullgap documentation