Account Tokens

Account related operations

List all tokens for the currently authorized account.

GET

https://api.upcloud.com

/1.3/account/tokens

List all tokens for the currently authorized account. The tokens are returned in a paged format, with the default page size being 20. The maximum page size is 100.

List all tokens for the currently authorized account. › query Parameters

limit

integer · int32 · min: 1 · max: 100

How many tokens to return at per page

Default: 20

offset

integer · int32 · min: 0

Offset to start listing the tokens from

Default: 0

gui

boolean

Filter tokens based on GUI flag (true or false). Default is no value, i.e. no filtering and all tokens are returned.

sort

string

Comma-separated list of fields to sort by. Prefix with '+' for ascending or '-' for descending order. Supported fields: created_at, expires_at, last_used_at, name. Example: sort=+name,-created_at. If no prefix is given, descending is assumed. Follows OpenAPI collectionFormat 'csv'.

List all tokens for the currently authorized account. › Responses

A paged array of tokens

accountTokensToken[]

Paged list of tokens.

A token.

accountTokensToken

id

accountTokensUuidOfTheToken · uuid

UUID of the token

Example: e7b3f8a0-4c2d-11ec-bf63-0242ac130002

name

string · minLength: 1 · maxLength: 1024

The name of the token. Does not need to be unique.

Example: my first token

created_at

string · date-time

Token creation time.

expires_at

string · date-time

The requested expiry time of the token, in RFC3339 format (2025-10-12T07:20:50.52Z). Needs to be in the future and maximum of 1 year in the future.

last_used_at

string · date-time

The last time the token was used.

can_create_tokens

boolean

Whether the token can create other tokens.

Default: false

gui

boolean

Token is for internal GUI use. Can not be used externally.

Default: false

allowed_ip_ranges

accountTokensIpRange[] · maxItems: 100 · unique

List of IP ranges that are allowed to authenticate with the token. Empty list denies access from everywhere. If unset, the default list will be the IP filters of the account. If no IP filters are defined for the account either, the default will be ["0.0.0.0/0", "::/0"], i.e. allow from any address.

Create a new API token.

POST

https://api.upcloud.com

/1.3/account/tokens

Create a new API token. Maximum token validity is 24*365h=8760h (~1 year). Attribute allowed_ip_prefixes allows defining a list of CIDR/IP addresses from where the token is accepted. Empty list denies access from everywhere. If unset, the default list will be the IP filters of the account. If no IP filters are defined for the account either, the default will be ["0.0.0.0/0", "::0/0"], i.e. allow from any address.

Create a new API token. › Request Body

accountTokensCreateTokenRequest

name

string · minLength: 1 · maxLength: 1024 · required

The name of the token. Does not need to be unique.

Example: my first token

expires_at

string · date-time

The requested expiry time of the token, in RFC3339 format (2025-10-12T07:20:50.52Z). Needs to be in the future and maximum of 1 year in the future.

expires_in

string

The requested duration until expiry of the token, e.g. '1h30min'. Needs to be a positive duration and maximum of 1 year. Can be used instead of expires_at. Supported units are 'h' for hours, 'm' for minutes and 's' for seconds.

Example: 8760h

can_create_tokens

boolean

Whether the token can create other tokens.

Default: false

gui

boolean

Token is for internal GUI use. Can not be used externally.

Default: false

allowed_ip_ranges

accountTokensIpRange[] · maxItems: 100 · unique

Example: ["0.0.0.0/0","::/0"]

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	requires: expires_at
	requires: expires_in

Properties for Variant 1:

expires_in

Create a new API token. › Responses

Token created successfully

A token.

accountTokensToken

id

accountTokensUuidOfTheToken · uuid

UUID of the token

Example: e7b3f8a0-4c2d-11ec-bf63-0242ac130002

name

string · minLength: 1 · maxLength: 1024

The name of the token. Does not need to be unique.

Example: my first token

created_at

string · date-time

Token creation time.

expires_at

string · date-time

The requested expiry time of the token, in RFC3339 format (2025-10-12T07:20:50.52Z). Needs to be in the future and maximum of 1 year in the future.

last_used_at

string · date-time

The last time the token was used.

can_create_tokens

boolean

Whether the token can create other tokens.

Default: false

gui

boolean

Token is for internal GUI use. Can not be used externally.

Default: false

allowed_ip_ranges

accountTokensIpRange[] · maxItems: 100 · unique

POST/1.3/account/tokens

curl https://api.upcloud.com/1.3/account/tokens \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "token",
  "expires_at": "2025-11-30T08:03:15.944Z",
  "can_create_tokens": true,
  "gui": false,
  "allowed_ip_ranges": [
    "0.0.0.0/0",
    "::/0"
  ]
}'

Example Request Body

{
  "name": "token",
  "expires_at": "2025-11-30T08:03:15.944Z",
  "can_create_tokens": true,
  "gui": false,
  "allowed_ip_ranges": [
    "0.0.0.0/0",
    "::/0"
  ]
}

json

Example Responses

{
  "id": "e7b3f8a0-4c2d-11ec-bf63-0242ac130002",
  "name": "my first token",
  "created_at": "2025-11-30T08:03:15.944Z",
  "expires_at": "2025-11-30T08:03:15.944Z",
  "last_used_at": "2025-11-30T08:03:15.944Z",
  "can_create_tokens": false,
  "gui": false,
  "allowed_ip_ranges": [
    "0.0.0.0/0",
    "::/0"
  ]
}

json

application/json

GET

https://api.upcloud.com

/1.3/account/tokens/{token-uuid}

Get the details of a specific token.

path Parameters

token-uuid

string · uuid · required

The uuid of the token to get

Responses

Details of the token

A token.

accountTokensGetTokenResponse

id

accountTokensUuidOfTheToken · uuid

UUID of the token

Example: e7b3f8a0-4c2d-11ec-bf63-0242ac130002

name

string · minLength: 1 · maxLength: 1024

The name of the token. Does not need to be unique.

Example: my first token

created_at

string · date-time

Token creation time.

expires_at

string · date-time

The requested expiry time of the token, in RFC3339 format (2025-10-12T07:20:50.52Z). Needs to be in the future and maximum of 1 year in the future.

last_used_at

string · date-time

The last time the token was used.

can_create_tokens

boolean

Whether the token can create other tokens.

Default: false

gui

boolean

Token is for internal GUI use. Can not be used externally.

Default: false

allowed_ip_ranges

accountTokensIpRange[] · maxItems: 100 · unique

Revoke a specific token

DELETE

https://api.upcloud.com

/1.3/account/tokens/{token-uuid}

Delete a specific token.

Revoke a specific token › path Parameters

token-uuid

string · uuid · required

The uuid of the token to delete

Revoke a specific token › Responses

Token was revoked successfully

No data returned

Account Permission

List all tokens for the currently authorized account.

GET

https://api.upcloud.com

/1.3/account/tokens

List all tokens for the currently authorized account. The tokens are returned in a paged format, with the default page size being 20. The maximum page size is 100.

List all tokens for the currently authorized account. › query Parameters

limit

integer · int32 · min: 1 · max: 100

How many tokens to return at per page

Default: 20

offset

integer · int32 · min: 0

Offset to start listing the tokens from

Default: 0

gui

boolean

Filter tokens based on GUI flag (true or false). Default is no value, i.e. no filtering and all tokens are returned.

sort

string

List all tokens for the currently authorized account. › Responses

A paged array of tokens

accountTokensToken[]

Paged list of tokens.

A token.

accountTokensToken

id

accountTokensUuidOfTheToken · uuid

UUID of the token

Example: e7b3f8a0-4c2d-11ec-bf63-0242ac130002

name

string · minLength: 1 · maxLength: 1024

The name of the token. Does not need to be unique.

Example: my first token

created_at

string · date-time

Token creation time.

expires_at

string · date-time

The requested expiry time of the token, in RFC3339 format (2025-10-12T07:20:50.52Z). Needs to be in the future and maximum of 1 year in the future.

last_used_at

string · date-time

The last time the token was used.

can_create_tokens

boolean

Whether the token can create other tokens.

Default: false

gui

boolean

Token is for internal GUI use. Can not be used externally.

Default: false

allowed_ip_ranges

accountTokensIpRange[] · maxItems: 100 · unique

Create a new API token.

POST

https://api.upcloud.com

/1.3/account/tokens

Create a new API token. › Request Body

accountTokensCreateTokenRequest

name

string · minLength: 1 · maxLength: 1024 · required

The name of the token. Does not need to be unique.

Example: my first token

expires_at

string · date-time

The requested expiry time of the token, in RFC3339 format (2025-10-12T07:20:50.52Z). Needs to be in the future and maximum of 1 year in the future.

expires_in

string

Example: 8760h

can_create_tokens

boolean

Whether the token can create other tokens.

Default: false

gui

boolean

Token is for internal GUI use. Can not be used externally.

Default: false

allowed_ip_ranges

accountTokensIpRange[] · maxItems: 100 · unique

Example: ["0.0.0.0/0","::/0"]

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	requires: expires_at
	requires: expires_in

Properties for Variant 1:

expires_in

Create a new API token. › Responses

Token created successfully

A token.

accountTokensToken

id

accountTokensUuidOfTheToken · uuid

UUID of the token

Example: e7b3f8a0-4c2d-11ec-bf63-0242ac130002

name

string · minLength: 1 · maxLength: 1024

The name of the token. Does not need to be unique.

Example: my first token

created_at

string · date-time

Token creation time.

expires_at

string · date-time

The requested expiry time of the token, in RFC3339 format (2025-10-12T07:20:50.52Z). Needs to be in the future and maximum of 1 year in the future.

last_used_at

string · date-time

The last time the token was used.

can_create_tokens

boolean

Whether the token can create other tokens.

Default: false

gui

boolean

Token is for internal GUI use. Can not be used externally.

Default: false

allowed_ip_ranges

accountTokensIpRange[] · maxItems: 100 · unique

Revoke a specific token

DELETE

https://api.upcloud.com

/1.3/account/tokens/{token-uuid}

Delete a specific token.

Revoke a specific token › path Parameters

token-uuid

string · uuid · required

The uuid of the token to delete

Revoke a specific token › Responses

Token was revoked successfully

No data returned