Account
You can obtain your account details and update them through CloudAPI, although login cannot be changed, and password can not be retrieved.
GetAccount (GET /:login)
Retrieves your account details. Instead of providing your login name, you can also provide 'my' (i.e. GET /my).
Inputs
None
Returns
Account object:
Field | Type | Description |
id | UUID | Unique id for this account |
login | String | Your login name |
String | Email address | |
companyName | String | ... |
firstName | String | ... |
lastName | String | ... |
address | String | ... |
postalCode | String | ... |
city | String | ... |
state | String | ... |
country | String | ... |
phone | String | ... |
created | ISO8601 date | When this account was created |
updated | ISO8601 date | When this account's details was last updated |
triton_cns_enabled | Boolean |
|
Errors
For all possible errors, see CloudAPI HTTP Responses.
Error Code | Description |
ResourceNotFound | If |
CLI Command
or
Example Request
Example Response
UpdateAccount (POST /:login)
Update your account details with the given parameters.
Inputs
Field | Type | Description |
String | Email address | |
companyName | String | ... |
firstName | String | ... |
lastName | String | ... |
address | String | ... |
postalCode | String | ... |
city | String | ... |
state | String | ... |
country | String | ... |
phone | String | ... |
triton_cns_enabled | Boolean | Enable or disable the Triton CNS |
Returns
Account object:
Field | Type | Description |
id | UUID | Unique id for this account |
login | String | Your login name |
String | Email address | |
companyName | String | ... |
firstName | String | ... |
lastName | String | ... |
address | String | ... |
postalCode | String | ... |
city | String | ... |
state | String | ... |
country | String | ... |
phone | String | ... |
created | ISO8601 date | When this account was created |
updated | ISO8601 date | When this account's details was last updated |
triton_cns_enabled | Boolean |
|
Errors
For all possible errors, see CloudAPI HTTP Responses.
Error Code | Description |
ResourceNotFound | If |
CLI Command
or
Example Request
Example Response
GetAccountLimits (GET /:login/limits)
When the operator has enabled the CloudAPI Provisioning Limits plugin, you can retreive your account limits and usage through this API.
See the Provisioning Limits plugin for how limits are configured and used in Triton.
Inputs
None
Returns
An array of provisioning limit objects. Possible values for each provisioning limit object are:
Field | Type | Description | Possible values |
by | String | The type of limit. Note that "machines" means the "number of machines". | "ram", "quota", or "machines". |
value | Number | The limit value. I.e. the total number of machines, total ram or total quota. | Ram is defined in terms of MiB. Quota is defined in terms of GiB. |
used | Number | How much of the limit is used by existing machines. | Ram is defined in terms of MiB. Quota is defined in terms of GiB. |
check | String | Optional. Restricts the limit to an image name or to an image os. | "image" or "os". |
os | String | Optional. When | Usually, this will be one of |
image | String | Optional. When | See IMGAPI image name. |
Errors
For all possible errors, see CloudAPI HTTP Responses.
Error Code | Description |
ResourceNotFound | If |
Example Request
Example Response
Keys
Last updated