Account

Download schema

Account management and authentication

Account details

GET

https://api.upcloud.com

/1.3/account

Returns account details for the authenticated user

Account details › Responses

Account details

Response schema containing account details.

account

accountDetails · required

Detailed account information and limits.

GET/1.3/account

curl https://api.upcloud.com/1.3/account \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "account": {
    "username": "apiuser01",
    "credits": 25.5,
    "resource_limits": {
      "managed_databases": 5,
      "network_peerings": 20,
      "file_storages": 10,
      "managed_kubernetes": 5,
      "tags": 200,
      "cores": 64,
      "cloud_server_dev_1xcpu_1gb_10gb_plans": 0,
      "cloud_server_dev_1xcpu_1gb_plans": 0,
      "storage_hdd": 10240,
      "networks": 100,
      "network_gateways_essentials": 20,
      "network_gateways": 20,
      "storage_ssd": 20480,
      "load_balancers_essentials": 20,
      "load_balancers": 20,
      "gpus": 8,
      "detached_interfaces": 100,
      "detached_floating_ips": 50,
      "managed_object_storages": 50,
      "memory": 524288,
      "ntp_excess_gib": 100,
      "public_ipv4": 64,
      "public_ipv6": 64,
      "routers": 20,
      "storage_maxiops": 10240,
      "storage_standard": 20480,
      "storage_total": 40960
    }
  }
}

json

application/json

Get monthly billing summary with resource details

GET

https://api.upcloud.com

/1.3/account/billing/summary/{year}-{month}

Returns a billing summary grouped by resource, including billing detail changes during the specified month. The API user must have permission to read billing details.

Get monthly billing summary with resource details › path Parameters

year

string · pattern: ^20\d{2}$ · required

Billing year.

month

string · pattern: ^(0[1-9]|1[0-2])$ · required

Billing month.

Get monthly billing summary with resource details › query Parameters

username

accountUserName · minLength: 4 · maxLength: 64

Return the billing summary for this account instead of the calling account. Requires Partner API access and an existing association with the account.

Username for an account.

resource_id

string · maxLength: 128

Return details only for this resource UUID or IP address.

Get monthly billing summary with resource details › Responses

Detailed monthly billing summary.

Monthly billing totals grouped by resource type and subtype.

accountBillingSummary

currency

accountCurrencyCode · pattern: ^[A-Z]{3}$

ISO 4217 code

total_amount

number

GET/1.3/account/billing/summary/{year}-{month}

curl https://api.upcloud.com/1.3/account/billing/summary/:year-:month \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "currency": "EUR",
  "managed_databases": {
    "managed_database": {
      "resources": [
        {
          "amount": 15.10223,
          "details": [
            {
              "amount": 15.10223,
              "hours": 420,
              "plan": "1x1xCPU-2GB-25GB",
              "zone": "fi-hel2"
            }
          ],
          "hours": 420,
          "resource_id": "09001a4d-b525-4ab8-835d-000000000000"
        }
      ],
      "total_amount": 15.10223
    },
    "total_amount": 15.10223
  },
  "managed_object_storages": {
    "managed_object_storage": {
      "resources": [
        {
          "amount": 5.03384,
          "details": [
            {
              "amount": 5.03384,
              "billable_size_gib": 500,
              "hours": 420,
              "zone": "fi-hel2"
            }
          ],
          "hours": 420,
          "resource_id": "127ee42a-8304-477c-84e1-000000000000"
        }
      ],
      "total_amount": 5.03384
    },
    "total_amount": 5.03384
  },
  "servers": {
    "server": {
      "resources": [
        {
          "amount": 16.18091,
          "details": [
            {
              "amount": 16.18091,
              "hours": 420,
              "labels": [
                {
                  "key": "test",
                  "value": ""
                }
              ],
              "plan": "2xCPU-4GB",
              "zone": "fi-hel2"
            }
          ],
          "hours": 420,
          "resource_id": "001c2caa-00dc-4eff-9321-000000000000"
        },
        {
          "amount": 16.10386,
          "details": [
            {
              "amount": 16.10386,
              "hours": 418,
              "labels": [
                {
                  "key": "test2",
                  "value": ""
                }
              ],
              "plan": "2xCPU-4GB",
              "zone": "fi-hel2"
            },
            {
              "amount": 0.9288,
              "hours": 12,
              "labels": [
                {
                  "key": "test2",
                  "value": ""
                }
              ],
              "plan": "4xCPU-8GB",
              "zone": "fi-hel2"
            }
          ],
          "hours": 430,
          "resource_id": "0010cf04-3608-4512-b4de-000000000000"
        }
      ],
      "total_amount": 33.21357
    },
    "total_amount": 33.21357
  },
  "total_amount": 53.34964
}

json

application/json

Get monthly billing summary

GET

https://api.upcloud.com

/1.3/account/billing_summary/{year}-{month}

Returns a billing summary for the specified month. The API user must have permission to read billing details. This endpoint is deprecated; use the monthly billing summary with resource details instead.

Get monthly billing summary › path Parameters

year

string · pattern: ^20\d{2}$ · required

Billing year.

month

string · pattern: ^(0[1-9]|1[0-2])$ · required

Billing month.

Get monthly billing summary › Responses

Monthly billing summary.

Response containing a monthly billing summary.

accountBillingSummaryResponse

accountBillingSummary · required

Monthly billing totals grouped by resource type and subtype.

GET/1.3/account/billing_summary/{year}-{month}

curl https://api.upcloud.com/1.3/account/billing_summary/:year-:month \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "billing": {
    "currency": "EUR",
    "networks": {
      "bandwidth": {
        "total_amount": 52.136
      },
      "total_amount": 52.136
    },
    "managed_databases": {
      "managed_database": {
        "total_amount": 80.13127
      },
      "total_amount": 80.13127
    },
    "managed_object_storages": {
      "managed_object_storage": {
        "total_amount": 2.2253
      },
      "total_amount": 2.2253
    },
    "servers": {
      "server": {
        "total_amount": 28.05132
      },
      "total_amount": 28.05132
    },
    "storages": {
      "storage": {
        "total_amount": 3.6224
      },
      "total_amount": 3.6224
    },
    "total_amount": 166.16629
  }
}

json

application/json

Get current network usage

GET

https://api.upcloud.com

/1.3/account/current_network_usage

Returns the latest Network Transfer Pool usage report for the account.

Get current network usage › Responses

Current Fair Transfer Policy usage.

Current Fair Transfer Policy usage for an account.

accountCurrentNetworkUsage

object · required

List accounts

GET

https://api.upcloud.com

/1.3/account/list

Returns the main account and its subaccounts. Account listing is available only to the main account.

List accounts › query Parameters

label

string

Filter by label key or key-value pair. Repeat the parameter to require all labels. Label keys are matched case-insensitively.

List accounts › Responses

Account list.

Main account and subaccounts accessible to the authenticated account.

accounts

object · required

GET/1.3/account/list

curl https://api.upcloud.com/1.3/account/list \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "accounts": {
    "account": [
      {
        "labels": [],
        "roles": {
          "role": [
            "technical"
          ]
        },
        "type": "mymain",
        "username": "test"
      },
      {
        "labels": [],
        "roles": {
          "role": [
            "technical"
          ]
        },
        "type": "sub",
        "username": "my_sub_account"
      },
      {
        "labels": [
          {
            "key": "to_be_removed",
            "value": "after 2022-31-12"
          }
        ],
        "roles": {
          "role": []
        },
        "type": "sub",
        "username": "my_temp_account"
      },
      {
        "labels": [],
        "roles": {
          "role": [
            "billing"
          ]
        },
        "type": "sub",
        "username": "my_billing_account"
      }
    ]
  }
}

json

application/json

Create Microsoft LMA signing link

POST

https://api.upcloud.com

/1.3/account/ms_lma

Create a new Microsoft LMA signing link

Create Microsoft LMA signing link › Responses

LMA signing link created successfully

Response schema for Microsoft LMA signing link creation.

accountCreateMsLmaSigningLinkResponse

object

Get top network usage

GET

https://api.upcloud.com

/1.3/account/network_top_usage

Returns the resources with the highest network usage.

Get top network usage › query Parameters

from

accountRfc3339Datetime · date-time · required

Start of the usage period.

Datetime in RFC 3339 format

Example: 2026-07-01T00:00:00Z

to

accountRfc3339Datetime · date-time · required

End of the usage period.

Datetime in RFC 3339 format

Example: 2026-07-01T00:00:00Z

service

accountResourceNetworkUsageType · enum

Filter by service type. Repeat the parameter to include multiple service types.

Network usage type for resource

Enum values:

load_balancer_private

load_balancer_private_vlan

load_balancer_public

network_gateway_private

network_gateway_private_vlan

network_gateway_public

object_storage_v2_private

object_storage_v2_public

zone

accountZone · minLength: 2 · maxLength: 15 · pattern: ^[a-z][a-z0-9-]{0,14…

Filter by zone. Repeat the parameter to include multiple zones.

Zone identifier

Example: fi-hel1

accumulate

accountUsageAccumulateParameter · enum

Accumulation period for the usage statistics.

Usage accumulator hour or day parameter

Enum values:

hour

day

Get top network usage › Responses

Top resource network usage statistics.

Network usage statistics grouped by resource.

accountResourceNetworkUsage

object · required

GET/1.3/account/network_top_usage

curl 'https://api.upcloud.com/1.3/account/network_top_usage?from=<string>&to=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "stats": {
    "stat": [
      {
        "resource_id": "00777436-a6f8-43af-9daf-89e8e6833a7a",
        "sent_bytes": 10094,
        "service": "server_public",
        "start_time": "2020-09-07T00:00:00Z",
        "zone": "de-fra1"
      },
      {
        "resource_id": "00777436-a6f8-43af-9daf-89e8e6833a7a",
        "sent_bytes": 35174050,
        "service": "server_public",
        "start_time": "2020-09-08T00:00:00Z",
        "zone": "de-fra1"
      },
      {
        "resource_id": "00777436-a6f8-43af-9daf-89e8e6833a7a",
        "sent_bytes": 32790622,
        "service": "server_public",
        "start_time": "2020-09-09T00:00:00Z",
        "zone": "de-fra1"
      }
    ]
  }
}

json

application/json

Get network transfer statistics

GET

https://api.upcloud.com

/1.3/account/network_usage

Returns network transfer statistics. JSON responses support a maximum time window of 31 days; CSV responses have no time-window limit. Select the output format with the Accept header using application/json or text/csv.

Get network transfer statistics › query Parameters

from

accountRfc3339Datetime · date-time · required

First measurement timestamp in RFC 3339 format.

Datetime in RFC 3339 format

Example: 2026-07-01T00:00:00Z

to

accountRfc3339Datetime · date-time · required

Last measurement timestamp in RFC 3339 format.

Datetime in RFC 3339 format

Example: 2026-07-01T00:00:00Z

accumulate

accountUsageAccumulateParameter · enum

Accumulate the transfer statistics by hour or day.

Usage accumulator hour or day parameter

Enum values:

hour

day

Get network transfer statistics › Responses

Account network usage statistics.

Account network usage and Fair Transfer Policy quota statistics.

accountNetworkUsage

object · required

GET/1.3/account/network_usage

curl 'https://api.upcloud.com/1.3/account/network_usage?from=<string>&to=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "stats": {
    "stat": [
      {
        "accumulated_quota_bytes": 6352371508013,
        "projected_monthly_quota_bytes": 6362243967561,
        "quota_increase_bytes": 9872459548,
        "sent_bytes": 1254,
        "start_time": "2020-09-30T22:00:00Z",
        "total_sent_bytes": 225149331390
      },
      {
        "accumulated_quota_bytes": 6362243967561,
        "projected_monthly_quota_bytes": 6362243967561,
        "quota_increase_bytes": 9872459548,
        "sent_bytes": 1254,
        "start_time": "2020-09-30T23:00:00Z",
        "total_sent_bytes": 225149332644
      },
      {
        "accumulated_quota_bytes": 9872459548,
        "projected_monthly_quota_bytes": 7345109903712,
        "quota_increase_bytes": 9872459548,
        "sent_bytes": 906,
        "start_time": "2020-10-01T00:00:00Z",
        "total_sent_bytes": 906
      }
    ]
  }
}

json

application/json

Get resource usage

GET

https://api.upcloud.com

/1.3/account/resource-usage

Returns current resource usage counts for the account.

Get resource usage › Responses

Current account resource usage.

Current account resource usage keyed by resource limit name.

accountResourceUsage

integer · min: 0

Get monthly resource billing summary

GET

https://api.upcloud.com

/1.3/account/resource_billing_summary/{resource_id}/{year}-{month}

Returns a billing summary for one resource during the specified month. The API user must have permission to read billing details.

Get monthly resource billing summary › path Parameters

resource_id

string · required

Server UUID, storage UUID, or IP address.

year

string · pattern: ^20\d{2}$ · required

Billing year.

month

string · pattern: ^(0[1-9]|1[0-2])$ · required

Billing month.

Get monthly resource billing summary › Responses

Monthly resource billing summary.

Response containing the monthly billing summary for a resource.

accountResourceBillingSummaryResponse

object · required

GET/1.3/account/resource_billing_summary/{resource_id}/{year}-{month}

curl https://api.upcloud.com/1.3/account/resource_billing_summary/:resource_id/:year-:month \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "billing": {
    "daily_sums": {
      "2019-12-02": 3.33684,
      "2019-12-03": 52.77344,
      "2019-12-04": 1.07424,
      "2019-12-05": 1.07424,
      "2019-12-06": 1.07424,
      "2019-12-07": 1.07424,
      "2019-12-08": 1.07424,
      "2019-12-09": 1.07424,
      "2019-12-12": 3.22272,
      "2019-12-13": 0.58188
    },
    "details": {
      "hours": 792,
      "plan": "1xCPU-1GB",
      "resource_id": "00ce9363-9065-4c2a-9d66-3b0c762f556b",
      "title": "My Glorious Server",
      "type": "server",
      "zone": "fi-hel1"
    },
    "total_amount": 66.36032
  }
}

json

application/json

Get resource transfer statistics

GET

https://api.upcloud.com

/1.3/account/resource_network_usage

Returns network transfer statistics grouped by resource, service, and zone. JSON responses support a maximum time window of 31 days; CSV responses have no time-window limit. Select the output format with the Accept header using application/json or text/csv.

Get resource transfer statistics › query Parameters

from

accountRfc3339Datetime · date-time · required

Data start timestamp in RFC 3339 format.

Datetime in RFC 3339 format

Example: 2026-07-01T00:00:00Z

to

accountRfc3339Datetime · date-time · required

Data end timestamp in RFC 3339 format.

Datetime in RFC 3339 format

Example: 2026-07-01T00:00:00Z

service

accountResourceNetworkUsageType · enum

Limit results to a service type. Repeat the parameter to include multiple service types.

Network usage type for resource

Enum values:

load_balancer_private

load_balancer_private_vlan

load_balancer_public

network_gateway_private

network_gateway_private_vlan

network_gateway_public

object_storage_v2_private

object_storage_v2_public

resource_id

accountUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Limit results to this resource UUID.

Universally unique identifier

zone

accountZone · minLength: 2 · maxLength: 15 · pattern: ^[a-z][a-z0-9-]{0,14…

Limit results to a zone. Repeat the parameter to include multiple zones.

Zone identifier

Example: fi-hel1

accumulate

accountUsageAccumulateParameter · enum

Accumulate the transfer statistics by hour or day.

Usage accumulator hour or day parameter

Enum values:

hour

day

Get resource transfer statistics › Responses

Resource network usage statistics.

Network usage statistics grouped by resource.

accountResourceNetworkUsage

object · required

GET/1.3/account/resource_network_usage

curl 'https://api.upcloud.com/1.3/account/resource_network_usage?from=<string>&to=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "stats": {
    "stat": [
      {
        "resource_id": "00777436-a6f8-43af-9daf-89e8e6833a7a",
        "sent_bytes": 10094,
        "service": "server_public",
        "start_time": "2020-09-07T00:00:00Z",
        "zone": "de-fra1"
      },
      {
        "resource_id": "00777436-a6f8-43af-9daf-89e8e6833a7a",
        "sent_bytes": 35174050,
        "service": "server_public",
        "start_time": "2020-09-08T00:00:00Z",
        "zone": "de-fra1"
      },
      {
        "resource_id": "00777436-a6f8-43af-9daf-89e8e6833a7a",
        "sent_bytes": 32790622,
        "service": "server_public",
        "start_time": "2020-09-09T00:00:00Z",
        "zone": "de-fra1"
      }
    ]
  }
}

json

application/json

Create subaccount

POST

https://api.upcloud.com

/1.3/account/sub

Creates a subaccount for the authenticated main account.

Create subaccount › Request Body

Request for creating a subaccount.

createSubaccountRequest

object · required

Create subaccount › Responses

Subaccount created.

No data returned

POST/1.3/account/sub

curl https://api.upcloud.com/1.3/account/sub \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "sub_account": {
    "first_name": "first",
    "last_name": "last",
    "company": "my company name",
    "address": "my address",
    "postal_code": "00130",
    "city": "Helsinki",
    "state": "",
    "country": "FIN",
    "phone": "+358.31245434",
    "email": "[email protected]",
    "vat_number": "my vat number",
    "timezone": "Europe/Helsinki",
    "username": "myusername",
    "password": "mysecr3tPassword",
    "currency": "EUR",
    "language": "en",
    "roles": {
      "role": [
        "technical",
        "billing",
        "aux_billing"
      ]
    },
    "allow_gui": "no",
    "allow_api": "yes",
    "network_access": {
      "network": []
    },
    "server_access": {
      "server": []
    },
    "storage_access": {
      "storage": []
    },
    "tag_access": {
      "tag": []
    },
    "ip_filters": {
      "ip_filter": []
    },
    "labels": [
      {
        "key": "department",
        "value": "it"
      }
    ]
  }
}'

Example Request Body

{
  "sub_account": {
    "first_name": "first",
    "last_name": "last",
    "company": "my company name",
    "address": "my address",
    "postal_code": "00130",
    "city": "Helsinki",
    "state": "",
    "country": "FIN",
    "phone": "+358.31245434",
    "email": "[email protected]",
    "vat_number": "my vat number",
    "timezone": "Europe/Helsinki",
    "username": "myusername",
    "password": "mysecr3tPassword",
    "currency": "EUR",
    "language": "en",
    "roles": {
      "role": [
        "technical",
        "billing",
        "aux_billing"
      ]
    },
    "allow_gui": "no",
    "allow_api": "yes",
    "network_access": {
      "network": []
    },
    "server_access": {
      "server": []
    },
    "storage_access": {
      "storage": []
    },
    "tag_access": {
      "tag": []
    },
    "ip_filters": {
      "ip_filter": []
    },
    "labels": [
      {
        "key": "department",
        "value": "it"
      }
    ]
  }
}

json

Example Responses

No example specified for this content type

Delete subaccount

DELETE

https://api.upcloud.com

/1.3/account/sub/{username}

Deletes a subaccount from the authenticated main account.

Delete subaccount › path Parameters

username

accountUserName · minLength: 4 · maxLength: 64 · required

Subaccount username.

Username for an account.

Delete subaccount › Responses

Subaccount deleted.

No data returned

Firewall Ruleset Audit Logs