REST API for NexusOps ITSM
Every HTTP endpoint the application exposes, grouped by resource.
Calling the API
The API is served from the same address as the application, under /api. Requests carry the session cookie issued at sign-in, so a browser session and an API call are the same identity and obey the same permissions.
Every state changing request (POST, PUT, PATCH, DELETE) must also carry this application family's presence header, or it is refused with
403 bad request. That refusal reads like a permissions fault but is not one.
Integration and APIs lists the header per family.
Endpoints
725 endpoints in 91 resource groups.
admin · agents · ai · am · an · api · approvals · assets · assist · attachments · automation · cat · catalog · changes · chg · ci2 · cmdb · connect · connectors · csat · custom-domain · dashboard · dashboard2 · dom · events · ext · fla · fx · groups · home · hr · i18n · idp · internal · itom · kb · lang · login · logout · maintenance · me · mim · mim2 · mobile · my · notifications · nxtz · oncall · paging · password · perf · perms · plugin · plugins · prb · predict · public · pulse · push · r · recovery · remote · reply-meta · reports · search · secops · security · sender-domains · sender-emails · sender-options · sender-prefs · setup · setup-matrix · setup-meta · sites · sla · sladef · sso · staff · tasks · technicians · tenanttest · tgroups · ticket-lookup · tickets · username · users · va · wf · workflows · ws
admin 51
| Method | Path | Access |
|---|
| GET | /api/admin/ack | administrator |
| PUT | /api/admin/ack | administrator |
| GET | /api/admin/archive/items | administrator |
| POST | /api/admin/archive/restore/:id | administrator |
| POST | /api/admin/archive/run | administrator |
| GET | /api/admin/audit | signed in |
| GET | /api/admin/datacfg | administrator |
| PUT | /api/admin/datacfg | administrator |
| DELETE | /api/admin/datalog | administrator |
| GET | /api/admin/datalog | administrator |
| GET | /api/admin/emailcmd | administrator |
| PUT | /api/admin/emailcmd | administrator |
| GET | /api/admin/export | administrator |
| POST | /api/admin/groups | administrator |
| POST | /api/admin/import | administrator |
| GET | /api/admin/mail | administrator |
| POST | /api/admin/mail | administrator |
| DELETE | /api/admin/mail/:id | administrator |
| POST | /api/admin/mail/:id/test | administrator |
| POST | /api/admin/mailaddr/:id/verify | administrator |
| POST | /api/admin/mailaddr/domain-verify | administrator |
| GET | /api/admin/mailaddr/overview | administrator |
| GET | /api/admin/mailfilters | administrator |
| POST | /api/admin/mailfilters | administrator |
| DELETE | /api/admin/mailfilters/:id | administrator |
| PUT | /api/admin/mailfilters/:id | administrator |
| GET | /api/admin/mailserver | administrator |
| PUT | /api/admin/mailserver | administrator |
| GET | /api/admin/plugins | signed in |
| PUT | /api/admin/plugins/:id | administrator |
| GET | /api/admin/quarantine | administrator |
| DELETE | /api/admin/quarantine/:id | administrator |
| POST | /api/admin/quarantine/:id/release | administrator |
| POST | /api/admin/quarantine/clear | administrator |
| GET | /api/admin/roles | administrator |
| POST | /api/admin/roles | administrator |
| DELETE | /api/admin/roles/:id | administrator |
| PUT | /api/admin/roles/:id | administrator |
| POST | /api/admin/sites | administrator |
| GET | /api/admin/sla | administrator |
| POST | /api/admin/sla | administrator |
| PUT | /api/admin/sla/:id | administrator |
| GET | /api/admin/ticket-scope | administrator |
| DELETE | /api/admin/ticket-scope/:userId | administrator |
| PUT | /api/admin/ticket-scope/:userId | administrator |
| GET | /api/admin/users | administrator |
| POST | /api/admin/users | administrator |
| DELETE | /api/admin/users/:id | administrator |
| PUT | /api/admin/users/:id | administrator |
| POST | /api/admin/users/:id/reset | administrator |
| POST | /api/admin/users/reconcile | administrator |
agents 11
| Method | Path | Access |
|---|
| GET | /api/agents | administrator |
| POST | /api/agents | administrator |
| POST | /api/agents/:id/kill | administrator |
| POST | /api/agents/:id/pause | administrator |
| POST | /api/agents/:id/resume | administrator |
| GET | /api/agents/actions | administrator |
| POST | /api/agents/actions/:id/approve | signed in |
| POST | /api/agents/actions/:id/reject | signed in |
| POST | /api/agents/actions/:id/undo | signed in |
| POST | /api/agents/run/:ticket_id | signed in |
| GET | /api/agents/tower | administrator |
ai 4
| Method | Path | Access |
|---|
| POST | /api/ai/agent | signed in |
| POST | /api/ai/agent-basic | signed in |
| POST | /api/ai/rewrite | signed in |
| POST | /api/ai/route | signed in |
am 28
| Method | Path | Access |
|---|
| GET | /api/am/assets | signed in |
| POST | /api/am/assets | signed in |
| DELETE | /api/am/assets/:id | signed in |
| GET | /api/am/assets/:id | signed in |
| PUT | /api/am/assets/:id | signed in |
| POST | /api/am/assets/:id/assign | signed in |
| POST | /api/am/assets/:id/dispose | signed in |
| POST | /api/am/assets/:id/reserve | signed in |
| POST | /api/am/assets/:id/return | signed in |
| POST | /api/am/assets/:id/stage | signed in |
| POST | /api/am/assets/:id/transfer | signed in |
| GET | /api/am/audits | signed in |
| POST | /api/am/audits | signed in |
| POST | /api/am/audits/:id/finish | signed in |
| GET | /api/am/audits/:id/report | signed in |
| POST | /api/am/audits/:id/scan | signed in |
| POST | /api/am/audits/:id/start | signed in |
| GET | /api/am/contracts | signed in |
| POST | /api/am/contracts | signed in |
| DELETE | /api/am/contracts/:id | signed in |
| PUT | /api/am/contracts/:id | signed in |
| GET | /api/am/contracts/expiring | signed in |
| GET | /api/am/dashboard | signed in |
| GET | /api/am/financial | signed in |
| GET | /api/am/stockrooms | signed in |
| POST | /api/am/stockrooms | signed in |
| DELETE | /api/am/stockrooms/:id | signed in |
| PUT | /api/am/stockrooms/:id | signed in |
an 7
| Method | Path | Access |
|---|
| GET | /api/an/benchmarks | signed in |
| POST | /api/an/benchmarks/ref | administrator |
| GET | /api/an/forecast | signed in |
| GET | /api/an/process | signed in |
| GET | /api/an/settings | administrator |
| POST | /api/an/settings | administrator |
| GET | /api/an/summary | signed in |
api 3
| Method | Path | Access |
|---|
| GET | /api/ | signed in |
| POST | /api/ | signed in |
| PUT | /api/ | signed in |
approvals 1
| Method | Path | Access |
|---|
| POST | /api/approvals/:id/decide | signed in |
assets 3
| Method | Path | Access |
|---|
| GET | /api/assets | signed in |
| POST | /api/assets | signed in |
| PUT | /api/assets/:id | signed in |
assist 13
| Method | Path | Access |
|---|
| POST | /api/assist/catalog/draft | signed in |
| POST | /api/assist/change/:id/explain | signed in |
| GET | /api/assist/settings | administrator |
| POST | /api/assist/settings | administrator |
| GET | /api/assist/status | signed in |
| POST | /api/assist/ticket/:id/kb-draft | signed in |
| POST | /api/assist/ticket/:id/next-action | signed in |
| POST | /api/assist/ticket/:id/reply | signed in |
| POST | /api/assist/ticket/:id/resolution | signed in |
| POST | /api/assist/ticket/:id/sentiment | signed in |
| POST | /api/assist/ticket/:id/summary | signed in |
| POST | /api/assist/ticket/:id/translate | signed in |
| GET | /api/assist/usage | administrator |
attachments 2
| Method | Path | Access |
|---|
| POST | /api/attachments | signed in |
| GET | /api/attachments/:id | signed in |
automation 6
| Method | Path | Access |
|---|
| GET | /api/automation | signed in |
| POST | /api/automation | signed in |
| DELETE | /api/automation/:id | signed in |
| PUT | /api/automation/:id | signed in |
| GET | /api/automation/custom-actions | signed in |
| POST | /api/automation/run/:ruleId/:ticketId | signed in |
cat 16
| Method | Path | Access |
|---|
| GET | /api/cat/guides | signed in |
| POST | /api/cat/guides | signed in |
| DELETE | /api/cat/guides/:id | signed in |
| POST | /api/cat/guides/:id/resolve | signed in |
| GET | /api/cat/items | signed in |
| PUT | /api/cat/items/:id | signed in |
| PUT | /api/cat/items/:id/approval | signed in |
| PUT | /api/cat/items/:id/flow | signed in |
| POST | /api/cat/order | signed in |
| GET | /api/cat/orders | signed in |
| POST | /api/cat/orders/:id/state | signed in |
| GET | /api/cat/portal | signed in |
| GET | /api/cat/summary | signed in |
| GET | /api/cat/varsets | signed in |
| POST | /api/cat/varsets | signed in |
| DELETE | /api/cat/varsets/:id | signed in |
catalog 2
| Method | Path | Access |
|---|
| GET | /api/catalog | signed in |
| POST | /api/catalog | signed in |
changes 7
| Method | Path | Access |
|---|
| GET | /api/changes/:id/conflicts | signed in |
| POST | /api/changes/:id/risk | signed in |
| GET | /api/changes/calendar | signed in |
| GET | /api/changes/freeze | administrator |
| POST | /api/changes/freeze | administrator |
| DELETE | /api/changes/freeze/:id | administrator |
| PUT | /api/changes/freeze/:id | administrator |
chg 25
| Method | Path | Access |
|---|
| GET | /api/chg/:id | signed in |
| POST | /api/chg/:id/assess | signed in |
| POST | /api/chg/:id/review | signed in |
| PUT | /api/chg/:id/state | signed in |
| POST | /api/chg/:id/submit | signed in |
| GET | /api/chg/cab | signed in |
| POST | /api/chg/cab | signed in |
| GET | /api/chg/cab/:id/agenda | signed in |
| POST | /api/chg/cab/:id/close | signed in |
| POST | /api/chg/cab/:id/items | signed in |
| POST | /api/chg/cab/:id/items/:iid/decide | signed in |
| GET | /api/chg/models | signed in |
| POST | /api/chg/models | administrator |
| DELETE | /api/chg/models/:id | administrator |
| GET | /api/chg/risk-rules | administrator |
| POST | /api/chg/risk-rules | administrator |
| DELETE | /api/chg/risk-rules/:id | administrator |
| GET | /api/chg/std | signed in |
| POST | /api/chg/std | signed in |
| DELETE | /api/chg/std/:id | signed in |
| POST | /api/chg/std/:id/raise | signed in |
| GET | /api/chg/summary | signed in |
| GET | /api/chg/velocity | signed in |
| POST | /api/chg/velocity/config | administrator |
| POST | /api/chg/velocity/webhook | signed in |
ci2 14
| Method | Path | Access |
|---|
| GET | /api/ci2/cert | signed in |
| POST | /api/ci2/cert/:id/certify | signed in |
| POST | /api/ci2/cert/schedule | administrator |
| GET | /api/ci2/changes | signed in |
| GET | /api/ci2/classes | signed in |
| POST | /api/ci2/classes | administrator |
| GET | /api/ci2/conflicts | signed in |
| POST | /api/ci2/conflicts/:id/:decision | signed in |
| GET | /api/ci2/health | signed in |
| POST | /api/ci2/reconcile | signed in |
| GET | /api/ci2/service-map/:id | signed in |
| GET | /api/ci2/sources | signed in |
| POST | /api/ci2/sources | administrator |
| GET | /api/ci2/summary | signed in |
cmdb 3
| Method | Path | Access |
|---|
| GET | /api/cmdb | signed in |
| POST | /api/cmdb | signed in |
| POST | /api/cmdb/discover | signed in |
connect 25
| Method | Path | Access |
|---|
| GET | /api/connect/connections | signed in |
| POST | /api/connect/connections | signed in |
| DELETE | /api/connect/connections/:id | signed in |
| PUT | /api/connect/connections/:id | signed in |
| POST | /api/connect/connections/:id/call | signed in |
| POST | /api/connect/connections/:id/test | signed in |
| GET | /api/connect/hooks | signed in |
| POST | /api/connect/hooks | signed in |
| DELETE | /api/connect/hooks/:id | signed in |
| PUT | /api/connect/hooks/:id | signed in |
| GET | /api/connect/hooks/:id/events | signed in |
| GET | /api/connect/log | signed in |
| GET | /api/connect/meta | signed in |
| GET | /api/connect/subs | signed in |
| POST | /api/connect/subs | signed in |
| DELETE | /api/connect/subs/:id | signed in |
| PUT | /api/connect/subs/:id | signed in |
| POST | /api/connect/subs/:id/test | administrator |
| GET | /api/connect/tokens | signed in |
| POST | /api/connect/tokens | signed in |
| DELETE | /api/connect/tokens/:id | signed in |
| PUT | /api/connect/tokens/:id | signed in |
| POST | /connect/hook/:slug | signed in |
| GET | /connect/mcp | signed in |
| POST | /connect/mcp | signed in |
connectors 6
| Method | Path | Access |
|---|
| GET | /api/connectors | signed in |
| POST | /api/connectors | signed in |
| DELETE | /api/connectors/:id | signed in |
| PUT | /api/connectors/:id | signed in |
| POST | /api/connectors/:id/invoke | signed in |
| POST | /api/connectors/:id/test | signed in |
csat 1
| Method | Path | Access |
|---|
| GET | /api/csat/summary | signed in |
custom-domain 3
| Method | Path | Access |
|---|
| GET | /api/custom-domain | signed in |
| PUT | /api/custom-domain | signed in |
| POST | /api/custom-domain/verify | signed in |
dashboard 1
| Method | Path | Access |
|---|
| GET | /api/dashboard | signed in |
dashboard2 1
| Method | Path | Access |
|---|
| GET | /api/dashboard2 | signed in |
dom 5
| Method | Path | Access |
|---|
| GET | /api/dom/tenancies | administrator |
| POST | /api/dom/tenancies | administrator |
| GET | /api/dom/tenancies/:id/members | administrator |
| POST | /api/dom/tenancies/:id/members | administrator |
| DELETE | /api/dom/tenancies/:id/members/:uid | administrator |
events 2
| Method | Path | Access |
|---|
| GET | /api/events | signed in |
| POST | /api/events/:id/incident | signed in |
ext 26
| Method | Path | Access |
|---|
| GET | /api/ext/alerts/config | signed in |
| POST | /api/ext/alerts/config | signed in |
| GET | /api/ext/connectors/library | signed in |
| POST | /api/ext/connectors/library/:key/install | signed in |
| GET | /api/ext/decisions | signed in |
| POST | /api/ext/decisions | signed in |
| DELETE | /api/ext/decisions/:id | signed in |
| POST | /api/ext/decisions/:id/evaluate | signed in |
| GET | /api/ext/fields | signed in |
| GET | /api/ext/forms | signed in |
| POST | /api/ext/forms | signed in |
| DELETE | /api/ext/forms/:id | signed in |
| GET | /api/ext/forms/resolve | signed in |
| GET | /api/ext/imports | signed in |
| POST | /api/ext/imports | signed in |
| GET | /api/ext/imports/:id | signed in |
| POST | /api/ext/imports/:id/commit | signed in |
| PUT | /api/ext/imports/:id/mapping | signed in |
| POST | /api/ext/imports/:id/preview | signed in |
| POST | /api/ext/imports/:id/rollback | signed in |
| GET | /api/ext/rules | signed in |
| POST | /api/ext/rules | signed in |
| DELETE | /api/ext/rules/:id | signed in |
| POST | /api/ext/rules/:id/test/:ticket_id | signed in |
| POST | /api/ext/rules/run | signed in |
| GET | /api/ext/summary | signed in |
fla 3
| Method | Path | Access |
|---|
| GET | /api/fla | administrator |
| POST | /api/fla | administrator |
| GET | /api/fla/mine | administrator |
fx 5
| Method | Path | Access |
|---|
| GET | /api/fx/convert | signed in |
| GET | /api/fx/rates | signed in |
| POST | /api/fx/rates | administrator |
| GET | /api/fx/ticket/:id/cost | signed in |
| POST | /api/fx/ticket/:id/cost | signed in |
groups 1
| Method | Path | Access |
|---|
| GET | /api/groups | signed in |
home 23
| Method | Path | Access |
|---|
| GET | /api/home/announcements | signed in |
| POST | /api/home/announcements | signed in |
| DELETE | /api/home/announcements/:id | signed in |
| PUT | /api/home/announcements/:id | signed in |
| GET | /api/home/announcements/active | signed in |
| GET | /api/home/availability | signed in |
| GET | /api/home/delegations | signed in |
| POST | /api/home/delegations | signed in |
| DELETE | /api/home/delegations/:id | signed in |
| PUT | /api/home/delegations/:id | signed in |
| GET | /api/home/reminders | signed in |
| POST | /api/home/reminders | signed in |
| DELETE | /api/home/reminders/:id | signed in |
| PUT | /api/home/reminders/:id | signed in |
| PUT | /api/home/schedule/:id | signed in |
| GET | /api/home/scheduler | signed in |
| GET | /api/home/tasks | signed in |
| POST | /api/home/tasks | signed in |
| DELETE | /api/home/tasks/:id | signed in |
| PUT | /api/home/tasks/:id | signed in |
| GET | /api/home/unavailability | signed in |
| POST | /api/home/unavailability | signed in |
| DELETE | /api/home/unavailability/:id | signed in |
hr 2
| Method | Path | Access |
|---|
| GET | /api/hr/onboarding | signed in |
| POST | /api/hr/onboarding/:id/step | signed in |
i18n 5
| Method | Path | Access |
|---|
| GET | /api/i18n/export | administrator |
| GET | /api/i18n/overrides | administrator |
| POST | /api/i18n/overrides | administrator |
| DELETE | /api/i18n/overrides/:id | administrator |
| GET | /api/i18n/strings | signed in |
idp 7
| Method | Path | Access |
|---|
| GET | /api/idp/scim/status | administrator |
| DELETE | /api/idp/scim/token | administrator |
| POST | /api/idp/scim/token | administrator |
| GET | /api/idp/settings | administrator |
| POST | /api/idp/settings | administrator |
| GET | /api/idp/summary | administrator |
| POST | /api/idp/test | administrator |
internal 2
| Method | Path | Access |
|---|
| POST | /api/internal/mail-quarantine | signed in |
| POST | /api/internal/mail-ticket | signed in |
itom 42
| Method | Path | Access |
|---|
| GET | /api/itom/alerts | signed in |
| POST | /api/itom/alerts/:cid/incident | signed in |
| POST | /api/itom/alerts/:cid/suppress | signed in |
| GET | /api/itom/change-impact | signed in |
| DELETE | /api/itom/ci/:id | signed in |
| PUT | /api/itom/ci/:id | signed in |
| GET | /api/itom/ci/:id/impact | signed in |
| GET | /api/itom/ci/:id/relations | signed in |
| POST | /api/itom/ci/:id/relations | signed in |
| GET | /api/itom/cis | signed in |
| GET | /api/itom/cmdb-health | signed in |
| GET | /api/itom/credentials | signed in |
| POST | /api/itom/credentials | signed in |
| DELETE | /api/itom/credentials/:id | signed in |
| PUT | /api/itom/credentials/:id | signed in |
| POST | /api/itom/discover | signed in |
| GET | /api/itom/event-rules | signed in |
| POST | /api/itom/event-rules | signed in |
| DELETE | /api/itom/event-rules/:id | signed in |
| PUT | /api/itom/event-rules/:id | signed in |
| GET | /api/itom/ops-dashboard | signed in |
| DELETE | /api/itom/relations/:id | signed in |
| GET | /api/itom/runs | signed in |
| POST | /api/itom/runs/:id/resolve | signed in |
| GET | /api/itom/schedules | signed in |
| POST | /api/itom/schedules | signed in |
| DELETE | /api/itom/schedules/:id | signed in |
| PUT | /api/itom/schedules/:id | signed in |
| GET | /api/itom/services | signed in |
| POST | /api/itom/services | signed in |
| DELETE | /api/itom/services/:id | signed in |
| PUT | /api/itom/services/:id | signed in |
| POST | /api/itom/services/:id/cis | signed in |
| GET | /api/itom/services/:id/map | signed in |
| DELETE | /api/itom/services/:sid/cis/:cid | signed in |
| POST | /api/itom/simulate-event | signed in |
| GET | /api/itom/sources | signed in |
| POST | /api/itom/sources | signed in |
| DELETE | /api/itom/sources/:id | signed in |
| PUT | /api/itom/sources/:id | signed in |
| POST | /api/itom/webhook/:sourceId | signed in |
| POST | /api/itom/webhook/ext/:kind | signed in |
kb 32
| Method | Path | Access |
|---|
| GET | /api/kb | signed in |
| POST | /api/kb | signed in |
| GET | /api/kb/:id | signed in |
| POST | /api/kb/ai-search | signed in |
| GET | /api/kb/analytics | signed in |
| GET | /api/kb/approvals | signed in |
| GET | /api/kb/articles | signed in |
| POST | /api/kb/articles | signed in |
| DELETE | /api/kb/articles/:id | signed in |
| GET | /api/kb/articles/:id | signed in |
| PUT | /api/kb/articles/:id | signed in |
| POST | /api/kb/articles/:id/approve | signed in |
| GET | /api/kb/articles/:id/feedback | signed in |
| POST | /api/kb/articles/:id/feedback | signed in |
| POST | /api/kb/articles/:id/publish | signed in |
| POST | /api/kb/articles/:id/rate | signed in |
| POST | /api/kb/articles/:id/reject | signed in |
| POST | /api/kb/articles/:id/retire | signed in |
| POST | /api/kb/articles/:id/submit | administrator |
| DELETE | /api/kb/articles/:id/subscribe | signed in |
| POST | /api/kb/articles/:id/subscribe | signed in |
| GET | /api/kb/bases | signed in |
| POST | /api/kb/bases | signed in |
| DELETE | /api/kb/bases/:id | administrator |
| GET | /api/kb/bases/:id | signed in |
| PUT | /api/kb/bases/:id | signed in |
| GET | /api/kb/categories | signed in |
| POST | /api/kb/categories | signed in |
| DELETE | /api/kb/categories/:id | signed in |
| PUT | /api/kb/categories/:id | signed in |
| GET | /api/kb/feedback | signed in |
| GET | /api/kb/search | signed in |
lang 2
| Method | Path | Access |
|---|
| GET | /api/lang/enabled | signed in |
| PUT | /api/lang/enabled | administrator |
login 2
| Method | Path | Access |
|---|
| POST | /api/login | public |
| POST | /api/login/2fa | public |
logout 1
| Method | Path | Access |
|---|
| POST | /api/logout | signed in |
maintenance 9
| Method | Path | Access |
|---|
| GET | /api/maintenance/active | signed in |
| POST | /api/maintenance/occurrences | signed in |
| GET | /api/maintenance/schedules | signed in |
| POST | /api/maintenance/schedules | signed in |
| DELETE | /api/maintenance/schedules/:id | signed in |
| GET | /api/maintenance/schedules/:id | signed in |
| PUT | /api/maintenance/schedules/:id | signed in |
| GET | /api/maintenance/targets | signed in |
| GET | /api/maintenance/upcoming | signed in |
me 4
| Method | Path | Access |
|---|
| GET | /api/me | signed in |
| POST | /api/me/password | signed in |
| GET | /api/me/profile | signed in |
| PUT | /api/me/profile | signed in |
mim 1
| Method | Path | Access |
|---|
| GET | /api/mim | signed in |
mim2 14
| Method | Path | Access |
|---|
| GET | /api/mim2 | signed in |
| GET | /api/mim2/:id | signed in |
| PUT | /api/mim2/:id | signed in |
| POST | /api/mim2/:id/children | signed in |
| POST | /api/mim2/:id/page | signed in |
| PUT | /api/mim2/:id/pir | signed in |
| GET | /api/mim2/:id/pir/print | signed in |
| POST | /api/mim2/:id/status | signed in |
| POST | /api/mim2/:id/timeline | signed in |
| POST | /api/mim2/:id/update | signed in |
| POST | /api/mim2/declare | signed in |
| GET | /api/mim2/summary/all | signed in |
| GET | /api/mim2/templates | signed in |
| POST | /api/mim2/templates | signed in |
mobile 6
| Method | Path | Access |
|---|
| GET | /api/mobile/manifest | signed in |
| GET | /api/mobile/settings | administrator |
| POST | /api/mobile/settings | administrator |
| GET | /api/mobile/summary | administrator |
| POST | /api/mobile/sync | signed in |
| GET | /api/mobile/twa | administrator |
my 1
| Method | Path | Access |
|---|
| GET | /api/my/ticket-scope | signed in |
notifications 2
| Method | Path | Access |
|---|
| GET | /api/notifications | signed in |
| POST | /api/notifications/:id/read | signed in |
nxtz 3
| Method | Path | Access |
|---|
| GET | /api/nxtz | signed in |
| PUT | /api/nxtz | signed in |
| POST | /api/nxtz/device | signed in |
oncall 9
| Method | Path | Access |
|---|
| GET | /api/oncall | signed in |
| POST | /api/oncall | administrator |
| DELETE | /api/oncall/:id | administrator |
| PUT | /api/oncall/:id | administrator |
| GET | /api/oncall/:id/overrides | signed in |
| POST | /api/oncall/:id/overrides | administrator |
| DELETE | /api/oncall/:id/overrides/:oid | administrator |
| PUT | /api/oncall/:id/shift | administrator |
| GET | /api/oncall/calendar | signed in |
paging 11
| Method | Path | Access |
|---|
| GET | /api/paging/pages | signed in |
| GET | /api/paging/policies | signed in |
| POST | /api/paging/policies | administrator |
| DELETE | /api/paging/policies/:id | administrator |
| GET | /api/paging/runs | signed in |
| POST | /api/paging/runs/:id/ack | signed in |
| POST | /api/paging/runs/:id/cancel | signed in |
| GET | /api/paging/settings | administrator |
| POST | /api/paging/settings | administrator |
| POST | /api/paging/start | signed in |
| GET | /api/paging/summary | signed in |
password 2
| Method | Path | Access |
|---|
| POST | /api/password/forgot | public |
| POST | /api/password/reset | signed in |
perf 1
| Method | Path | Access |
|---|
| GET | /api/perf/kpis | signed in |
perms 2
| Method | Path | Access |
|---|
| GET | /api/perms/catalog | signed in |
| GET | /api/perms/resolved | administrator |
plugin 4
| Method | Path | Access |
|---|
| GET | /api/plugin/health | signed in |
| GET | /api/plugin/sdp/requests | signed in |
| GET | /api/plugin/sdp/requests/:id | signed in |
| PUT | /api/plugin/sdp/requests/:id | signed in |
plugins 1
| Method | Path | Access |
|---|
| GET | /api/plugins/enabled | signed in |
prb 19
| Method | Path | Access |
|---|
| GET | /api/prb/candidates | signed in |
| POST | /api/prb/candidates/:id/convert | signed in |
| POST | /api/prb/candidates/:id/dismiss | signed in |
| POST | /api/prb/candidates/detect | signed in |
| GET | /api/prb/for-ticket/:id | signed in |
| GET | /api/prb/known-errors | signed in |
| POST | /api/prb/known-errors | signed in |
| PUT | /api/prb/known-errors/:id | signed in |
| POST | /api/prb/known-errors/:id/attach | signed in |
| POST | /api/prb/known-errors/:id/publish | signed in |
| GET | /api/prb/problems | signed in |
| POST | /api/prb/problems | signed in |
| GET | /api/prb/problems/:id | signed in |
| PUT | /api/prb/problems/:id | signed in |
| POST | /api/prb/problems/:id/close | signed in |
| POST | /api/prb/problems/:id/link | signed in |
| POST | /api/prb/problems/:id/tasks | signed in |
| POST | /api/prb/problems/:id/unlink | signed in |
| GET | /api/prb/summary | signed in |
predict 7
| Method | Path | Access |
|---|
| POST | /api/predict/apply/:id | signed in |
| POST | /api/predict/rebuild | administrator |
| GET | /api/predict/settings | administrator |
| POST | /api/predict/settings | administrator |
| GET | /api/predict/similar/:id | signed in |
| GET | /api/predict/stats | administrator |
| GET | /api/predict/suggest/:id | signed in |
public 20
| Method | Path | Access |
|---|
| GET | /api/public/health/ready | signed in |
| GET | /api/public/idp/callback | signed in |
| GET | /api/public/idp/login | signed in |
| GET | /api/public/idp/meta | signed in |
| GET | /api/public/mobile/assetlinks | signed in |
| GET | /api/public/scim/v2/Groups | signed in |
| POST | /api/public/scim/v2/Groups | signed in |
| DELETE | /api/public/scim/v2/Groups/:id | signed in |
| GET | /api/public/scim/v2/Groups/:id | signed in |
| PATCH | /api/public/scim/v2/Groups/:id | signed in |
| GET | /api/public/scim/v2/ResourceTypes | signed in |
| GET | /api/public/scim/v2/ServiceProviderConfig | signed in |
| GET | /api/public/scim/v2/Users | signed in |
| POST | /api/public/scim/v2/Users | signed in |
| DELETE | /api/public/scim/v2/Users/:id | signed in |
| GET | /api/public/scim/v2/Users/:id | signed in |
| PATCH | /api/public/scim/v2/Users/:id | signed in |
| PUT | /api/public/scim/v2/Users/:id | signed in |
| GET | /api/public/survey/:token | signed in |
| POST | /api/public/survey/:token | signed in |
pulse 15
| Method | Path | Access |
|---|
| GET | /api/pulse/analytics | signed in |
| GET | /api/pulse/dashboards | signed in |
| POST | /api/pulse/dashboards | signed in |
| PUT | /api/pulse/dashboards/:id | signed in |
| PUT | /api/pulse/dashboards/:id/layout | signed in |
| GET | /api/pulse/dashboards/:id/shares | signed in |
| POST | /api/pulse/dashboards/:id/shares | signed in |
| DELETE | /api/pulse/dashboards/:id/shares/:sid | signed in |
| POST | /api/pulse/dashboards/bulk | signed in |
| GET | /api/pulse/improvements | signed in |
| POST | /api/pulse/improvements | signed in |
| PUT | /api/pulse/improvements/:id | signed in |
| GET | /api/pulse/scorecards | signed in |
| GET | /api/pulse/targets | signed in |
| GET | /api/pulse/widgets | signed in |
push 4
| Method | Path | Access |
|---|
| GET | /api/push/key | signed in |
| POST | /api/push/subscribe | signed in |
| POST | /api/push/test | signed in |
| POST | /api/push/unsubscribe | signed in |
r 1
| Method | Path | Access |
|---|
| GET | /r/:token | signed in |
recovery 7
| Method | Path | Access |
|---|
| GET | /api/recovery | signed in |
| POST | /api/recovery | signed in |
| POST | /api/recovery/:id/approve | signed in |
| POST | /api/recovery/:id/callback | signed in |
| POST | /api/recovery/:id/deny | signed in |
| POST | /api/recovery/:id/execute | signed in |
| POST | /api/recovery/:id/otp | signed in |
remote 4
| Method | Path | Access |
|---|
| POST | /api/remote/:sid/end | signed in |
| GET | /api/remote/config | signed in |
| GET | /api/remote/devices | signed in |
| GET | /api/remote/enrol | signed in |
| Method | Path | Access |
|---|
| GET | /api/reply-meta | signed in |
reports 16
| Method | Path | Access |
|---|
| POST | /api/reports | signed in |
| DELETE | /api/reports/:id | signed in |
| GET | /api/reports/:id | signed in |
| PUT | /api/reports/:id | signed in |
| POST | /api/reports/:id/email | signed in |
| POST | /api/reports/folder | signed in |
| DELETE | /api/reports/folder/:id | administrator |
| GET | /api/reports/folders | signed in |
| GET | /api/reports/list | signed in |
| GET | /api/reports/meta | signed in |
| POST | /api/reports/run | signed in |
| GET | /api/reports/schedules | signed in |
| POST | /api/reports/schedules | signed in |
| DELETE | /api/reports/schedules/:id | signed in |
| PUT | /api/reports/schedules/:id | signed in |
| GET | /api/reports/sla | signed in |
search 2
| Method | Path | Access |
|---|
| GET | /api/search | signed in |
| GET | /api/search/bc | signed in |
secops 37
| Method | Path | Access |
|---|
| GET | /api/secops/attacks | signed in |
| POST | /api/secops/attacks/:id/incident | signed in |
| POST | /api/secops/attacks/:id/status | signed in |
| GET | /api/secops/benchmarks | signed in |
| POST | /api/secops/benchmarks | signed in |
| POST | /api/secops/benchmarks/:id/scan | signed in |
| GET | /api/secops/compliance-checks | signed in |
| POST | /api/secops/compliance-checks/:id/remediate | signed in |
| GET | /api/secops/dashboard | signed in |
| GET | /api/secops/exposures | signed in |
| GET | /api/secops/incidents | signed in |
| POST | /api/secops/incidents/:id/ai-triage | signed in |
| GET | /api/secops/integrations | signed in |
| POST | /api/secops/integrations | signed in |
| DELETE | /api/secops/integrations/:id | signed in |
| PUT | /api/secops/integrations/:id | signed in |
| GET | /api/secops/ioc-match | signed in |
| GET | /api/secops/iocs | signed in |
| POST | /api/secops/iocs | signed in |
| DELETE | /api/secops/iocs/:id | signed in |
| GET | /api/secops/playbooks | signed in |
| POST | /api/secops/playbooks | signed in |
| DELETE | /api/secops/playbooks/:id | signed in |
| PUT | /api/secops/playbooks/:id | signed in |
| POST | /api/secops/playbooks/:id/run | signed in |
| GET | /api/secops/remediation | signed in |
| PUT | /api/secops/remediation/:id | signed in |
| POST | /api/secops/siem-webhook/:iid | signed in |
| POST | /api/secops/simulate-attack | signed in |
| GET | /api/secops/soar-runs | signed in |
| GET | /api/secops/threat-feeds | signed in |
| POST | /api/secops/threat-feeds | signed in |
| DELETE | /api/secops/threat-feeds/:id | signed in |
| POST | /api/secops/threat-feeds/:id/pull | signed in |
| GET | /api/secops/vr | signed in |
| POST | /api/secops/vr/:id/remediate | signed in |
| POST | /api/secops/vr/import | signed in |
security 2
| Method | Path | Access |
|---|
| POST | /api/security/auth-policy | administrator |
| GET | /api/security/auth-readiness | administrator |
sender-domains 1
| Method | Path | Access |
|---|
| GET | /api/sender-domains/:domain/dkim | signed in |
sender-emails 6
| Method | Path | Access |
|---|
| POST | /api/sender-emails | signed in |
| DELETE | /api/sender-emails/:id | signed in |
| PUT | /api/sender-emails/:id | signed in |
| POST | /api/sender-emails/:id/primary | signed in |
| POST | /api/sender-emails/:id/resend | signed in |
| POST | /api/sender-emails/:id/verify | signed in |
sender-options 1
| Method | Path | Access |
|---|
| GET | /api/sender-options | signed in |
sender-prefs 1
| Method | Path | Access |
|---|
| GET | /api/sender-prefs | signed in |
setup 4
| Method | Path | Access |
|---|
| GET | /api/setup/:entity | administrator |
| POST | /api/setup/:entity | administrator |
| DELETE | /api/setup/:entity/:id | administrator |
| PUT | /api/setup/:entity/:id | administrator |
setup-matrix 2
| Method | Path | Access |
|---|
| GET | /api/setup-matrix | administrator |
| POST | /api/setup-matrix | administrator |
| Method | Path | Access |
|---|
| GET | /api/setup-meta | signed in |
sites 1
| Method | Path | Access |
|---|
| GET | /api/sites | signed in |
sla 2
| Method | Path | Access |
|---|
| GET | /api/sla/bizhours | signed in |
| POST | /api/sla/bizhours | administrator |
sladef 7
| Method | Path | Access |
|---|
| GET | /api/sladef | signed in |
| POST | /api/sladef | signed in |
| DELETE | /api/sladef/:id | administrator |
| GET | /api/sladef/report | signed in |
| POST | /api/sladef/run | signed in |
| GET | /api/sladef/summary | signed in |
| GET | /api/sladef/tasks | signed in |
sso 2
| Method | Path | Access |
|---|
| GET | /api/sso | signed in |
| POST | /api/sso/accounts | signed in |
staff 1
| Method | Path | Access |
|---|
| GET | /api/staff | signed in |
tasks 1
| Method | Path | Access |
|---|
| POST | /api/tasks/:id/toggle | signed in |
technicians 1
| Method | Path | Access |
|---|
| GET | /api/technicians | signed in |
tenanttest 9
| Method | Path | Access |
|---|
| GET | /api/tenanttest/ha | administrator |
| POST | /api/tenanttest/ha | administrator |
| GET | /api/tenanttest/readiness | administrator |
| POST | /api/tenanttest/run-all | administrator |
| POST | /api/tenanttest/run/:key | administrator |
| GET | /api/tenanttest/runs | administrator |
| GET | /api/tenanttest/suites | administrator |
| POST | /api/tenanttest/suites | administrator |
| DELETE | /api/tenanttest/suites/:id | administrator |
tgroups 6
| Method | Path | Access |
|---|
| GET | /api/tgroups | signed in |
| POST | /api/tgroups | administrator |
| DELETE | /api/tgroups/:id | administrator |
| GET | /api/tgroups/:id | signed in |
| PUT | /api/tgroups/:id | administrator |
| GET | /api/tgroups/meta | signed in |
ticket-lookup 1
| Method | Path | Access |
|---|
| GET | /api/ticket-lookup | signed in |
tickets 36
| Method | Path | Access |
|---|
| GET | /api/tickets | signed in |
| POST | /api/tickets | signed in |
| DELETE | /api/tickets/:id | signed in |
| GET | /api/tickets/:id | signed in |
| PUT | /api/tickets/:id | signed in |
| GET | /api/tickets/:id/activity | signed in |
| GET | /api/tickets/:id/ai-summary | signed in |
| POST | /api/tickets/:id/approval | signed in |
| POST | /api/tickets/:id/assign | signed in |
| GET | /api/tickets/:id/attachments | signed in |
| POST | /api/tickets/:id/attachments | signed in |
| POST | /api/tickets/:id/duplicate | signed in |
| POST | /api/tickets/:id/duplicate/clear | administrator |
| GET | /api/tickets/:id/duplicates | administrator |
| GET | /api/tickets/:id/enrol | signed in |
| POST | /api/tickets/:id/enrol | signed in |
| POST | /api/tickets/:id/enrol/send | signed in |
| POST | /api/tickets/:id/major | administrator |
| POST | /api/tickets/:id/merge | signed in |
| GET | /api/tickets/:id/merge-candidates | signed in |
| PUT | /api/tickets/:id/msg/:mid | signed in |
| POST | /api/tickets/:id/msg/:mid/split | signed in |
| POST | /api/tickets/:id/note | signed in |
| POST | /api/tickets/:id/pickup | signed in |
| POST | /api/tickets/:id/read | signed in |
| GET | /api/tickets/:id/remote | signed in |
| POST | /api/tickets/:id/remote | signed in |
| POST | /api/tickets/:id/remote/send | signed in |
| POST | /api/tickets/:id/reply | signed in |
| POST | /api/tickets/:id/reply2 | signed in |
| POST | /api/tickets/:id/split-bulk | signed in |
| POST | /api/tickets/:id/task | signed in |
| POST | /api/tickets/:id/worklog | signed in |
| GET | /api/tickets/counts | signed in |
| POST | /api/tickets/env-state | signed in |
| GET | /api/tickets/tabcounts | signed in |
username 1
| Method | Path | Access |
|---|
| POST | /api/username/forgot | public |
users 1
| Method | Path | Access |
|---|
| GET | /api/users | signed in |
va 8
| Method | Path | Access |
|---|
| GET | /api/va/analytics | signed in |
| POST | /api/va/chat | signed in |
| POST | /api/va/rate | signed in |
| GET | /api/va/sessions | signed in |
| GET | /api/va/sessions/:id | signed in |
| GET | /api/va/topics | signed in |
| POST | /api/va/topics | administrator |
| DELETE | /api/va/topics/:id | administrator |
wf 22
| Method | Path | Access |
|---|
| GET | /api/wf/matrix | signed in |
| GET | /api/wf/settings | signed in |
| POST | /api/wf/settings | signed in |
| GET | /api/wf/shifts | signed in |
| POST | /api/wf/shifts | signed in |
| DELETE | /api/wf/shifts/:id | signed in |
| GET | /api/wf/skills | signed in |
| POST | /api/wf/skills | signed in |
| DELETE | /api/wf/skills/:id | signed in |
| POST | /api/wf/suggest/:ticket_id | signed in |
| GET | /api/wf/summary | signed in |
| POST | /api/wf/walkup/:id/call | signed in |
| POST | /api/wf/walkup/:id/done | signed in |
| POST | /api/wf/walkup/:id/leave | signed in |
| POST | /api/wf/walkup/:id/serve | signed in |
| GET | /api/wf/walkup/board | signed in |
| POST | /api/wf/walkup/checkin | signed in |
| GET | /api/wf/walkup/history | signed in |
| GET | /api/wf/walkup/mine | signed in |
| GET | /api/wf/walkup/queue | signed in |
| GET | /api/wf/walkup/sites | administrator |
| POST | /api/wf/walkup/sites | administrator |
workflows 3
| Method | Path | Access |
|---|
| GET | /api/workflows | signed in |
| POST | /api/workflows | signed in |
| PUT | /api/workflows/:id | signed in |
ws 9
| Method | Path | Access |
|---|
| GET | /api/ws/csm | signed in |
| GET | /api/ws/dispatch | signed in |
| GET | /api/ws/flow-meta | signed in |
| GET | /api/ws/flows | signed in |
| POST | /api/ws/flows | signed in |
| PUT | /api/ws/flows/:id | signed in |
| GET | /api/ws/flows/:id/runs | signed in |
| GET | /api/ws/home | signed in |
| GET | /api/ws/ticket/:id | signed in |
© 2026 Nexus SoftSphere LLC. All rights reserved. Nexus SoftSphere is the author and owner of this documentation.