UpCloud

Accounts

An API user account and password is required to access the UpCloud API. The API user is associated with an UpCloud account. A user account may have multiple API users to be used in different client software. In order to use resources from the cloud, the account must have enough credits.

Credits

Credits are used to pay for cloud resources such as servers, storages, network traffic and IP addresses. Credits are automatically deducted for used resources on an hourly basis. Should the user run out of credits, active resources will be disabled and reactivated after the credit balance returns to positive. Credits can be purchased from the UpCloud website.

GET/1.3/account

Get account information

Returns information on the user's account and resource limits.

Response fields

  • Name
    credits
    Type
    number
    Description

    Current account credit balance.

  • Name
    username
    Type
    string
    Description

    Account username.

  • Name
    resource_limits
    Type
    object
    Description

    Object containing resource limit values.

Request

GET
/1.3/account
curl -X GET https://api.upcloud.com/1.3/account \
  -u your_username:your_password