Account

List accounts

GET/api/v2/accounts
Lists the accessible accounts.

Query Parameters

ParameterDescription
like string
Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
showLimit integer
Query parameter to limit the maximum number of rows returned by a command.
history boolean
Optionally includes dropped accounts that have not yet been purged.

Response

CodeDescription
200
Successful request.
202
Successfully accepted the request, but it is not completed yet.

Create an account

POST/api/v2/accounts
Creates a account. You must provide the full account definition when creating a account.

Response

CodeDescription
200
Successful request.
202

Delete an account

DELETE/api/v2/accounts/{name}
Deletes the specified account. If you enable the `ifExists` parameter, the operation succeeds even if the account does not exist. Otherwise, a 404 failure is returned if the account does not exist. if the drop is unsuccessful.

Path Parameters

ParameterDescription
name 
Identifier (i.e. name) for the resource.

Query Parameters

ParameterDescription
ifExists boolean
Query parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.
gracePeriodInDays integer
Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days.

Response

CodeDescription
200
202

Restore an account

POST/api/v2/accounts/{name}:undrop
Restores a dropped account that has not yet been permanently deleted (a dropped account that is within its grace period).

Response

CodeDescription
200
202
Language: English