Account overview

An "account" sits above every workspace, project, and resource you own at NimbusNexus. It carries the billing contact, the legal entity name on invoices, the plan tier (free / starter / production / enterprise), the regions you're allowlisted into, and account-wide preferences. There's exactly one account per signup.

Most of these endpoints are read-only for non-owners and read-write for owners. Day-to-day work happens at the project level; account-level calls are typically once-per-quarter operations (changing billing contact, requesting a new region, upgrading the plan tier).

What's next

Workspaces — the next layer down inside the account.
Region requests — request access to a region you don't have yet.

Reference

POST/api/v1/account/change_password

Change Password

Change the authenticated user's password after verifying their current password.

Request body

JSON body required.

Responses

200Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/account/change_password

GET/api/v1/account/config

Get Config

Return the public payment provider configuration available to the calling user.

Responses

200Successful Response

https://api.nimbusnexus.net/api/v1/account/config

GET/api/v1/account/datacenters

List Datacenters

List the datacenters the portal serves (discovered ∩ configured), with display metadata, per-datacenter health and the current selection.

Responses

200Successful Response
401Unauthorized
500Internal Server Error

https://api.nimbusnexus.net/api/v1/account/datacenters

POST/api/v1/account/forgot_password_request

Forgot Password Request

Send a password reset email containing a one-time token to the supplied address.

Request body

JSON body required.

Responses

200Successful Response
400Bad Request
422Validation error
500Internal Server Error

https://api.nimbusnexus.net/api/v1/account/forgot_password_request

GET/api/v1/account/get_scope_choices

Get Auth Projects

List the workspaces, domains and projects the caller may rescope into.

Responses

200Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/account/get_scope_choices

GET/api/v1/account/get_session_auth_data

Get Session Auth Data

Return the authentication data stored in the current session, including the active scope.

Responses

200Successful Response
400Bad Request
401Unauthorized
500Internal Server Error

https://api.nimbusnexus.net/api/v1/account/get_session_auth_data

POST/api/v1/account/login

Login

Authenticate with email and password and return a JWT access token together with the user's auth data.

Request body

JSON body required.

Responses

200Successful Response
400Bad Request
404Not Found
422Validation error
500Internal Server Error

https://api.nimbusnexus.net/api/v1/account/login

GET/api/v1/account/logout

Logout

Revoke the caller's identity token and clear the server-side session.

Responses

200Successful Response
400Bad Request
500Internal Server Error

https://api.nimbusnexus.net/api/v1/account/logout

POST/api/v1/account/registration

Registration

Start a new user registration by emailing a verification token to the supplied address.

Request body

JSON body required.

Responses

200Successful Response
400Bad Request
422Validation error
500Internal Server Error

https://api.nimbusnexus.net/api/v1/account/registration

GET/api/v1/account/rescope

Rescope

Rescope the current token (`project` or `domain`) and/or switch the session's `region`. A region switch is orthogonal to the token scope, so it may be combined with a project- or domain-rescope in one call. **Required**: at least one of the three; `project` and `domain` remain mutually exclusive.