Documentation › Nexus BSS/OSS › REST API

REST API for Nexus BSS/OSS

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

133 endpoints in 45 resource groups.

activity · ai · alarms · alerts · automation · collections · connect · countries · custom-domain · customers · dashboard · elements · fx · invoices · ip-blocks · login · logout · metrics · monitor · network · next-number · nxdocs · nxdocs-file · nxtz · orders · partners · password · payments · perms · plans · ra · reports · search · sender-domains · sender-emails · sender-options · sender-prefs · services · session · settings · sites · tickets · username · users · workorders

activity 1

Method	Path	Access
GET	`/api/activity`	administrator

ai 1

Method	Path	Access
GET	`/api/ai/insights`	signed in

alarms 3

Method	Path	Access
GET	`/api/alarms`	signed in
POST	`/api/alarms/:id/ack`	signed in
POST	`/api/alarms/:id/clear`	signed in

alerts 2

Method	Path	Access
GET	`/api/alerts`	signed in
POST	`/api/alerts/:id/resolve`	signed in

automation 3

Method	Path	Access
POST	`/api/automation/run`	administrator
GET	`/api/automation/status`	signed in
PUT	`/api/automation/toggles`	administrator

collections 1

Method	Path	Access
GET	`/api/collections`	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

countries 1

Method	Path	Access
GET	`/api/countries`	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

customers 5

Method	Path	Access
GET	`/api/customers`	signed in
POST	`/api/customers`	signed in
GET	`/api/customers/:id`	signed in
PUT	`/api/customers/:id`	signed in
POST	`/api/customers/:id/engage`	signed in

dashboard 1

Method	Path	Access
GET	`/api/dashboard`	signed in

elements 2

Method	Path	Access
GET	`/api/elements`	signed in
POST	`/api/elements`	administrator

fx 4

Method	Path	Access
GET	`/api/fx`	signed in
PUT	`/api/fx`	administrator
GET	`/api/fx/convert`	signed in
POST	`/api/fx/refresh`	administrator

invoices 3

Method	Path	Access
GET	`/api/invoices`	signed in
POST	`/api/invoices`	signed in
GET	`/api/invoices/:id`	signed in

ip-blocks 2

Method	Path	Access
GET	`/api/ip-blocks`	administrator
POST	`/api/ip-blocks`	administrator

Method	Path	Access
POST	`/api/login`	public
POST	`/api/login/2fa`	public

logout 1

Method	Path	Access
POST	`/api/logout`	signed in

metrics 1

Method	Path	Access
GET	`/api/metrics/:element_id`	signed in

monitor 1

Method	Path	Access
POST	`/api/monitor/webhook`	signed in

network 1

Method	Path	Access
POST	`/api/network/:element_id/action`	signed in

next-number 1

Method	Path	Access
GET	`/api/next-number`	signed in

nxdocs 2

Method	Path	Access
GET	`/api/nxdocs/:kind/:ref`	signed in
POST	`/api/nxdocs/:kind/:ref`	signed in

nxdocs-file 2

Method	Path	Access
DELETE	`/api/nxdocs-file/:id`	signed in
GET	`/api/nxdocs-file/:id`	signed in

nxtz 3

Method	Path	Access
GET	`/api/nxtz`	signed in
PUT	`/api/nxtz`	signed in
POST	`/api/nxtz/device`	signed in

orders 5

Method	Path	Access
GET	`/api/orders`	signed in
POST	`/api/orders`	signed in
GET	`/api/orders/:id`	signed in
POST	`/api/orders/:id/advance`	signed in
POST	`/api/orders/:id/cancel`	signed in

partners 3

Method	Path	Access
GET	`/api/partners`	signed in
POST	`/api/partners`	administrator
PUT	`/api/partners/:id`	administrator

password 2

Method	Path	Access
POST	`/api/password/forgot`	public
POST	`/api/password/reset`	signed in

payments 4

Method	Path	Access
GET	`/api/payments`	signed in
POST	`/api/payments`	signed in
POST	`/api/payments/:id/reassign`	signed in
POST	`/api/payments/:id/void`	signed in

perms 2

Method	Path	Access
GET	`/api/perms/catalog`	signed in
GET	`/api/perms/resolved`	administrator

plans 3

Method	Path	Access
GET	`/api/plans`	signed in
POST	`/api/plans`	administrator
PUT	`/api/plans/:id`	administrator

ra 3

Method	Path	Access
GET	`/api/ra`	signed in
POST	`/api/ra/:id/resolve`	signed in
POST	`/api/ra/run`	signed in

reports 7

Method	Path	Access
GET	`/api/reports/alarm-mttr`	signed in
GET	`/api/reports/arpu`	signed in
GET	`/api/reports/churn`	signed in
GET	`/api/reports/export/:what`	signed in
GET	`/api/reports/revenue`	signed in
GET	`/api/reports/sla`	signed in
GET	`/api/reports/tickets`	signed in

search 2

Method	Path	Access
GET	`/api/search`	signed in
GET	`/api/search/coverage`	signed in

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

services 4

Method	Path	Access
GET	`/api/services`	signed in
PUT	`/api/services/:id`	signed in
POST	`/api/services/:id/status`	signed in
POST	`/api/services/:id/usage`	signed in

session 1

Method	Path	Access
GET	`/api/session`	signed in

settings 3

Method	Path	Access
GET	`/api/settings`	administrator
PUT	`/api/settings`	administrator
POST	`/api/settings/monitor-key`	administrator

sites 2

Method	Path	Access
GET	`/api/sites`	signed in
POST	`/api/sites`	administrator

tickets 4

Method	Path	Access
GET	`/api/tickets`	signed in
POST	`/api/tickets`	signed in
GET	`/api/tickets/:id`	signed in
PUT	`/api/tickets/:id`	signed in

username 1

Method	Path	Access
POST	`/api/username/forgot`	public

users 4

Method	Path	Access
GET	`/api/users`	administrator
POST	`/api/users`	administrator
DELETE	`/api/users/:id`	administrator
PUT	`/api/users/:id`	administrator

workorders 3

Method	Path	Access
GET	`/api/workorders`	signed in
POST	`/api/workorders`	signed in
PUT	`/api/workorders/:id`	signed in