👀 This is a preview of our new OpenAPI based API documentation.

LOGIN
TRY FOR FREE

API Reference

Getting Started

Server

Network

Account & Access

Returns account details for the authenticated userget

Create a new Microsoft LMA signing linkpost

Billing

powered by Zudoku

UpCloud API

Account

Download schema

Account management and authentication

Returns account details for the authenticated user

GET

https://api.upcloud.com

/1.3/account

Returns account details for the authenticated user

Returns account details for the authenticated user › Responses

Account details

accountDetails · required

GET/1.3/account

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

Example Responses

{
  "account": {
    "resource_limits": {},
    "username": "username",
    "credits": 0,
    "trial_mode": 0
  }
}

json

application/json

Create a new Microsoft LMA signing link

POST

https://api.upcloud.com

/1.3/account/ms_lma

Create a new Microsoft LMA signing link

Create a new Microsoft LMA signing link › Responses

LMA signing link created successfully

accountCreateMsLmaSigningLinkResponse

object

type

POST/1.3/account/ms_lma

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

Example Responses

{
  "signing_status": {
    "id": "id",
    "initiated": "2024-08-25T15:00:00Z",
    "signed_at": "2024-08-25T15:00:00Z",
    "signing_link": "https://www.example.com/path/to/resource",
    "state": "initiated"
  },
  "type": {}
}

json

application/json

Firewall Ruleset Account Tokens