REST API for Nexus SaaS

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

166 endpoints in 44 resource groups.

analytics · api · api-keys · apps · audit · automation-log · billing · charges · connect · custom-domain · customers · discounts · dunning · gateways · integrations · invoices · licenses · login · logout · nxdocs · nxdocs-file · nxtz · orders · payments · plans · portal · products · provisioning · public · quotes · revenue · search · sender-domains · sender-emails · sender-options · sender-prefs · session · settings · subscriptions · trials · usage · username · users · webhooks

analytics 1

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

api 3

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

api-keys 3

Method	Path	Access
GET	`/api/api-keys`	administrator
POST	`/api/api-keys`	administrator
DELETE	`/api/api-keys/:id`	administrator

apps 5

Method	Path	Access
GET	`/api/apps`	signed in
POST	`/api/apps`	administrator
PUT	`/api/apps/:id`	administrator
POST	`/api/apps/:id/service`	administrator
GET	`/api/apps/:id/status`	signed in

audit 1

Method	Path	Access
GET	`/api/audit`	administrator

automation-log 1

Method	Path	Access
GET	`/api/automation-log`	signed in

billing 1

Method	Path	Access
POST	`/api/billing/run`	signed in

charges 2

Method	Path	Access
DELETE	`/api/charges/:id`	signed in
PUT	`/api/charges/:id`	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

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/payment-methods`	signed in

discounts 1

Method	Path	Access
DELETE	`/api/discounts/:id`	signed in

dunning 2

Method	Path	Access
GET	`/api/dunning`	signed in
POST	`/api/dunning/run`	signed in

gateways 2

Method	Path	Access
GET	`/api/gateways`	administrator
PUT	`/api/gateways/:id`	administrator

integrations 2

Method	Path	Access
GET	`/api/integrations`	administrator
PUT	`/api/integrations/:id`	administrator

invoices 5

Method	Path	Access
GET	`/api/invoices`	signed in
GET	`/api/invoices/:id`	signed in
POST	`/api/invoices/:id/collect`	signed in
POST	`/api/invoices/:id/record-payment`	signed in
POST	`/api/invoices/oneoff`	signed in

licenses 9

Method	Path	Access
GET	`/api/licenses`	signed in
POST	`/api/licenses`	signed in
GET	`/api/licenses/:id`	signed in
PUT	`/api/licenses/:id`	signed in
POST	`/api/licenses/:id/push`	signed in
POST	`/api/licenses/:id/renew`	signed in
POST	`/api/licenses/:id/revoke`	signed in
POST	`/api/licenses/push-all`	signed in
GET	`/api/licenses/report/utilisation`	signed in

Method	Path	Access
POST	`/api/login`	public

logout 1

Method	Path	Access
POST	`/api/logout`	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`	administrator
POST	`/api/orders`	administrator
GET	`/api/orders/:id`	administrator
POST	`/api/orders/:id/cancel`	administrator
POST	`/api/orders/:id/provisioned`	administrator

payments 3

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

plans 6

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

portal 5

Method	Path	Access
POST	`/api/portal/login`	signed in
POST	`/api/portal/logout`	signed in
GET	`/api/portal/me`	signed in
POST	`/api/portal/pay/:invoiceId`	signed in
POST	`/api/portal/request-cancel`	signed in

products 1

Method	Path	Access
DELETE	`/api/products/:id`	signed in

provisioning 16

Method	Path	Access
POST	`/api/provisioning/expand`	signed in
POST	`/api/provisioning/export-usage`	signed in
GET	`/api/provisioning/model`	signed in
POST	`/api/provisioning/quote`	signed in
GET	`/api/provisioning/retail/licences`	signed in
GET	`/api/provisioning/retail/model`	signed in
GET	`/api/provisioning/retail/pricebook`	administrator
PUT	`/api/provisioning/retail/pricebook`	administrator
GET	`/api/provisioning/retail/proposals`	signed in
POST	`/api/provisioning/retail/proposals`	signed in
GET	`/api/provisioning/retail/proposals/:id`	signed in
PUT	`/api/provisioning/retail/proposals/:id`	signed in
POST	`/api/provisioning/retail/proposals/:id/issue`	administrator
GET	`/api/provisioning/retail/proposals/:id/print`	signed in
POST	`/api/provisioning/retail/quote`	signed in
GET	`/api/provisioning/usage`	signed in

public 3

Method	Path	Access
GET	`/api/public/order-catalog`	signed in
GET	`/api/public/trial-products`	signed in
POST	`/api/public/trial-signup`	signed in

quotes 6

Method	Path	Access
GET	`/api/quotes`	signed in
POST	`/api/quotes`	signed in
GET	`/api/quotes/:id`	signed in
POST	`/api/quotes/:id/approve`	administrator
POST	`/api/quotes/:id/convert`	signed in
POST	`/api/quotes/:id/send`	signed in

revenue 3

Method	Path	Access
GET	`/api/revenue`	signed in
POST	`/api/revenue/recognize`	signed in
GET	`/api/revenue/schedules`	signed in

search 2

Method	Path	Access
GET	`/api/search`	signed in
GET	`/api/search/coverage`	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

session 1

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

settings 2

Method	Path	Access
GET	`/api/settings`	administrator
PUT	`/api/settings`	administrator

subscriptions 6

Method	Path	Access
GET	`/api/subscriptions`	signed in
POST	`/api/subscriptions`	signed in
GET	`/api/subscriptions/:id`	signed in
POST	`/api/subscriptions/:id/amend`	signed in
POST	`/api/subscriptions/:id/cancel`	signed in
POST	`/api/subscriptions/:id/renew`	signed in

trials 9

Method	Path	Access
GET	`/api/trials`	administrator
POST	`/api/trials`	administrator
GET	`/api/trials/:id`	administrator
POST	`/api/trials/:id/cancel`	administrator
POST	`/api/trials/:id/convert`	administrator
POST	`/api/trials/:id/extend`	administrator
POST	`/api/trials/:id/provisioned`	administrator
POST	`/api/trials/queue/:id/result`	administrator
GET	`/api/trials/queue/next`	administrator

usage 2

Method	Path	Access
GET	`/api/usage`	signed in
POST	`/api/usage`	signed in

username 1

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

users 3

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

webhooks 3

Method	Path	Access
POST	`/api/webhooks/:gateway`	signed in
GET	`/api/webhooks/entitlements`	signed in
GET	`/api/webhooks/license`	signed in