Examples in

Visão geral da conta

Uma "conta" fica acima de todos os workspaces, projetos e recursos que você tem na NimbusNexus. Ela guarda o contato de faturamento, o nome da entidade jurídica que aparece nas faturas, o nível do plano (free / starter / production / enterprise), as regiões em cuja allow-list você está e as preferências que valem para a conta inteira. Existe exatamente uma conta por cadastro.

A maioria destes endpoints é somente leitura para quem não é proprietário e de leitura e escrita para os proprietários. O trabalho do dia a dia acontece no nível do projeto; as chamadas no nível da conta costumam ser operações feitas uma vez por trimestre (trocar o contato de faturamento, solicitar uma nova região, fazer upgrade do nível do plano).

Próximos passos

Workspaces — a próxima camada abaixo, dentro da conta.
Solicitações de região — solicite acesso a uma região que você ainda não tem.

Reference

POST/api/v1/account/change_password

Change Password

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

Request body

Field	Type	Description
new_password*	string	—
confirm_password*	string	—
current_password*	string	—

Responses

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

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/account/change_password" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "new_password": "example",
    "confirm_password": "example",
    "current_password": "example"
  }'

GET/api/v1/account/config

Get Config

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

Responses

200Successful Response

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/account/config" \
  -H "Authorization: Bearer $NIMBUS_KEY"

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

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/account/datacenters" \
  -H "Authorization: Bearer $NIMBUS_KEY"

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

Field	Type	Description
email*	string	—

Responses

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

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/account/forgot_password_request" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]"
  }'

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

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/account/get_scope_choices" \
  -H "Authorization: Bearer $NIMBUS_KEY"

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

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/account/get_session_auth_data" \
  -H "Authorization: Bearer $NIMBUS_KEY"

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

Field	Type	Description
email*	string	User email
password*	string	User password
domain	string \| null	User domain
system	boolean	System scope flag

Responses

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

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/account/login" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "example"
  }'

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

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/account/logout" \
  -H "Authorization: Bearer $NIMBUS_KEY"

POST/api/v1/account/registration

Registration

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

Request body

Field	Type	Description
email*	string	—

Responses

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

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/account/registration" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]"
  }'

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.

Parameters

Name	In	Type	Description
project	query	string \| null	—
domain	query	string \| null	—
region	query	string \| null	—

Responses

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

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/account/rescope" \
  -H "Authorization: Bearer $NIMBUS_KEY"

POST/api/v1/account/reset_password

Reset Password

Complete a password reset or registration flow by validating the emailed token and setting the new password.

Request body

Field	Type	Description
new_password*	string	—
confirm_password*	string	—
token*	string	—
type*	"register" \| "reset"	—

Responses

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

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/account/reset_password" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "new_password": "example",
    "confirm_password": "example",
    "token": "example",
    "type": "register"
  }'

GET/api/v1/account/un_scope

Un Scope

Drop the current scope and switch the session back to the unscoped token.

Responses

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

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/account/un_scope" \
  -H "Authorization: Bearer $NIMBUS_KEY"

Need to make a real call? Try these endpoints in the live Swagger UI →

Edit this page on GitHub