Schemas

List of Kubelet arguments

Kubelet argument presented as key-value pair

kubernetesKubeletArg

key

kubernetesKey · required

Key of a key-value pair

value

kubernetesValue · maxLength: 255 · required

Value of a key-value pair

kubernetesLabel

Label for identifying node groups, presented as key-value pair

key

kubernetesKey · required

Key of a key-value pair

value

kubernetesValue · maxLength: 255

Value of a key-value pair

kubernetesLabels

kubernetesLabel[] · unique

List of labels

Label for identifying node groups, presented as key-value pair

kubernetesLabel

key

kubernetesKey · required

Key of a key-value pair

value

kubernetesValue · maxLength: 255

Value of a key-value pair

kubernetesMessage

string

Message text content

kubernetesName

string · pattern: ^[a-z0-9]([-a-z0-9]*…

Name

kubernetesNodeName

string · pattern: ^[a-z0-9]([-a-z0-9]*…

Node name

kubernetesNetwork

string · minLength: 1

Network UUID

kubernetesNetworkCIDR

string

CIDR of the given network

kubernetesNodeGroup

Node group for a Kubernetes cluster

count

kubernetesCount · int32 · min: 0 · max: 16 · required

Amount of nodes in a node group

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

plan

kubernetesNodeGroupPlan · required

Node group plan

kubernetesNodeGroupCustomPlan

List of Kubelet arguments

kubernetesLabel[] · unique

List of labels

Node group custom plan properties

kubernetesNodeGroupCloudNativePlan

Node group cloud native plan properties

kubernetesNodeGroupGPUPlan

Node group GPU plan properties

ssh_keys

kubernetesSshKey[] · unique

List of public SSH keys

state

kubernetesNodeGroupState · enum

Node group operational state

Enum values:

failed

pending

running

terminating

unknown

scaling-up

scaling-down

storage

kubernetesStorage · uuid

Storage UUID to use as a template

storage_encryption

kubernetesStorageEncryption · enum

The storage encryption strategy.

Enum values:

data-at-rest

none

kubernetesUtilityNetworkAccess

List of taints

anti_affinity

kubernetesAntiAffinity

Enable anti-affinity policies

Default: false

utility_network_access

Enable utility network access

Default: true

node_updates

kubernetesNodeUpdates

Enable periodic package updates on node

kubernetesNodeGroupPatch

count

kubernetesCount · int32 · min: 0 · max: 16 · required

Amount of nodes in a node group

kubernetesNodeGroups

kubernetesNodeGroup[] · maxItems: 16 · unique

List of node groups

Node group for a Kubernetes cluster

kubernetesNodeGroup

count

kubernetesCount · int32 · min: 0 · max: 16 · required

Amount of nodes in a node group

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

plan

kubernetesNodeGroupPlan · required

Node group plan

kubernetesNodeGroupCustomPlan

List of Kubelet arguments

kubernetesLabel[] · unique

List of labels

Node group custom plan properties

kubernetesNodeGroupCloudNativePlan

Node group cloud native plan properties

kubernetesNodeGroupGPUPlan

Node group GPU plan properties

ssh_keys

kubernetesSshKey[] · unique

List of public SSH keys

state

kubernetesNodeGroupState · enum

Node group operational state

Enum values:

failed

pending

running

terminating

unknown

scaling-up

scaling-down

storage

kubernetesStorage · uuid

Storage UUID to use as a template

storage_encryption

kubernetesStorageEncryption · enum

The storage encryption strategy.

Enum values:

data-at-rest

none

kubernetesUtilityNetworkAccess

List of taints

anti_affinity

kubernetesAntiAffinity

Enable anti-affinity policies

Default: false

utility_network_access

Enable utility network access

Default: true

node_updates

kubernetesNodeUpdates

Enable periodic package updates on node

kubernetesNodeGroupState

string · enum

Enum values:

failed

pending

running

terminating

unknown

scaling-up

scaling-down

Node group operational state

kubernetesPlan

Plan to assign to a node group

description

kubernetesDescription · required

Plan description

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

kubernetesPlans

kubernetesPlan[]

List of plans

Plan to assign to a node group

kubernetesPlan

description

kubernetesDescription · required

Plan description

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

kubernetesNodeGroupPlan

string

Node group plan

kubernetesNodeGroupCloudNativePlan

Node group cloud native plan properties

storage_size

kubernetesStorageSize · int32 · min: 25 · max: 1024 · required

The size of the storage device in gigabytes.

storage_tier

kubernetesStorageTier · enum

The storage tier to use.

Enum values:

maxiops

hdd

standard

Default: maxiops

kubernetesNodeGroupGPUPlan

Node group GPU plan properties

storage_size

kubernetesStorageSize · int32 · min: 25 · max: 1024 · required

The size of the storage device in gigabytes.

storage_tier

kubernetesStorageTier · enum

The storage tier to use.

Enum values:

maxiops

hdd

standard

Default: maxiops

kubernetesNodeGroupCustomPlan

Node group custom plan properties

memory

integer · int32 · min: 1024 · max: 131072 · required

The amount of memory in megabytes to assign to individual node group node when using custom plan

cores

integer · int32 · min: 1 · max: 20 · required

The number of CPU cores dedicated to individual node group nodes when using custom plan

storage_size

kubernetesStorageSize · int32 · min: 25 · max: 1024 · required

The size of the storage device in gigabytes.

storage_tier

kubernetesStorageTier · enum

The storage tier to use.

Enum values:

maxiops

hdd

standard

Default: maxiops

kubernetesStorageSize

integer · int32 · min: 25 · max: 1024

The size of the storage device in gigabytes.

kubernetesStorageTier

string · enum

Enum values:

maxiops

hdd

standard

The storage tier to use.

Default: maxiops

kubernetesStorageEncryption

string · enum

Enum values:

data-at-rest

none

The storage encryption strategy.

kubernetesDefaultStorageEncryption

string · enum

Enum values:

data-at-rest

none

The storage encryption strategy.

kubernetesSshKey

string · pattern: ^ssh-[0-9A-Za-z]+ AA…

Public SSH key for accessing the nodes in a group

kubernetesSshKeys

kubernetesSshKey[] · unique

List of public SSH keys

kubernetesStorage

string · uuid

Storage UUID to use as a template

kubernetesTaint

Kubernetes taint to assign to nodes in a group

effect

kubernetesEffect · enum · required

Taint effect

Enum values:

NoExecute

NoSchedule

PreferNoSchedule

key

kubernetesKey · required

Key of a key-value pair

value

kubernetesValue · maxLength: 255 · required

Value of a key-value pair

kubernetesTaints

List of taints

Kubernetes taint to assign to nodes in a group

kubernetesTaint

effect

kubernetesEffect · enum · required

Taint effect

Enum values:

NoExecute

NoSchedule

PreferNoSchedule

key

kubernetesKey · required

Key of a key-value pair

value

kubernetesValue · maxLength: 255 · required

Value of a key-value pair

kubernetesUuid

string · uuid

UUID

kubernetesValue

string · maxLength: 255

Value of a key-value pair

kubernetesZone

string · minLength: 1

UpCloud zone to provision the Kubernetes cluster in

kubernetesClusterVersion

string

Kubernetes version identifier

Default: 1.26

kubernetesClusterUpgradeStrategy

upgrade strategy for node group upgrades

type

kubernetesClusterUpgradeStrategyType · enum · required

upgrade strategy type

Enum values:

rolling-update

manual

Default: manual

kubernetesClusterUpgradeStrategyType

string · enum

Enum values:

rolling-update

manual

upgrade strategy type

Default: manual

kubernetesClusterPlan

string · enum

Enum values:

development

production-small

dev-md

prod-md

prod-md-ha

Cluster plan

Default: development

kubernetesAntiAffinity

boolean

Enable anti-affinity policies

Default: false

kubernetesPrivateNodeGroups

boolean

Enable private node groups

Default: false

kubernetesNodeGroupDetails

Kubernetes cluster node

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

count

kubernetesCount · int32 · min: 0 · max: 16 · required

Amount of nodes in a node group

plan

kubernetesNodeGroupPlan · required

Node group plan

kubernetesNode[] · required

List of node group nodes (experimental)

kubernetesNodeGroupCustomPlan

List of Kubelet arguments

kubernetesLabel[] · unique

List of labels

Node group custom plan properties

kubernetesNodeGroupCloudNativePlan

Node group cloud native plan properties

kubernetesNodeGroupGPUPlan

Node group GPU plan properties

ssh_keys

kubernetesSshKey[] · unique

List of public SSH keys

state

kubernetesNodeGroupState · enum

Node group operational state

Enum values:

failed

pending

running

terminating

unknown

scaling-up

scaling-down

storage

kubernetesStorage · uuid

Storage UUID to use as a template

storage_encryption

kubernetesStorageEncryption · enum

The storage encryption strategy.

Enum values:

data-at-rest

none

kubernetesUtilityNetworkAccess

List of taints

anti_affinity

kubernetesAntiAffinity

Enable anti-affinity policies

Default: false

utility_network_access

Enable utility network access

Default: true

node_updates

kubernetesNodeUpdates

Enable periodic package updates on node

kubernetesNode

Kubernetes cluster node

uuid

string · uuid · required

Node UUID

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

kubelet_version

kubernetesClusterVersion · required

Kubernetes version identifier

Default: 1.26

state

kubernetesNodeState · enum · required

Node operational state

Enum values:

pending

failed

running

terminating

unknown

kubernetesUtilityNetworkAccess

boolean

Enable utility network access

Default: true

kubernetesNodeUpdates

Enable periodic package updates on node

kubernetes_patches

boolean · required

Include Kubernetes package patch updates (kubeadm, kubectl, kubelet)

Default: false

schedule_dow

string · enum · required

The day of the week on which updates will be performed

Enum values:

Monday

Tuesday

Wednesday

Thursday

Friday

Saturday

Sunday

daily

schedule_time

string · required

The time at which the updates will be applied in UTC (HH:MM).

currencyCode

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

ISO 4217 code

currencyCurrencies

object · required

currencyError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

devices

Zone device availability

object

deviceError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

events

Server event type

object

eventsUuid

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

Universally unique identifier

eventsEventType

string · enum

Enum values:

server_create

server_error

server_modify

server_shutdown

server_start

server_start_init

server_stop

Server event type

eventsError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

ipAddress

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = string
	type = string

Properties for Variant 1:

string · pattern: ^([0-9]{1,3}\.){3}[0…

IPv4 address

modifyIpAddressRequestV1.0

Request schema for modifying an IP address

object · required

ipAddressesResponse

Request schema for IP address operations

object · required

ipAddressDetails

Details of an IP address

access

ipAddressNetworkType · enum · required

Network access type

Enum values:

public

utility

private

ipAddress · required

IP address

account_id

ipAddressAccountId · min: 1

delegated_to_account_id

ipAddressDelegatedToAccountId

Attached to a resource that is delegated to another account. Null means not delegated.

family

ipAddressIpFamily · enum

IP address family

Enum values:

IPv4

IPv6

floating

ipAddressBooleanYesno · enum

Boolean value represented as yes/no

Enum values:

yes

mac

ipAddressMacAddress · pattern: ^([0-9A-Fa-f]{2}:){5…

MAC address

part_of_plan

ipAddressBooleanYesno · enum

Boolean value represented as yes/no

Enum values:

yes

ptr_record

string

release_policy

ipAddressIpReleasePolicy · enum

IP Release policy defines what happens to the address when the referencing resource is deleted

Enum values:

release

keep

server

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

Universally unique identifier

zone

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

Zone identifier

Example: fi-hel1

ipAddressResponse

Request schema for IP address operations

ipAddressDetails · required

Details of an IP address

ipAddressRequest

Request schema for IP address operations

ipAddressDetails[] · required

List of IP addresses to operate on

ipAddressBooleanYesno

string · enum

Enum values:

yes

Boolean value represented as yes/no

ipAddressNetworkType

string · enum

Enum values:

public

utility

private

Network access type

ipAddressAccountId

integer · min: 1

ipAddressDelegatedToAccountId

integer | null

Attached to a resource that is delegated to another account. Null means not delegated.

ipAddressIpFamily

string · enum

Enum values:

IPv4

IPv6

IP address family

ipAddressMacAddress

string · pattern: ^([0-9A-Fa-f]{2}:){5…

MAC address

ipAddressIpReleasePolicy

string · enum

Enum values:

release

keep

IP Release policy defines what happens to the address when the referencing resource is deleted

ipAddressUuid

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

Universally unique identifier

ipAddressZone

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

Zone identifier

Example: fi-hel1

ipAddressError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

networkPeeringCreate

Describes the mutable properties when creating a network-peering between two networks

name

string · required

object · required

Describes the local side of the peering

object · required

Describes the peer side of the peering

configured_status

string · enum

Enum values:

active

disabled

Default: active

networkPeeringModify

Describes the mutable properties when modifying a network-peering

configured_status

enum

Enum values:

active

disabled

name

string

networkPeerings

Network peerings

object · required

networkPeering

Network peering object describes a peering relationship between two networks

configured_status

string · enum

Enum values:

active

disabled

name

networkPeeringName · minLength: 1 · maxLength: 255

object

Describes the local side of the peering

object

Describes the peer side of the peering

state

networkPeeringState · enum

Enum values:

active

pending-peer

provisioning

conflict-subnet

missing-local-router

missing-peer-router

deleted-peer-network

disabled

uuid

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

Universally unique identifier

networkPeeringName

string · minLength: 1 · maxLength: 255

networkPeeringState

string · enum

Enum values:

active

pending-peer

provisioning

conflict-subnet

missing-local-router

missing-peer-router

deleted-peer-network

disabled

networkPeeringUuid

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

Universally unique identifier

networkPeeringIpCidr

string · cidr

IP CIDR

networkPeeringIpFamily

string · enum

Enum values:

IPv4

IPv6

IP address family

networkPeeringError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

createNetworkRequest

Request schema for creating a network

object · required

networkType

string · enum

Enum values:

public

utility

private

Network access type

modifyNetworkRequest

Request schema for modifying a network

object · required

networkFeatures

string · enum

Enum values:

allow-linklocal-address

allow-overlapping-ip-network

managed-by-service

allow-cgnat-address

Features available for a network

networks

object · required

required

additionalProperties

networkDetails

name

string · required

zone

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

Zone identifier

Example: fi-hel1

grt_export

networkBooleanYesno · enum

Boolean value represented as yes/no

Enum values:

yes

object

network_features

string[]

parent_network

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

Universally unique identifier

object

List of network peerings the network is part of

router

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

Universally unique identifier

object

List of services this network is joined to

tags

string[]

type

networkType · enum

Network access type

Enum values:

public

utility

private

uuid

string · uuid

network

networkDetails · required

resourceNetworkUsageType

string · enum

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

Network usage type for resource

networkLabel

A key/value pair to label and categorize resources

key

string · required

value

string · required

networkAccountId

integer · min: 1

networkEndpointTypeParameter

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = array
	type = string

Properties for Variant 1:

networkEndpointType[]

Enum values:

server_interface

floating_ip

networkEndpointType

string · enum

Enum values:

server_interface

floating_ip

networkInterfaceType

string · enum

Enum values:

public

private

private_vlan

networkUuid

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

Universally unique identifier

networkZone

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

Zone identifier

Example: fi-hel1

networkRfc3339Datetime

string · date-time

Datetime in RFC 3339 format

networkUsageAccumulateParameter

string · enum

Enum values:

hour

day

Usage accumulator hour or day parameter

networkFtpResourceType

string · enum

Enum values:

server_public

object_storage_public

load_balancer_public

network_gateway_public

object_storage_v2_public

FTP Resource Type

networkServiceNameParameter

string

Service name

networkIpFamily

string · enum

Enum values:

IPv4

IPv6

IP address family

networkIpCidr

string · cidr

IP CIDR

networkIpAddress

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = string
	type = string

Properties for Variant 1:

string · pattern: ^([0-9]{1,3}\.){3}[0…

IPv4 address

networkBooleanYesno

string · enum

Enum values:

yes

Boolean value represented as yes/no

networkBootfileUrl

string · url

networkLabels

networkLabel[]

networkCreateInterfaceRequest

Request schema for creating a network interface

main_account_id

networkAccountId · min: 1

object

networkTags

object · required

networkDescription

string

Example: Development servers

networkName

string · minLength: 1 · maxLength: 32 · pattern: ^[A-Za-z0-9_]{1,32}$

Example: DEV

networkServers

List of servers associated with the tag.

server

string[]

networkBoolean01

integer · enum

Enum values:

networkError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

networkEndpoints

Response schema for listing network endpoints

endpoints

type

networkEndpoint

Endpoint schema

object

networkInterfaces

Response schema for listing network interfaces

interfaces

required

type

required

networkInterface

Response schema for listing network interfaces

bootable

networkBooleanYesno · enum · required

Boolean value represented as yes/no

Enum values:

yes

object[] · required

mac

string · required

network

string · required

source_ip_filtering

networkBooleanYesno · enum · required

Boolean value represented as yes/no

Enum values:

yes

type

networkType · enum · required

Network access type

Enum values:

public

utility

private

uuid

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

Universally unique identifier

server

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

Universally unique identifier

networkUsageFtp

array

Network usage for FTP service

resource_uuid

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

Universally unique identifier

zone

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

Zone identifier

Example: fi-hel1

start_at

networkRfc3339Datetime · date-time

Datetime in RFC 3339 format

end_at

networkRfc3339Datetime · date-time

Datetime in RFC 3339 format

sent_bytes

integer

Sent bytes

total_sent_bytes

integer

Total sent bytes

received_bytes

integer

Received bytes

total_received_bytes

integer

Total received bytes

fair_transfer_policy_limit_sent_bytes

integer

Projected monthly quota in bytes

networkUsageResource

object[]

Network usage resource statistics

resource_uuid

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

Universally unique identifier

type

resourceNetworkUsageType · enum · required

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

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

Zone identifier

Example: fi-hel1

start_at

networkRfc3339Datetime · date-time · required

Datetime in RFC 3339 format

end_at

networkRfc3339Datetime · date-time · required

Datetime in RFC 3339 format

sent_bytes

integer · required

Total sent bytes during the period

received_bytes

integer · required

Total received bytes during the period

networkUsageTop

object[]

Network usage top statistics

resource_uuid

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

Universally unique identifier

type

resourceNetworkUsageType · enum · required

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

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

Zone identifier

Example: fi-hel1

start_at

networkRfc3339Datetime · date-time · required

Datetime in RFC 3339 format

end_at

networkRfc3339Datetime · date-time · required

Datetime in RFC 3339 format

sent_bytes

integer · required

Total sent bytes during the period

received_bytes

integer · required

Total received bytes during the period

partnerCreateAccount

username

string · required

password

string · required

object

partnerAccounts

partnerAccount[]

partnerAccount

username

string · required

address

string

city

string

company

string

country

string · iso-3166-1-alpha-3

email

string · email

first_name

string

last_name

string

phone

string

postal_code

string

state

string

vat_number

string

partnerAccount

username

string · required

address

string

city

string

company

string

country

string · iso-3166-1-alpha-3

email

string · email

first_name

string

last_name

string

phone

string

postal_code

string

state

string

vat_number

string

partnerError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

partnerError400

400 Bad Request errors for partner account creation.

required

partnerError400AddressInvalid

The attribute address has an invalid value.

error_code

string · const · required

Const value: ADDRESS_INVALID

error_message

string · required

partnerError400CityInvalid

The attribute city has an invalid value.

error_code

string · const · required

Const value: CITY_INVALID

error_message

string · required

partnerError400CompanyInvalid

The attribute company has an invalid value.

error_code

string · const · required

Const value: COMPANY_INVALID

error_message

string · required

partnerError400CountryInvalid

The attribute country has an invalid value.

error_code

string · const · required

Const value: COUNTRY_INVALID

error_message

string · required

partnerError400CountryMissing

The attribute country is missing from the request.

error_code

string · const · required

Const value: COUNTRY_MISSING

error_message

string · required

partnerError400EmailInvalid

The attribute email has an invalid value.

error_code

string · const · required

Const value: EMAIL_INVALID

error_message

string · required

partnerError400EmailMissing

The attribute email is missing from the request.

error_code

string · const · required

Const value: EMAIL_MISSING

error_message

string · required

partnerError400FirstNameInvalid

The attribute first_name has an invalid value.

error_code

string · const · required

Const value: FIRST_NAME_INVALID

error_message

string · required

partnerError400FirstNameMissing

The attribute first_name is missing from the request.

error_code

string · const · required

Const value: FIRST_NAME_MISSING

error_message

string · required

partnerError400LastNameInvalid

The attribute last_name has an invalid value.

error_code

string · const · required

Const value: LAST_NAME_INVALID

error_message

string · required

partnerError400LastNameMissing

The attribute last_name is missing from the request.

error_code

string · const · required

Const value: LAST_NAME_MISSING

error_message

string · required

partnerError400PasswordInvalid

The attribute password has an invalid value.

error_code

string · const · required

Const value: PASSWORD_INVALID

error_message

string · required

partnerError400PasswordMissing

The attribute password is missing from the request.

error_code

string · const · required

Const value: PASSWORD_MISSING

error_message

string · required

partnerError400PhoneInvalid

The attribute phone has an invalid value.

error_code

string · const · required

Const value: PHONE_INVALID

error_message

string · required

partnerError400PhoneMissing

The attribute phone is missing from the request.

error_code

string · const · required

Const value: PHONE_MISSING

error_message

string · required

partnerError400PostalCodeInvalid

The attribute postal_code has an invalid value.

error_code

string · const · required

Const value: POSTAL_CODE_INVALID

error_message

string · required

partnerError400PostalCodeMissing

The attribute postal_code is missing from the request.

error_code

string · const · required

Const value: POSTAL_CODE_MISSING

error_message

string · required

partnerError403

403 Forbidden errors for partner account creation.

object · required

partnerError409

409 Conflict errors for partner account creation.

object · required

permission

A single permission object.

permissionDocument

Permission document defining access rights for a sub-account to a specific resource.

permissionDocument

Permission document defining access rights for a sub-account to a specific resource.

target_identifier

permissionTargetIdentifier · required

Target identifying string. This is type specific and in most cases is an UUID4. Wildcard value "*" can be used to reference all target resources.

target_type

permissionTargetType · enum · required

Type of the target to grant permission to

Enum values:

server

storage

network

router

object_storage

managed_database

managed_object_storage

managed_loadbalancer

user

permissionUserName · minLength: 4 · maxLength: 64 · required

Username for an account.

options

object

Target specific options.

permissionTargetIdentifier

string

Target identifying string. This is type specific and in most cases is an UUID4. Wildcard value "*" can be used to reference all target resources.

permissionTargetType

permissions

List of permissions.

object · required

permissionUserName

string · minLength: 4 · maxLength: 64

Username for an account.

permissionError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

plan

object · required

planName

string · minLength: 1 · maxLength: 255

Server plan identifier

Example: 1xCPU-1GB

planFamily

string · enum

Enum values:

general_purpose

developer

cloud_native

gpu

starter

premium

The plan family identifier. Plan families group plans by their intended use case.

Example: general_purpose

planCoreNumber

integer

The number of CPU cores included in the plan, represented as a positive integer. This value must be greater than zero.

planMemoryAmount

integer

The amount of memory included in the plan, measured in mebibytes (MiB).

planPublicTrafficOut

integer · min: 0

The amount of public traffic out included in the plan, measured in gigabytes (GB).

planStorageSize

integer

The storage size for the plan in gibibytes (GiB). Is 0 if the plan does not include storage.

planStorageTier

string | null

The storage tier for the plan. Is null if the plan does not include storage.

Example: standard

planGpuAmount

integer

The number of GPUs included in the plan.

planGpuModel

string

The GPU model included in the plan.

Example: NVIDIA L40S

planBooleanYesno

string · enum

Enum values:

yes

Boolean value represented as yes/no

planError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

prices

Price list for UpCloud resources and services.

object · required

zonePrices

Pricing information organized by zone.

object

priceCurrency

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

ISO 4217 code

priceError400

Invalid price request error.

object · required

priceError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

routerDetails

Router describes a virtual router that can route between SDN networks

name

string · required

object

Networks attached to the router.

routerLabels

routerRouteNexthop[]

Static routes that will be added to the routing table of the SDN router

type

routerType · enum

Type of the router.

Enum values:

normal

service

uuid

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

Universally unique identifier

routerType

string · enum

Enum values:

normal

service

Type of the router.

routers

A list of routers

object · required

router

Schema for a single router

routerDetails · required

Router describes a virtual router that can route between SDN networks

routerLabel

A key/value pair to label and categorize resources

key

string · required

value

string · required

routerUuid

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

Universally unique identifier

routerRouteTarget

string · pattern: ^[0-9]+:[0-9]+$

Note that the first part has a maximum value of 65535 while the second has 4294967295

routerIpCidr

string · cidr

IP CIDR

routerLabels

routerLabel[]

routerRouteNexthop

Static route with nexthop information.

name

string · pattern: ^[a-zA-Z0-9_-]+$

routerIpAddress

IP address

route

routerIpCidr · cidr

IP CIDR

routerIpAddress

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = string
	type = string

Properties for Variant 1:

string · pattern: ^([0-9]{1,3}\.){3}[0…

IPv4 address

routerError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

serverGroupModify

A schema for creating/modifying a server group

object · required

serverGroups

List of server groups

object · required

serverGroupDetails

Details of a server group

anti_affinity

serverGroupAntiAffinity · enum · required

Anti-affinity policy for server groups. Possible values are 'strict', 'yes', or 'no'. 'strict' ensures that no two servers in the group are placed on the same physical host. 'yes' indicates a preference for anti-affinity but does not guarantee it. 'no' means there is no anti-affinity requirement.

Enum values:

strict

yes

Default: no

serverGroupAntiAffinityStatus[] · required

object · required

List of labels associated with the server group.

object · required

List of servers associated with the server group.

title

string · required

uuid

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

Universally unique identifier

serverGroup

A single server group

serverGroupDetails · required

Details of a server group

serverGroupLabel

A key/value pair to label and categorize resources

key

string · required

value

string · required

serverGroupUuid

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

Universally unique identifier

serverGroupServers

List of server UUIDs in the server group

servers

serverGroupUuid[] · required

serverGroupAntiAffinity

string · enum

Enum values:

strict

yes

Default: no

serverGroupServerAdd

Schema for adding a server to a server group

object · required

serverGroupAntiAffinityStatus

Status of anti-affinity policy

uuid

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

Universally unique identifier

status

string · enum · required

Indicates whether the anti-affinity policy is currently being met ('met') or not ('unmet')

Enum values:

met

unmet

serverGroupError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

server

Server object returned in responses

serverDetails · required

Detailed information about a server

serverDetails

Detailed information about a server

created

serverCreated · int64 · min: 0 · required

Creation timestamp (Unix epoch time)

core_number

serverCoreNumber · int32 · required

Number of CPU cores

hostname

string · required

license

integer · int64 · required

License type

memory_amount

serverMemoryAmount · int32 · required

Amount of memory in MB

state

serverState · enum · required

Current state of the server

Enum values:

started

stopped

maintenance

error

pending_delete

title

string · required

uuid

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

Universally unique identifier

zone

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

Zone identifier

Example: fi-hel1

boot_order

serverBootOrder

Boot device order (comma-separated list)

firewall

serverBooleanOnoff · enum

Boolean value represented as on/off

Enum values:

off

host

serverEncodedHostId · int64 · min: 1

Encoded host id

object

nic_model

serverNicModel · enum

Network interface card model

Enum values:

virtio

e1000

rtl8139

os_type

serverOsType · enum

Operating system type

Enum values:

centos

debian

fedora

ubuntu

coreos

windows2003

windows2008

windows2012

password

string · password

Only present on server create

plan

serverPlanName · minLength: 1 · maxLength: 255

Server plan identifier

Example: 1xCPU-1GB

plan_ipv4_bytes

integer · int64

Plan IPv4 traffic limit in bytes

plan_ipv6_bytes

integer · int64

Plan IPv6 traffic limit in bytes

progress

string

TODO

simple_backup

serverSimpleBackup

HHMM, with dailies, weeklies, or monthlies option separated by comma, or no

serverTags

tags can be an empty array or an object with a tag array

timezone

string

TODO

username

serverUserName · minLength: 4 · maxLength: 64

Username for an account.

server_group

serverServerGroup · pattern: ^[0-9a-fA-F]{8}-[0-9…

UUID string or null

serverState

string · enum

Enum values:

started

stopped

maintenance

error

pending_delete

Current state of the server

serverTags

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = array
	type = object · requires: tag

Properties for Variant 1:

array

No data returned

serverServerGroup

string | null · pattern: ^[0-9a-fA-F]{8}-[0-9…

UUID string or null

createServer

Server creation parameters

object · required

createServerResponse

Response schema for creating a server

object · required

serverCreated

integer · int64 · min: 0

Creation timestamp (Unix epoch time)

serverBootOrder

string

Boot device order (comma-separated list)

serverCoreNumber

integer · int32

Number of CPU cores

serverBooleanOnoff

string · enum

Enum values:

off

Boolean value represented as on/off

serverEncodedHostId

integer · int64 · min: 1

Encoded host id

serverLabel

A key/value pair to label and categorize resources

key

string · required

value

string · required

serverMemoryAmount

integer · int32

Amount of memory in MB

serverNicModel

string · enum

Enum values:

virtio

e1000

rtl8139

Network interface card model

serverOsType

string · enum

Enum values:

centos

debian

fedora

ubuntu

coreos

windows2003

windows2008

windows2012

Operating system type

serverPlanName

string · minLength: 1 · maxLength: 255

Server plan identifier

Example: 1xCPU-1GB

serverSimpleBackup

string | null

HHMM, with dailies, weeklies, or monthlies option separated by comma, or no

serverUserName

string · minLength: 4 · maxLength: 64

Username for an account.

serverUuid

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

Universally unique identifier

serverZone

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

Zone identifier

Example: fi-hel1

serverCloneSource

string

UUID of server or storage to clone from

serverHostname

string

Server hostname

serverIpAddresses

IP addresses assigned to the server

object[] · required

serverNetworkType

string · enum

Enum values:

public

utility

private

Network access type

serverIpFamily

string · enum

Enum values:

IPv4

IPv6

IP address family

serverLabels

Server labels

serverLabel[]

serverLoginUser

create_password

serverBooleanYesno · enum

Boolean value represented as yes/no

Enum values:

yes

object

username

string

serverBooleanYesno

string · enum

Enum values:

yes

Boolean value represented as yes/no

serverNetworking

Network configuration for the server

object

serverInterface

Network interface

network

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

Universally unique identifier

bootable

serverBooleanYesno · enum

Boolean value represented as yes/no

Enum values:

yes

index

integer · int32 · min: 0 · max: 255

object

mac

serverMacAddress · pattern: ^([0-9A-Fa-f]{2}:){5…

MAC address

source_ip_filtering

serverBooleanYesno · enum

Boolean value represented as yes/no

Enum values:

yes

type

serverNetworkType · enum

Network access type

Enum values:

public

utility

private

serverInterfaceIpAddress

Network interface IP address

serverIpAddress · required

IP address

family

serverIpFamily · enum · required

IP address family

Enum values:

IPv4

IPv6

floating

serverBooleanYesno · enum · required

Boolean value represented as yes/no

Enum values:

yes

dhcp_provided

serverBooleanYesno · enum

Boolean value represented as yes/no

Enum values:

yes

release_policy

serverIpReleasePolicy · enum

IP Release policy defines what happens to the address when the referencing resource is deleted

Enum values:

release

keep

serverIpAddress

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = string
	type = string

Properties for Variant 1:

string · pattern: ^([0-9]{1,3}\.){3}[0…

IPv4 address

serverIpReleasePolicy

string · enum

Enum values:

release

keep

IP Release policy defines what happens to the address when the referencing resource is deleted

serverMacAddress

string · pattern: ^([0-9A-Fa-f]{2}:){5…

MAC address

serverPasswordDelivery

string

Password delivery method

serverPlan

string

Server plan name

serverStorageDevices

Storage devices attached to the server

object[]

serverStorageSizeFactor

string

Storage size multiplication factor

serverTimezone

string

Server timezone

serverTitle

string

Server title

serverUserData

string

User data (cloud-init script) to run on server creation

serverVideoModel

string

Video adapter model

serverVnc

string

VNC enabled status (yes/no)

serverVncKeymap

string

VNC keyboard layout

serverVncPassword

string · password

VNC password

serverError400

Bad request error

object · required

serverError403

Forbidden error

object · required

serverError409

Conflict error

object · required

serverError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

serverAccess

string · enum

Enum values:

public

private

utility

Network access level

serverError404

object · required

serverSizes

List of server sizes

object · required

serverSizeLimits

Schema for server size limits

object · required

serverSizeError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

createStorageRequest

Request schema for creating a storage

object · required

modifyStorageBody

addStorageComponentRequest

Schema for adding a storage component to a storage device

object · required

attachStorage

Schema for attaching a storage device to a server

object · required

createStorageBackupRequest

interval

string · required

retention

string · required

time

string · required

cloneStorageRequest

TODO

object · required

changeStorageStateRequest

Schema for changing the state of a storage device

object · required

createStorageTemplateRequest

Request schema for creating a storage template

object · required

storages

object · required

storageDetails

access

storageAccess · enum · required

Network access level

Enum values:

public

private

utility

encrypted

storageEncrypted · enum · required

Enum values:

yes

Example: yes

license

number · double · required

size

integer · min: 1 · required

state

storageState · enum · required

Enum values:

online

maintenance

error

pending_delete

hidden

cloning

backuping

attaching

title

string · required

type

storageType · enum · required

Storage type filter

Enum values:

normal

template

cdrom

backup

uuid

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

Universally unique identifier

storageLabel[]

object

Only available with "metadata" in Options

part_of_plan

string · enum

Enum values:

yes

tier

storageTier

zone

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

Zone identifier

Example: fi-hel1

storageState

string · enum

Enum values:

online

maintenance

error

pending_delete

hidden

cloning

backuping

attaching

storageTier

string

storageType

string · enum

Enum values:

normal

template

cdrom

backup

Storage type filter

createStorageResponse

Created storage

storageDetails · required

storage

storageDetails · required

modifyStorageResponse

resizeStorageResponse

storageAccessFilter

string · enum

Enum values:

public

private

Storage access level filter

storageLabelFilter

string · pattern: ^!?[^=]+=.*$

Label filter in format key=value or !key=value for negation

Example: environment=production

storageSortBy

string · enum

Enum values:

created

size

title

type

Field to sort storage results by

storageOrderBy

string · enum

Enum values:

asc

desc

Sort order for storage results

storageLimit

integer · min: 1 · max: 1000

Maximum number of items to return. Default is 25.

Example: 25

storageOffset

integer · min: 0

Number of items to skip before starting to return results. Default is 0.

Example: 0

storageAllowHidden

string · enum

Enum values:

yes

Whether to include hidden storages in the response

Example: yes

storageFavorite

string · enum

Enum values:

yes

Filter storages by favorite status

Example: yes

storageMetadata

string · enum

Enum values:

yes

Whether to include metadata in the response

Example: yes

storageServers

string · enum

Enum values:

yes

Whether to include server information in the response

Example: yes

storageUuid

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

Universally unique identifier

storageZone

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

Zone identifier

Example: fi-hel1

storageCreateCdromRequest

Schema for creating a new CD-ROM image

object · required

storageLoginCleanupRequest

Schema for cleaning up login session on a storage device

object · required

storageComponents

string

storageTitle

string

storageUpdateTemplateRequest

Request schema for updating a storage template

object · required

storageReplaceComponent

Schema for replacing a storage component in a storage device

object · required

storageAccess

string · enum

Enum values:

public

private

utility

Network access level

storageEncrypted

string · enum

Enum values:

yes

Example: yes

storageLabel

A key/value pair to label and categorize resources

key

string · required

value

string · required

storageError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

tag

object · required

tagName

string · minLength: 1 · maxLength: 32 · pattern: ^[A-Za-z0-9_]{1,32}$

Example: DEV

tagDescription

string

Example: Development servers

tagServers

List of servers associated with the tag.

server

string[]

tagError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

tagError400

400 Bad Request errors for tag operations.

object · required

tagError403

400 Forbidden errors for tag operations.

object · required

tagError409

409 Conflict errors for tag operations.

object · required

tagError404

404 Not Found errors for tag operations.

object · required

timezones

List of available timezones

object · required

timezoneError

A general error response indicating that the request could not be fulfilled due to a technical issue.

object · required

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

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.

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

accountTokensIpRange

string

IP range from where to accept the token

Example: 1.2.3.4

accountTokensToken

A token.

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

accountTokensUuidOfTheToken

string · uuid

UUID of the token

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

accountTokensProblem400

JSON Problem Details for HTTP APIs

type

string · const · uri · required

A URI reference that uniquely identifies the problem type only in the context of the provided API. It is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.

Const value: https://developers.upcloud.com/1.3/errors#ERROR_BAD_REQUEST

title

string · required

A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.

Example: Bad request.

status

integer · enum · int32 · required

The HTTP status code generated by the origin server for this occurrence of the problem.

Enum values:

400

detail

string

A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.

Example: Invalid parameters.

object[]

correlation_id

string

A unique identifier for the request. This identifier is generated by the server and can be used to track the request in the server logs. It is useful for debugging and support purposes.

Example: 01JQV2ETY2K6HHE1KZFY9E1CYC

accountTokensProblem401

JSON Problem Details for HTTP APIs

type

string · const · uri · required

Const value: https://developers.upcloud.com/1.3/errors#ERROR_UNAUTHORIZED

title

string · required

A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.

Example: Unauthorized.

status

integer · enum · int32 · required

The HTTP status code generated by the origin server for this occurrence of the problem.

Enum values:

401

detail

string

Example: Invalid parameters.

object[]

correlation_id

string

A unique identifier for the request. This identifier is generated by the server and can be used to track the request in the server logs. It is useful for debugging and support purposes.

Example: 01JQV2ETY2K6HHE1KZFY9E1CYC

accountTokensProblem403

JSON Problem Details for HTTP APIs

type

string · const · uri · required

Const value: https://developers.upcloud.com/1.3/errors#ERROR_FORBIDDEN

title

string · required

A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.

Example: Bad request.

status

integer · enum · int32 · required

The HTTP status code generated by the origin server for this occurrence of the problem.

Enum values:

403

detail

string

Example: Invalid parameters.

object[]

correlation_id

string

A unique identifier for the request. This identifier is generated by the server and can be used to track the request in the server logs. It is useful for debugging and support purposes.

Example: 01JQV2ETY2K6HHE1KZFY9E1CYC

accountTokensProblem409

JSON Problem Details for HTTP APIs

type

string · const · uri · required

Const value: https://developers.upcloud.com/1.3/errors#ERROR_SERVICE_UNAVAILABLE

title

string · required

A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.

Example: Service unavailable.

status

integer · enum · int32 · required

The HTTP status code generated by the origin server for this occurrence of the problem.

Enum values:

400

detail

string

Example: Invalid parameters.

object[]

correlation_id

string

A unique identifier for the request. This identifier is generated by the server and can be used to track the request in the server logs. It is useful for debugging and support purposes.

Example: 01JQV2ETY2K6HHE1KZFY9E1CYC

accountTokensProblem

JSON Problem Details for HTTP APIs

type

string · uri · required

Example: https://developers.upcloud.com/1.3/errors#INTERNAL_SERVER_ERROR

title

string · required

A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.

Example: Internal server error.

status

integer · int32 · min: 200 · max: 599 · required

The HTTP status code generated by the origin server for this occurrence of the problem.

detail

string

Example: Invalid parameters.

object[]

correlation_id

string

A unique identifier for the request. This identifier is generated by the server and can be used to track the request in the server logs. It is useful for debugging and support purposes.

Example: 01JQV2ETY2K6HHE1KZFY9E1CYC

accountTokensListTokensResponse

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

accountTokensGetTokenResponse

A token.

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

accountTokensProblem404

JSON Problem Details for HTTP APIs

type

string · const · uri · required

Const value: https://developers.upcloud.com/1.3/errors#ERROR_NOT_FOUND

title

string · required

A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.

Example: Not found.

status

integer · enum · int32 · required

The HTTP status code generated by the origin server for this occurrence of the problem.

Enum values:

404

detail

string

Example: Invalid parameters.

object[]

correlation_id

string

A unique identifier for the request. This identifier is generated by the server and can be used to track the request in the server logs. It is useful for debugging and support purposes.

Example: 01JQV2ETY2K6HHE1KZFY9E1CYC

objectStorage2QueryParamLimit

integer · min: 0 · max: 100

Schema for a query parameter specifying the maximum number of entries to return (limit).

Example: 10

Default: 10

objectStorage2QueryParamOffset

integer · min: 0

Schema for a query parameter specifying the offset for pagination.

Example: 0

Default: 0

objectStorage2QueryParamSort

string · enum

Enum values:

created_at

-created_at

service_name

-service_name

operational_state

-operational_state

region_name

-region_name

Schema for a query parameter specifying the sort field and direction. Prefix with '-' for descending order.

Example: -created_at

objectStorage2ServiceUUID

string · uuid

The unique identifier for the service.

Example: 01234567-89ab-cdef-0123-456789abcdef

objectStorage2QueryParamForce

boolean

Schema for a query parameter specifying whether to force an operation.

Example: true

Default: false

objectStorage2Name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

A resource name.

Example: my-object-storage

objectStorage2CustomDomainName

string · hostname

A valid hostname for the custom domain. Supports both apex domains (example.com) and subdomains (objects.example.com).

Example: example.com

objectStorage2QueryParamTimestamp

string · date-time

Schema for a query parameter specifying a timestamp.

Example: 2024-01-01T00:00:00Z

objectStorage2QueryParamInterval

string

Schema for a query parameter specifying the time interval.

Example: 1h

Default: 1h

objectStorage2LabelKey

string · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E…

The key of a label.

Example: environment

objectStorage2AccessKeyID

string

The public identifier for an access key.

Example: UCK1234567890ABCDEF

objectStorage2TagKey

string · minLength: 1 · maxLength: 128

The key of a tag.

Example: environment

objectStorage2PolicyVersionID

string

The version identifier of a policy (e.g., v1, v2).

Example: v1

objectStorage2ServiceCreate

Schema for creating a service, including name, region, status, networks, domains, labels, and properties.

name

string · minLength: 1 · maxLength: 64 · required

region

objectStorage2Name · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

A resource name.

Example: my-object-storage

configured_status

objectStorage2PropertyConfiguredStatus · enum · required

Schema for the configured status of a property.

Enum values:

started

stopped

Example: started

objectStorage2NetworkCreate[] · maxItems: 8

Networks to attach to the service. Private networks must reside in the same region as the object storage.

Example: [{"name":"example-public-network","type":"public","family":"IPv4"}]

objectStorage2CustomDomainCreate[] · maxItems: 5

Custom domains to attach to the service.

Example: []

objectStorage2LabelCreate[] · maxItems: 255

Labels for classifying the service.

Example: [{"key":"environment","value":"production"}]

objectStorage2PropertiesCreate

Schema for creating properties with an optional access control origin override.

Example: {"access_control_origin_override":"https://mycompany.com"}

termination_protection

boolean

Enables or disables termination protection for the service. When enabled, the service cannot be deleted or powered down unless this is disabled first.

Default: false

objectStorage2PropertyConfiguredStatus

string · enum

Enum values:

started

stopped

Schema for the configured status of a property.

Example: started

objectStorage2NetworkCreate

Schema for creating a network with optional private UUID, name, type, and family.

name

objectStorage2Name · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

A resource name.

Example: my-object-storage

type

objectStorage2NetworkType · enum · required

Enum for the network type, indicating whether the network is public or private.

Enum values:

public

private

Example: public

family

objectStorage2NetworkFamily · enum · required

Enum for the network family, indicating the type of IP address used.

Enum values:

IPv4

IPv6

Example: IPv4

uuid

string · uuid

Private network uuid. Omit for public networks.

objectStorage2NetworkType

string · enum

Enum values:

public

private

Enum for the network type, indicating whether the network is public or private.

Example: public

objectStorage2NetworkFamily

string · enum

Enum values:

IPv4

IPv6

Enum for the network family, indicating the type of IP address used.

Example: IPv4

objectStorage2CustomDomainCreate

Schema for creating a custom domain.

type

string · enum · required

Type of the custom domain. At the moment only public is accepted.

Enum values:

public

private

domain_name

string · hostname · minLength: 1 · maxLength: 254 · required

Custom domain to be added. Supports both apex domains (example.com) and subdomains (objects.example.com).

mode

string · enum

Purpose of the domain. 'api' for S3 API access (creates base URL), 'static-website' for static website hosting (no base URL). Cannot be changed after creation.

Enum values:

api

static-website

Default: api

objectStorage2LabelCreate

Schema for creating a label with a key-value pair.

key

objectStorage2LabelKey · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E… · required

The key of a label.

Example: environment

value

objectStorage2LabelValue · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p… · required

Schema for a label value property, allowing a string or null with specific character constraints.

Example: production

objectStorage2LabelValue

string | null · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p…

Schema for a label value property, allowing a string or null with specific character constraints.

Example: production

objectStorage2PropertiesCreate

Schema for creating properties with an optional access control origin override.

access_control_origin_override

string · maxLength: 255

objectStorage2ServiceReplace

Schema for replacing a service, including name, status, networks, domains, labels, and properties.

name

string · minLength: 1 · maxLength: 64 · required

The name of the service.

configured_status

objectStorage2PropertyConfiguredStatus · enum · required

Schema for the configured status of a property.

Enum values:

started

stopped

Example: started

termination_protection

boolean

Enables or disables termination protection for the service. When enabled, the service cannot be deleted or powered down unless this is disabled first.

Default: false

objectStorage2NetworkCreate[] · maxItems: 8

objectStorage2CustomDomainCreate[] · maxItems: 5

array | null

Static website configurations for this service. Array replaces all existing configurations.

objectStorage2LabelCreate[] · maxItems: 255

objectStorage2PropertiesCreate

Schema for creating properties with an optional access control origin override.

Example: {"access_control_origin_override":"https://mycompany.com"}

objectStorage2StaticWebsiteConfigCreate

Request body for creating a static website configuration. If domain is omitted, the primary static website domain is used.

bucket_name

string · minLength: 1 · maxLength: 254 · pattern: ^[a-zA-Z0-9.\-_]+$ · required

Name of the S3/ECS bucket containing the website content. Only alphanumerics, dots, hyphens, and underscores are allowed.

domain_name

string · minLength: 1 · maxLength: 255

Custom domain to use for static website hosting. Must be a custom domain attached to the service. If omitted, the primary static website domain is used.

bucket_prefix

string · maxLength: 1024 · pattern: ^[a-zA-Z0-9/.\-_]*$

Optional prefix/subfolder within the bucket. Only alphanumerics, slashes, dots, hyphens, and underscores are allowed.

Default:

index_document

string · minLength: 1 · maxLength: 255 · pattern: ^[a-zA-Z0-9/.\-_]+$

Default document for directories. Only alphanumerics, slashes, dots, hyphens, and underscores are allowed.

Default: index.html

spa_mode

boolean | null

Enable Single Page Application (SPA) mode. When enabled, all non-file routes serve the index document, allowing client-side routing to handle the URL. Essential for React, Vue, Next.js, and similar frameworks.

Default: false

enabled

boolean

Whether the static website configuration should be active. Defaults to true if not specified.

Default: true

objectStorage2StaticWebsiteErrorPage[] · maxItems: 25

Custom error page configurations for specific HTTP status codes or ranges

objectStorage2StaticWebsiteErrorPage

Custom error page configuration for specific HTTP status codes or ranges

error_document

string · minLength: 1 · maxLength: 255 · pattern: ^[^/].* · required

Path to the custom error page document relative to the bucket root (e.g., '404.html', 'errors/404.html'). Must not start with '/'.

status_code

integer · min: 400 · max: 599

Single HTTP status code to match (must be within 4xx or 5xx).

Example: 403

object

Inclusive HTTP status code range to match (for example 4xx or 5xx blocks).

Example: {"start":400,"end":499}

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: status_code
	type = object · requires: status_range

Properties for Variant 1:

status_code

integer · min: 400 · max: 599 · required

Single HTTP status code to match (must be within 4xx or 5xx).

Example: 403

object

Inclusive HTTP status code range to match (for example 4xx or 5xx blocks).

Example: {"start":400,"end":499}

error_document

string · minLength: 1 · maxLength: 255 · pattern: ^[^/].*

Path to the custom error page document relative to the bucket root (e.g., '404.html', 'errors/404.html'). Must not start with '/'.

objectStorage2ServiceModify

Schema for modifying a service, including name, status, networks, domains, labels, and properties.

name

string · minLength: 1 · maxLength: 64

configured_status

objectStorage2PropertyConfiguredStatus · enum

Schema for the configured status of a property.

Enum values:

started

stopped

Example: started

array | null · maxItems: 8

array | null · maxItems: 5

array | null

Static website configurations for this service. Array replaces all existing configurations.

array | null · maxItems: 255

objectStorage2PropertiesCreate

Schema for creating properties with an optional access control origin override.

Example: {"access_control_origin_override":"https://mycompany.com"}

termination_protection

boolean

Enables or disables termination protection for the service. When enabled, the service cannot be deleted or powered down unless this is disabled first.

objectStorage2CustomDomainModify

Schema for modifying a custom domain.

type

string · enum

Type of the custom domain.

Enum values:

public

private

domain_name

string · hostname · minLength: 1 · maxLength: 254

New modified custom domain. Supports both apex domains (example.com) and subdomains (objects.example.com).

objectStorage2BucketCreate

Schema for creating a new bucket.

name

string · minLength: 1 · maxLength: 254 · pattern: ^[a-zA-Z0-9.\-_]{1,2… · required

Must be unique within the service, and should contain only alphanumeric, .,- and _.

objectStorage2LabelModify

Schema for modifying a label with a key-value pair.

key

objectStorage2LabelKey · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E…

The key of a label.

Example: environment

value

objectStorage2LabelValue · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p…

Schema for a label value property, allowing a string or null with specific character constraints.

Example: production

objectStorage2StaticWebsiteConfigModify

Request body for updating a static website configuration

bucket_name

string · minLength: 1 · maxLength: 254 · pattern: ^[a-zA-Z0-9.\-_]+$

Name of the S3/ECS bucket containing the website content. Only alphanumerics, dots, hyphens, and underscores are allowed.

bucket_prefix

string · maxLength: 1024 · pattern: ^[a-zA-Z0-9/.\-_]*$

Optional prefix/subfolder within the bucket. Only alphanumerics, slashes, dots, hyphens, and underscores are allowed.

index_document

string · minLength: 1 · maxLength: 255 · pattern: ^[a-zA-Z0-9/.\-_]+$

Default document for directories. Only alphanumerics, slashes, dots, hyphens, and underscores are allowed.

spa_mode

boolean | null

enabled

boolean

Whether the static website configuration should be active

objectStorage2StaticWebsiteErrorPage[] · maxItems: 25

Custom error page configurations for specific HTTP status codes or ranges. Replaces the entire set when provided.

objectStorage2UserCreate

Schema for creating a new user.

username

string · minLength: 1 · maxLength: 64 · pattern: [\w+=,.@-]+ · required

The name of the user to create.

objectStorage2AccessKeyModify

Schema for modifying an access key.

status

string · enum

Indicates if the key is active or inactive.

Enum values:

Active

Inactive

objectStorage2PolicyAttachmentCreate

Schema for creating a policy attachment.

name

string · minLength: 1 · maxLength: 128 · pattern: ^[a-zA-Z0-9+=,.@_\- … · required

Name of the policy to attach.

objectStorage2InlinePolicyCreate

Schema for creating an inline policy.

name

string · minLength: 1 · maxLength: 128 · required

Name of the inline policy.

document

string · minLength: 1 · maxLength: 6144 · required

A valid policy document.

objectStorage2TagListRequest

object[]

Schema for a list of tags to apply to a resource.

Example: [{"key":"environment","value":"production"},{"key":"team","value":"backend"}]

key

string · required

value

string · required

objectStorage2PermissionsBoundaryCreate

Schema for creating a permissions boundary with a specified policy name.

policy_name

string · minLength: 1 · maxLength: 128 · required

Name of the policy to use as the permissions boundary.

objectStorage2PolicyVersionCreate

Schema for creating a new version of a policy.

document

string · minLength: 1 · maxLength: 6144 · required

A valid, URL-encoded policy document.

is_default

boolean · required

Set this version as the default.

Default: false

objectStorage2PolicySetDefaultVersion

Schema for setting a default version of a policy.

version_id

string · required

The policy version ID to set as default.

objectStorage2PolicyCreate

Schema for creating a policy with a name, description, and document.

name

string · minLength: 1 · maxLength: 128 · pattern: [\w+=,.@-]+ · required

Unique name of the policy.

document

string · minLength: 1 · maxLength: 6144 · required

A valid, URL-encoded policy document.

description

string · minLength: 1 · maxLength: 1000

The policy description.

objectStorage2GroupCreate

Schema for creating a new IAM group.

name

string · minLength: 1 · maxLength: 128 · pattern: [\w+=,.@-]+ · required

A valid string to represent the name of the IAM group.

objectStorage2RoleCreate

Schema for creating a new role.

name

string · minLength: 1 · maxLength: 64 · pattern: [\w+=,.@-]+ · required

assume_role_policy_document

string · minLength: 1 · maxLength: 131072 · required

The policy document that grants an entity permission to assume the role.

description

string · maxLength: 1000

Description of the role.

max_session_duration

integer · int32 · min: 3600 · max: 43200

Maximum session duration in seconds.

permissions_boundary

string · minLength: 1 · maxLength: 128

Policy name to set as the permissions boundary.

objectStorage2RoleTag[]

Tags to attach to the role (max 50).

objectStorage2RoleTag

Schema for tagging roles with key-value pairs.

key

objectStorage2TagKey · minLength: 1 · maxLength: 128 · required

The key of a tag.

Example: environment

value

objectStorage2TagValue · maxLength: 256

The value of a tag.

Example: production

objectStorage2TagValue

string · maxLength: 256

The value of a tag.

Example: production

objectStorage2RoleUpdate

Schema for updating an existing role.

description

string · maxLength: 1000

New description for the role.

max_session_duration

integer · int32 · min: 3600 · max: 43200

New maximum session duration in seconds.

objectStorage2AssumeRolePolicyRequest

Schema for the request to assume a role with a policy document.

document

string · required

The assume role policy document that grants an entity permission to assume the role.

objectStorage2ServiceListResponse

objectStorage2ServiceDetailResponse[]

Response schema for a list of services.

Example: [{"configured_status":"started","created_at":"2023-05-07T15:55:24.655776Z","custom_domains":[{"domain_name":"objects.example-company.com","type":"public"}],"endpoints":[{"domain_name":"7mf5k.upbucket.com","iam_url":"https://7mf5k.upbucket.com:4443/iam","sts_url":"https://7mf5k.upbucket.com:4443/sts","type":"public"},{"domain_name":"7mf5k-private.upbucket.com","iam_url":"https://7mf5k-private.upbucket.com:4443/iam","sts_url":"https://7mf5k-private.upbucket.com:4443/sts","type":"private"},{"domain_name":"static.7mf5k.upbucket.com","type":"static"}],"labels":[{"key":"example-key","value":"example-value"}],"name":"example-service","networks":[{"family":"IPv4","name":"example-public-network","type":"public"},{"family":"IPv4","name":"example-private-network","type":"private","uuid":"03aa7245-2ff9-49c8-9f0e-7ca0270d71a4"}],"operational_state":"running","region":"europe-1","state_messages":[],"static_website":[{"domain":"objects.example-company.com","custom_domain_id":1,"bucket_name":"website-prod","bucket_prefix":"public/","index_document":"index.html","status":"active","error_pages":[{"status_code":404,"error_document":"404.html"},{"status_range":{"start":500,"end":599},"error_document":"500.html"},{"status_range":{"start":500,"end":510},"error_document":"500.html"}],"created_at":"2023-05-07T16:10:30.123456Z","updated_at":"2023-05-07T16:10:30.123456Z"}],"updated_at":"2023-05-07T21:38:15.757405Z","usage":{"total_objects":310499,"total_size_bytes":32414921734},"uuid":"1200ecde-db95-4d1c-9133-6508f3232567"}]

Response schema for service details, including UUID, name, and endpoints.

objectStorage2ServiceDetailResponse

uuid

string

name

string

region

string

configured_status

string · enum

Enum values:

started

stopped

operational_state

string · enum

Enum values:

pending

setup-service

setup-network

setup-tls

setup-public-endpoint

setup-private-endpoint

setup-dns

cleanup-deleted-buckets

objectStorage2NetworkDetailResponse[]

object

objectStorage2LabelDetailResponse[]

objectStorage2UserDetailResponse[]

objectStorage2EndpointResponse[]

objectStorage2CustomDomainDetailResponse[]

objectStorage2StaticWebsiteConfig[]

Static website configurations for this service

object[]

termination_protection

boolean

created_at

string · date-time

updated_at

string · date-time

objectStorage2ServiceDetailResponse

Response schema for service details, including UUID, name, and endpoints.

uuid

string

name

string

region

string

configured_status

string · enum

Enum values:

started

stopped

operational_state

string · enum

Enum values:

pending

setup-service

setup-network

setup-tls

setup-public-endpoint

setup-private-endpoint

setup-dns

cleanup-deleted-buckets

objectStorage2NetworkDetailResponse[]

object

objectStorage2LabelDetailResponse[]

objectStorage2UserDetailResponse[]

objectStorage2EndpointResponse[]

objectStorage2CustomDomainDetailResponse[]

objectStorage2StaticWebsiteConfig[]

Static website configurations for this service

object[]

termination_protection

boolean

created_at

string · date-time

updated_at

string · date-time

objectStorage2NetworkDetailResponse

Schema for network details including family, name, type, and UUID.

family

string

name

string

type

string

uuid

string · uuid

objectStorage2LabelDetailResponse

Schema for label details including key-value pairs.

key

string

value

string

objectStorage2UserDetailResponse

Response schema for user details.

username

string

arn

string

created_at

string · date-time

objectStorage2AccessKeyDetailResponse[]

objectStorage2PermissionsBoundaryResponse

permissions_boundary

Schema representing a permissions boundary response.

Example: sample-policy

objectStorage2AccessKeyDetailResponse

Response schema for access key details.

access_key_id

string

created_at

string · date-time

last_used_at

string · date-time

secret_access_key

string

Only returned upon creation, empty otherwise.

Example: uCkS3cr3tK3y1234567890abcdefghijklmnopqrstuvwxyz

status

string · enum

Enum values:

Active

Inactive

Example: Active

objectStorage2PolicyAttachmentResponse

Schema representing a policy attachment response.

arn

string

name

string

objectStorage2TagResponse

Schema for a key-value pair tag.

key

string

value

string

objectStorage2PermissionsBoundaryResponse

string

Schema representing a permissions boundary response.

Example: sample-policy

objectStorage2EndpointResponse

Response schema for endpoint details.

domain_name

string

iam_url

string · uri

sts_url

string · uri

type

string · enum

The network access type of the endpoint

Enum values:

public

private

mode

string · enum

The operational mode of the endpoint: 'api' for S3/IAM/STS access, 'static-website' for static website hosting

Enum values:

api

static-website

objectStorage2CustomDomainDetailResponse

Response schema for custom domain details.

domain_name

string

Custom domain name. Supports both apex domains and subdomains.

type

string

Endpoint type for the custom domain.

mode

string · enum

Purpose of the domain. 'api' for S3 API access, 'static-website' for static website hosting.

Enum values:

api

static-website

objectStorage2StaticWebsiteConfig

Static website hosting configuration for a specific domain.

domain_name

string · minLength: 1 · maxLength: 255 · required

The domain this configuration applies to

bucket_name

string · maxLength: 254 · pattern: ^[a-zA-Z0-9.\-_]*$ · required

Name of the S3/ECS bucket containing the website content. Only alphanumerics, dots, hyphens, and underscores are allowed.

bucket_prefix

string · maxLength: 1024 · pattern: ^[a-zA-Z0-9/.\-_]*$ · required

Optional prefix/subfolder within the bucket. Only alphanumerics, slashes, dots, hyphens, and underscores are allowed.

Default:

index_document

string · minLength: 1 · maxLength: 255 · pattern: ^[a-zA-Z0-9/.\-_]+$ · required

Default document for directories. Only alphanumerics, slashes, dots, hyphens, and underscores are allowed.

Default: index.html

objectStorage2StaticWebsiteErrorPage[] · maxItems: 25 · required

Custom error page configurations for specific HTTP status codes or ranges

enabled

boolean · required

Whether the static website configuration is currently active

created_at

string · date-time · required

Timestamp when this configuration was created

updated_at

string · date-time · required

Timestamp when this configuration was last updated

spa_mode

boolean

Default: false

objectStorage2ErrorResponse

Schema for error responses from the API.

type

string · enum · required

Error code string.

Enum values:

https://developers.upcloud.com/1.3/errors#ERROR_INVALID_REQUEST

https://developers.upcloud.com/1.3/errors#ERROR_RESOURCE_NOT_FOUND

https://developers.upcloud.com/1.3/errors#ERROR_INSUFFICIENT_CREDITS

https://developers.upcloud.com/1.3/errors#ERROR_GENERAL_FAILURE

title

string · required

Short description of the error.

Example: Validation error.

correlation_id

string · required

Unique identifier for the request, useful for debugging.

Example: 01K1K2TKEASWRJ6VFP9ZV5P2H4

status

integer · int32 · required

HTTP status code associated with the error.

Example: 400

object[]

List of invalid parameters in the request.

objectStorage2NetworkListResponse

objectStorage2NetworkDetailResponse[]

Response schema for a list of network details.

Example: [{"family":"IPv4","name":"example-public-network","type":"public"},{"family":"IPv4","name":"example-private-network","type":"private","uuid":"03aa7245-2ff9-49c8-9f0e-7ca0270d71a4"}]

Schema for network details including family, name, type, and UUID.

objectStorage2NetworkDetailResponse

family

string

name

string

type

string

uuid

string · uuid

objectStorage2CustomDomainListResponse

objectStorage2CustomDomainDetailResponse[]

Response schema for listing custom domains.

Example: [{"domain_name":"example.com","type":"public","mode":"api"},{"domain_name":"objects.example.com","type":"public","mode":"api"},{"domain_name":"static.example.com","type":"public","mode":"static-website"}]

Response schema for custom domain details.

objectStorage2CustomDomainDetailResponse

domain_name

string

Custom domain name. Supports both apex domains and subdomains.

type

string

Endpoint type for the custom domain.

mode

string · enum

Purpose of the domain. 'api' for S3 API access, 'static-website' for static website hosting.

Enum values:

api

static-website

objectStorage2RegionListResponse

objectStorage2RegionDetailResponse[]

Response schema for listing regions.

Example: [{"name":"europe-1","primary_zone":"fi-hel1","zones":[{"name":"fi-hel1"},{"name":"de-fra1"}]}]

Response schema for detailed information about a specific region.

objectStorage2RegionDetailResponse

name

string

primary_zone

string

object[]

objectStorage2RegionDetailResponse

Response schema for detailed information about a specific region.

name

string

primary_zone

string

object[]

objectStorage2MetricsUsageResponse

Response schema for service usage metrics.

total_objects

integer · int32

total_size_bytes

integer · int64

objectStorage2BucketListResponse

objectStorage2BucketDetailResponse[]

Response schema for listing buckets.

Example: [{"name":"my-bucket-1","total_objects":1000,"total_size_bytes":1073741824}]

Response schema for bucket details.

objectStorage2BucketDetailResponse

name

string

total_objects

integer · int32

total_size_bytes

integer · int64

deleted

boolean

objectStorage2BucketDetailResponse

Response schema for bucket details.

name

string

total_objects

integer · int32

total_size_bytes

integer · int64

deleted

boolean

objectStorage2MetricsSeriesListResponse

object[]

Response schema for listing metrics series.

Example: [{"bytes_created":530000,"bytes_deleted":244000,"bytes_received":530000,"bytes_total":7502000,"bytes_transmitted":0,"end_at":"2023-10-31T12:00:00Z","objects_created":79,"objects_deleted":40,"objects_total":1237,"start_at":"2023-10-31T11:00:00Z"}]

bytes_created

integer · int64

bytes_deleted

integer · int64

bytes_received

integer · int64

bytes_total

integer · int64

bytes_transmitted

integer · int64

end_at

string · date-time

objects_created

integer · int32

objects_deleted

integer · int32

objects_total

integer · int32

start_at

string · date-time

objectStorage2LabelListResponse

objectStorage2LabelDetailResponse[]

Response schema for listing labels.

Example: [{"key":"foo","value":"bar"}]

Schema for label details including key-value pairs.

objectStorage2LabelDetailResponse

key

string

value

string

objectStorage2ServiceDomains

Service domains with their static website hosting status

object[] · required

List of all service domains (public, private, custom) with their static website hosting availability and configuration status

objectStorage2UserListResponse

objectStorage2UserDetailResponse[]

Response schema for listing users.

Example: [{"access_keys":[{"access_key_id":"AKIA63F41D01345BB477","created_at":"2023-05-07T20:52:19.705405Z","last_used_at":"2023-05-07T20:52:17Z","status":"Active"}],"arn":"urn:ecs:iam::123bbb5c6a4240409e07f7d89fe28891:user/example_user","created_at":"2023-05-07T15:55:24.655776Z","policies":[{"arn":"urn:ecs:iam:::policy/ECSS3FullAccess","name":"ECSS3FullAccess"},{"arn":"urn:ecs:iam:::policy/IAMFullAccess","name":"IAMFullAccess"}],"username":"example_user"}]

Response schema for user details.

objectStorage2UserDetailResponse

username

string

arn

string

created_at

string · date-time

objectStorage2AccessKeyDetailResponse[]

objectStorage2PermissionsBoundaryResponse

permissions_boundary

Schema representing a permissions boundary response.

Example: sample-policy

objectStorage2AccessKeyListResponse

objectStorage2AccessKeyDetailResponse[]

Response schema for listing access keys.

Example: [{"access_key_id":"UCK1234567890ABCDEF","status":"Active","created_at":"2024-01-15T10:30:00Z","last_used_at":"2024-01-20T14:22:15Z"}]

Response schema for access key details.

objectStorage2AccessKeyDetailResponse

access_key_id

string

created_at

string · date-time

last_used_at

string · date-time

secret_access_key

string

Only returned upon creation, empty otherwise.

Example: uCkS3cr3tK3y1234567890abcdefghijklmnopqrstuvwxyz

status

string · enum

Enum values:

Active

Inactive

Example: Active

objectStorage2CreateAccessKeyResponse

Response schema for creating an access key.

access_key_id

string

created_at

string · date-time

last_used_at

string · date-time

secret_access_key

string

This is only returned upon creation.

Example: uCkS3cr3tK3y1234567890abcdefghijklmnopqrstuvwxyz

status

string · enum

Enum values:

Active

Inactive

Example: Active

objectStorage2PolicyAttachmentListResponse

objectStorage2PolicyAttachmentResponse

Response schema for listing policy attachments.

Example: [{"arn":"arn:upcloud:iam::01234567-89ab-cdef-0123-456789abcdef:policy/ECSReadOnlyAccess","name":"ECSReadOnlyAccess"}]

Schema representing a policy attachment response.

arn

string

name

string

objectStorage2InlinePolicyResponse

Schema representing an inline policy response.

document

string

name

string

objectStorage2InlinePolicyListResponse

objectStorage2InlinePolicyResponse[]

Response schema for listing inline policies.

Example: [{"name":"ECSS3FullAccess","document":"{\"Version\":\"2012-10-17\",\"Statement\":[{\"Action\":\"sts:AssumeRole\",\"Effect\":\"Allow\",\"Resource\":\"*\"}]}"}]

Schema representing an inline policy response.

objectStorage2InlinePolicyResponse

document

string

name

string

objectStorage2TagListResponse

object[]

Response schema for listing tags associated with a resource.

Example: [{"key":"environment","value":"production"},{"key":"team","value":"backend"}]

key

string · minLength: 1 · maxLength: 128 · required

value

string · maxLength: 256

objectStorage2PolicyVersionListResponse

objectStorage2PolicyVersionResponse[]

Response schema for a list of policy versions.

Example: [{"create_date":"2024-03-25T12:47:40Z","document":"%7B%22Version%22%3A%222012-10-17%22%2C%22Statement%22%3A%5B%7B%22Action%22%3A%5B%22*%22%5D%2C%22Resource%22%3A%22*%22%2C%22Effect%22%3A%22Deny%22%7D%5D%7D","is_default":false,"version_id":"v4"},{"create_date":"2024-03-25T12:47:38Z","document":"%7B%22Version%22%3A%222012-10-17%22%2C%22Statement%22%3A%5B%7B%22Action%22%3A%5B%22*%22%5D%2C%22Resource%22%3A%22*%22%2C%22Effect%22%3A%22Deny%22%7D%5D%7D","is_default":false,"version_id":"v3"}]

Schema for a policy version response, including creation date, document content, default status, and version ID.

objectStorage2PolicyVersionResponse

create_date

string · date-time

document

string

is_default

boolean

version_id

string

objectStorage2PolicyVersionResponse

Schema for a policy version response, including creation date, document content, default status, and version ID.

create_date

string · date-time

document

string

is_default

boolean

version_id

string

objectStorage2PolicyDetailResponse

Schema for policy details including ARN, attachment count, creation date, default version ID, description, document, name, system status, and last updated date.

arn

string

attachment_count

integer · int32

created_at

string · date-time

default_version_id

string

description

string

document

string

name

string

system

boolean

updated_at

string · date-time

objectStorage2PolicyListResponse

objectStorage2PolicyDetailResponse[]

Response schema for listing policies.

Example: [{"arn":"urn:ecs:iam:::policy/ECSDenyAll","attachment_count":0,"created_at":"2024-02-05T11:06:17Z","default_version_id":"v1","description":"Deny all access.","name":"ECSDenyAll","system":true,"updated_at":"2024-02-05T11:06:17Z"},{"arn":"urn:ecs:iam:::policy/ECSS3FullAccess","attachment_count":1,"created_at":"2024-02-05T11:06:16Z","default_version_id":"v1","description":"Provides full access to all buckets.","name":"ECSS3FullAccess","system":true,"updated_at":"2024-02-05T11:06:16Z"},{"arn":"urn:ecs:iam:::policy/ECSS3ReadOnlyAccess","attachment_count":0,"created_at":"2024-02-05T11:06:16Z","default_version_id":"v1","description":"Provides read only access to all buckets.","name":"ECSS3ReadOnlyAccess","system":true,"updated_at":"2024-02-05T11:06:16Z"},{"arn":"urn:ecs:iam:::policy/IAMFullAccess","attachment_count":1,"created_at":"2024-02-05T11:06:16Z","default_version_id":"v1","description":"Provides full access to IAM.","name":"IAMFullAccess","system":true,"updated_at":"2024-02-05T11:06:16Z"},{"arn":"urn:ecs:iam:::policy/IAMReadOnlyAccess","attachment_count":0,"created_at":"2024-02-05T11:06:16Z","default_version_id":"v1","description":"Provides read only access to IAM.","name":"IAMReadOnlyAccess","system":true,"updated_at":"2024-02-05T11:06:16Z"}]

Schema for policy details including ARN, attachment count, creation date, default version ID, description, document, name, system status, and last updated date.

objectStorage2PolicyDetailResponse

arn

string

attachment_count

integer · int32

created_at

string · date-time

default_version_id

string

description

string

document

string

name

string

system

boolean

updated_at

string · date-time

objectStorage2GroupListResponse

objectStorage2GroupResponse[]

Response schema for listing groups.

Example: [{"arn":"urn:ecs:iam::1263b59181cc4841969358b08ed70026:group/test-group","created_at":"2024-04-15T16:28:45Z","name":"test-group"}]

Response schema for group details.

objectStorage2GroupResponse

arn

string

created_at

string · date-time

name

string

objectStorage2GroupResponse

Response schema for group details.

arn

string

created_at

string · date-time

name

string

objectStorage2RoleListResponse

objectStorage2RoleResponse[]

Response schema for listing roles.

Example: [{"arn":"urn:ecs:iam::12e8c7066c0445c284c1381f899bcee7:role/example","assume_role_policy_document":"{\"Version\":\"2012-10-17\",\"Statement\":[{\"Action\":\"sts:AssumeRole\",\"Principal\":{\"AWS\":[\"urn:ecs:iam::12442a2fbc06434889edb631be2d0968:user/user1\"]},\"Effect\":\"Allow\",\"Resource\":\"*\"}]}","created_at":"2024-09-19T12:43:24Z","description":"An example role","inline_policies":[{"name":"InlinePolicy"}],"max_session_duration":36000,"name":"example","permissions_boundary":"SamplePolicy","policies":[{"arn":"urn:ecs:iam::12e8c7066c0445c284c1381f899bcee7:policy/SamplePolicy","name":"SamplePolicy"}]}]

Response schema for detailed information about a specific role.

objectStorage2RoleResponse

arn

string

assume_role_policy_document

string

created_at

string · date-time

description

string

array

max_session_duration

integer · int32

name

string

permissions_boundary

string

objectStorage2RoleResponse

Response schema for detailed information about a specific role.

arn

string

assume_role_policy_document

string

created_at

string · date-time

description

string

array

max_session_duration

integer · int32

name

string

permissions_boundary

string

fileStorageServiceDetailResponse[]

objectStorage2AssumeRolePolicyResponse

Response schema for assuming a role with a policy document.

document

string

fileStorageQueryParameterLimit

integer · min: 0 · max: 100

Schema for the limit query parameter, used to specify the maximum number of items to return in a paginated response.

Default: 10

fileStorageQueryParamOffset

integer · min: 0

Query parameter to specify the offset for pagination in API responses, allowing clients to retrieve results starting from a specific point.

Default: 0

fileStorageQueryParamSort

string · enum

Enum values:

created_at

-created_at

Query parameter to specify the sorting order of results in API responses, allowing clients to order data based on specific fields.

Default: -created_at

fileStorageEntityUUID

string · uuid

The unique identifier.

Example: 17fd43a5-a97e-44f7-98a8-0a787da67069

fileStorageName

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

A resource name.

Example: test-name

fileStorageLabelKey

string · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E…

Represents the label identifier. The key is unique within a service.

Example: environment

fileStorageServiceCreate

Schema for creating a new service.

name

fileStorageName · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

A resource name.

Example: test-name

zone

string · pattern: ^[a-z]{2}-[a-z]{3}\d… · required

Indicates the zone where the service will be created.

Example: fi-hel2

configured_status

fileStorageConfiguredStatus · enum · required

The service configured status indicates the service's current intended status. Managed by the customer.

Enum values:

started

stopped

Example: started

size_gib

fileStorageSizeGiB · int32 · min: 250 · max: 25000 · required

The size of the service in gibibytes (GiB)

Example: 250

encrypted

boolean

Indicates whether encryption at rest is enabled for the service.

Example: true

Default: false

fileStorageNetworkCreate[] · maxItems: 1

fileStorageShareCreate[] · maxItems: 50

fileStorageLabelCreate[] · maxItems: 255

Labels

fileStorageConfiguredStatus

string · enum

Enum values:

started

stopped

The service configured status indicates the service's current intended status. Managed by the customer.

Example: started

fileStorageSizeGiB

integer · int32 · min: 250 · max: 25000

The size of the service in gibibytes (GiB)

Example: 250

fileStorageNetworkCreate

Schema for creating a network.

uuid

fileStorageNetworkUUID · uuid · required

Unique identifier for the network.

Example: 03720d07-80a9-41ac-90b0-68a932109339

name

fileStorageName · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

A resource name.

Example: test-name

family

fileStorageNetworkFamily · enum · required

Network family. IPv6 currently not supported.

Enum values:

IPv4

IPv6

Example: IPv4

ip_address

fileStorageIPAddress · ipv4

The desired IP address for the service. If not specified, the service will be assigned an IP address from the network's pool.

Example: 10.20.30.40

fileStorageNetworkUUID

string · uuid

Unique identifier for the network.

Example: 03720d07-80a9-41ac-90b0-68a932109339

fileStorageNetworkFamily

string · enum

Enum values:

IPv4

IPv6

Network family. IPv6 currently not supported.

Example: IPv4

fileStorageIPAddress

string · ipv4

The desired IP address for the service. If not specified, the service will be assigned an IP address from the network's pool.

Example: 10.20.30.40

fileStorageShareCreate

Schema for creating a new share with access control lists (ACLs).

name

string · minLength: 1 · maxLength: 128 · pattern: ^[a-zA-Z0-9_-]+$ · required

A resource name.

Example: test-name

path

fileStoragePath · minLength: 1 · maxLength: 512 · pattern: ^/[a-zA-Z0-9/_-]*$ · required

The absolute path of the share.

Example: /public

fileStorageAclCreate[] · maxItems: 50 · required

fileStoragePath

string · minLength: 1 · maxLength: 512 · pattern: ^/[a-zA-Z0-9/_-]*$

The absolute path of the share.

Example: /public

fileStorageAclCreate

Schema for creating an ACL entry.

name

fileStorageName · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

A resource name.

Example: test-name

target

string · minLength: 1 · maxLength: 255 · required

The target of the ACL entry. It can be a IP Address, Network Prefix or a wildcard.

Example: 192.168.25.147

permission

fileStoragePermission · enum · required

The permission level for the ACL target.

Enum values:

Example: rw

fileStoragePermission

string · enum

Enum values:

The permission level for the ACL target.

Example: rw

fileStorageLabelCreate

Schema for creating a new label.

key

fileStorageLabelKey · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E… · required

Represents the label identifier. The key is unique within a service.

Example: environment

value

fileStorageLabelValue · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p… · required

Represents the label value.

Example: development

fileStorageLabelValue

string | null · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p…

Represents the label value.

Example: development

fileStorageServiceReplace

Schema for replacing an existing service with a new configuration.

name

fileStorageName · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

A resource name.

Example: test-name

configured_status

fileStorageConfiguredStatus · enum · required

The service configured status indicates the service's current intended status. Managed by the customer.

Enum values:

started

stopped

Example: started

size_gib

fileStorageSizeGiB · int32 · min: 250 · max: 25000 · required

The size of the service in gibibytes (GiB)

Example: 250

fileStorageNetworkCreate[] · maxItems: 1

fileStorageLabelCreate[] · maxItems: 255

Labels

fileStorageServiceModify

Schema for modifying an existing service.

name

fileStorageName · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

A resource name.

Example: test-name

configured_status

fileStorageConfiguredStatus · enum

The service configured status indicates the service's current intended status. Managed by the customer.

Enum values:

started

stopped

Example: started

size_gib

fileStorageSizeGiB · int32 · min: 250 · max: 25000

The size of the service in gibibytes (GiB)

Example: 250

array | null · maxItems: 1

array | null · maxItems: 255

fileStorageNetworkModify

Schema for modifying an existing network.

uuid

fileStorageNetworkUUID · uuid

Unique identifier for the network.

Example: 03720d07-80a9-41ac-90b0-68a932109339

name

fileStorageName · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

A resource name.

Example: test-name

family

fileStorageNetworkFamily · enum

Network family. IPv6 currently not supported.

Enum values:

IPv4

IPv6

Example: IPv4

ip_address

fileStorageIPAddress · ipv4

The desired IP address for the service. If not specified, the service will be assigned an IP address from the network's pool.

Example: 10.20.30.40

fileStorageShareModify

Schema for modifying an existing share.

name

string · minLength: 1 · maxLength: 128 · pattern: ^[a-zA-Z0-9_-]+$

A resource name.

Example: test-name

fileStorageAclCreate[] · maxItems: 50

fileStorageAclModify

Schema for modifying an existing ACL.

name

fileStorageName · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

A resource name.

Example: test-name

target

string · minLength: 1 · maxLength: 255

The target of the ACL entry. It can be a IP Address, Network Prefix or a wildcard.

Example: 192.168.25.147

permission

fileStoragePermission · enum

The permission level for the ACL target.

Enum values:

Example: rw

fileStorageLabelModify

Schema for modifying an existing label.

key

fileStorageLabelKey · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E…

Represents the label identifier. The key is unique within a service.

Example: environment

value

fileStorageLabelValue · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p…

Represents the label value.

Example: development

fileStorageServiceListResponse

Schema for the response containing a list of services.

Example: [{"configured_status":"started","created_at":"2025-08-01T10:40:04.140473Z","encrypted":false,"labels":[{"key":"environment","value":"production"}],"name":"test2","networks":[{"family":"IPv4","ip_address":"10.10.10.50","name":"net","uuid":"0391f203-6eef-4a69-bfcc-fffffbdfdc32"}],"operational_state":"running","shares":[{"acl":[{"name":"test-name","permission":"ro","target":"*"}],"name":"read","path":"/public"},{"acl":[{"name":"test-name","permission":"rw","target":"10.10.10.0/24"},{"name":"test-name","permission":"rw","target":"local.domain"}],"name":"write","path":"/project/data"}],"size_gib":250,"state_messages":[],"updated_at":"2025-08-03T19:23:52.350216Z","uuid":"17871d62-6964-4336-b68d-4a85a8ee10fe","zone":"fi-dev2"}]

Schema for the detailed response of a service.

fileStorageServiceDetailResponse

uuid

string

name

string

zone

string

configured_status

string

operational_state

string

size_gib

integer · int32

encrypted

boolean

fileStorageNetworkDetailResponse[]

fileStorageShareDetailResponse[]

fileStorageLabelDetails[]

object[]

created_at

string · date-time

updated_at

string · date-time

fileStorageServiceDetailResponse

Schema for the detailed response of a service.

uuid

string

name

string

zone

string

configured_status

string

operational_state

string

size_gib

integer · int32

encrypted

boolean

fileStorageNetworkDetailResponse[]

fileStorageShareDetailResponse[]

fileStorageLabelDetails[]

object[]

created_at

string · date-time

updated_at

string · date-time

fileStorageNetworkDetailResponse

Schema for the detailed response of a network.

family

string

ip_address

string

name

string

uuid

string

fileStorageShareDetailResponse

Schema for the detailed response of a share.

name

string

path

string

object[]

fileStorageLabelDetails

Schema for label details including key-value pairs.

key

string

value

string

fileStorageErrorResponse

Schema for error responses from the API.

type

string · enum · required

Error code string.

Enum values:

https://developers.upcloud.com/1.3/errors#ERROR_INVALID_REQUEST

https://developers.upcloud.com/1.3/errors#ERROR_RESOURCE_NOT_FOUND

https://developers.upcloud.com/1.3/errors#ERROR_INSUFFICIENT_CREDITS

https://developers.upcloud.com/1.3/errors#ERROR_GENERAL_FAILURE

title

string · required

Short description of the error.

Example: Validation error.

correlation_id

string · required

Unique identifier for the request, useful for debugging.

Example: 01K1K2TKEASWRJ6VFP9ZV5P2H4

status

integer · int32 · required

HTTP status code associated with the error.

Example: 400

object[]

List of invalid parameters in the request.

fileStorageNetworkListResponse

fileStorageNetworkDetailResponse[]

Schema for the response containing a list of networks.

Example: [{"family":"IPv4","ip_address":"192.168.147.250","name":"test-name","uuid":"03720d07-80a9-41ac-90b0-68a932109339"}]

Schema for the detailed response of a network.

fileStorageNetworkDetailResponse

family

string

ip_address

string

name

string

uuid

string

fileStorageShareListResponse

fileStorageShareDetailResponse[]

Schema for the response containing a list of shares.

Example: [{"name":"write","path":"/project/data","acl":[{"name":"test-name","target":"*","permission":"rw"}]},{"name":"read","path":"/project/logs","acl":[{"name":"test-name","target":"192.168.147.0/24","permission":"ro"}]}]

Schema for the detailed response of a share.

fileStorageShareDetailResponse

name

string

path

string

object[]

fileStorageAclListResponse

fileStorageAclDetailResponse[]

Schema for the response containing a list of ACLs.

Example: [{"name":"test-name-1","target":"*","permission":"rw"},{"name":"test-name-2","target":"192.168.147.0/24","permission":"ro"}]

Schema for the detailed response of an ACL.

fileStorageAclDetailResponse

name

string

target

string

permission

string

fileStorageAclDetailResponse

Schema for the detailed response of an ACL.

name

string

target

string

permission

string

fileStorageLabelsListResponse

fileStorageLabelDetails[]

Response schema for listing labels.

Example: [{"key":"environment","value":"production"}]

Schema for label details including key-value pairs.

fileStorageLabelDetails

key

string

value

string

LogicalDatabaseCreate

Schema for creating a logical database.

name

string · required

logical database name

Example: my_database

lc_collate

string

Collation order

Example: en_US.UTF-8

lc_ctype

string

Category of a locale definition source file

Example: en_US.UTF-8

LogicalDatabasesResponse

LogicalDatabaseResponse[]

A list of logical databases.

Example: [{"name":"postgres","lc_collate":"en_US.UTF-8","lc_ctype":"en_US.UTF-8"}]

Schema for a logical database response.

LogicalDatabaseResponse

name

string

The name of the logical database.

lc_collate

string

The LC_COLLATE setting of the logical database.

lc_ctype

string

The LC_CTYPE setting of the logical database.

LogicalDatabaseResponse

Schema for a logical database response.

name

string

The name of the logical database.

lc_collate

string

The LC_COLLATE setting of the logical database.

lc_ctype

string

The LC_CTYPE setting of the logical database.

databaseServiceType

string · enum

Enum values:

mysql

opensearch

valkey

The type of service.

Example: mysql

databaseQueryParamLimit

integer · min: 0 · max: 100

Schema for a query parameter specifying the maximum number of entries to return (limit).

Example: 10

Default: 10

databaseQueryParamOffset

integer · min: 0

Schema for a query parameter specifying the offset for pagination.

Example: 0

Default: 0

databaseQueryParamSort

string · enum

Enum values:

created_at

-created_at

name

-name

operational_state

-operational_state

zone

-zone

Schema for a query parameter specifying the sort field and direction. Prefix with '-' for descending order.

Example: -created_at

databaseUuid

string · uuid

The unique identifier for the integration.

Example: 01234567-89ab-cdef-0123-456789abcdef

databaseLabelKey

string · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E…

The key of a label.

Example: foo

databaseIntegrationUUID

string · uuid

The unique identifier for the service.

Example: 01234567-89ab-cdef-0123-456789abcdef

databaseQueryParamOrder

string

Schema for a query parameter specifying the order.

Example: asc

databaseTitle

string · minLength: 1 · maxLength: 64

The title of an entity.

Example: my-service

databaseId

integer · int32

The unique identifier for the integration.

Example: 1001

databaseServiceCreateOpenAPI

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object
	type = object
	type = object
	type = object

Properties for Variant 1:

mysql properties

admin_password

string | null · minLength: 8 · maxLength: 256 · pattern: ^[a-zA-Z0-9-_]+$

admin_username

string | null · maxLength: 64 · pattern: ^[_A-Za-z0-9][-._A-Z…

automatic_utility_network_ip_filter

boolean

Automatically allow connections from servers in the utility network within the same zone

backup_hour

integer · min: 0 · max: 23

backup_minute

integer · min: 0 · max: 59

binlog_retention_period

integer · min: 600 · max: 9007199254740991

connect_timeout

integer · min: 2 · max: 3600

The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake

default_time_zone

string · minLength: 2 · maxLength: 100 · pattern: ^([-+][\d:]*|[\w/]*)…

Default server time zone as an offset from UTC (from -12:00 to +12:00), a time zone name, or 'SYSTEM' to use the MySQL server default.

group_concat_max_len

integer · min: 4 · max: 18446744073709552000

The maximum permitted result length in bytes for the GROUP_CONCAT() function.

information_schema_stats_expiry

integer · min: 900 · max: 31536000

The time, in seconds, before cached statistics expire

innodb_change_buffer_max_size

integer · min: 0 · max: 50

Maximum size for the InnoDB change buffer, as a percentage of the total size of the buffer pool. Default is 25

innodb_flush_neighbors

integer · min: 0 · max: 2

Specifies whether flushing a page from the InnoDB buffer pool also flushes other dirty pages in the same extent (default is 1): 0 - dirty pages in the same extent are not flushed, 1 - flush contiguous dirty pages in the same extent, 2 - flush dirty pages in the same extent

innodb_ft_min_token_size

integer · min: 0 · max: 16

Minimum length of words that are stored in an InnoDB FULLTEXT index. Changing this parameter will lead to a restart of the MySQL service.

innodb_ft_server_stopword_table

null | string · maxLength: 1024 · pattern: ^.+/.+$

This option is used to specify your own InnoDB FULLTEXT index stopword list for all InnoDB tables.

innodb_lock_wait_timeout

integer · min: 1 · max: 3600

The length of time in seconds an InnoDB transaction waits for a row lock before giving up. Default is 120.

innodb_log_buffer_size

integer · min: 1048576 · max: 4294967296

The size in bytes of the buffer that InnoDB uses to write to the log files on disk.

innodb_online_alter_log_max_size

integer · min: 65536 · max: 1099511627776

The upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables.

innodb_print_all_deadlocks

boolean

When enabled, information about all deadlocks in InnoDB user transactions is recorded in the error log. Disabled by default.

innodb_read_io_threads

integer · min: 1 · max: 64

The number of I/O threads for read operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service.

innodb_rollback_on_timeout

boolean

When enabled a transaction timeout causes InnoDB to abort and roll back the entire transaction. Changing this parameter will lead to a restart of the MySQL service.

innodb_thread_concurrency

integer · min: 0 · max: 1000

Defines the maximum number of threads permitted inside of InnoDB. Default is 0 (infinite concurrency - no limit)

innodb_write_io_threads

integer · min: 1 · max: 64

The number of I/O threads for write operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service.

interactive_timeout

integer · min: 30 · max: 604800

The number of seconds the server waits for activity on an interactive connection before closing it.

internal_tmp_mem_storage_engine

string · enum

The storage engine for in-memory internal temporary tables.

Enum values:

TempTable

MEMORY

ip_filter

string[]

Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'

log_output

string · enum

The slow log output destination when slow_query_log is ON. To enable MySQL AI Insights, choose INSIGHTS. To use MySQL AI Insights and the mysql.slow_log table at the same time, choose INSIGHTS,TABLE. To only use the mysql.slow_log table, choose TABLE. To silence slow logs, choose NONE.

Enum values:

INSIGHTS

TABLE

INSIGHTS,TABLE

NONE

long_query_time

number · min: 0 · max: 3600

The slow_query_logs work as SQL statements that take more than long_query_time seconds to execute.

lower_case_table_names

integer · enum

Sets how table and database names are stored and compared. 0 = case-sensitive (default), 1 = names stored lowercase, comparisons are case-insensitive. This option can only be set when creating the service and cannot be changed later. See https://dev.mysql.com/doc/refman/8.0/en/identifier-case-sensitivity.html for details.

Enum values:

max_allowed_packet

integer · min: 102400 · max: 1073741824

Size of the largest message in bytes that can be received by the server. Default is 67108864 (64M)

max_heap_table_size

integer · min: 1048576 · max: 1073741824

Limits the size of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M)

migration

object | null

object

net_buffer_length

integer · min: 1024 · max: 1048576

Start sizes of connection buffer and result buffer. Default is 16384 (16K). Changing this parameter will lead to a restart of the MySQL service.

net_read_timeout

integer · min: 1 · max: 3600

The number of seconds to wait for more data from a connection before aborting the read.

net_write_timeout

integer · min: 1 · max: 3600

The number of seconds to wait for a block to be written to a connection before aborting the write.

performance_schema_events_statements_history_size

integer | null · min: 0 · max: 1024

The number of rows per thread in the events_statements_history table. Changing this parameter will lead to a restart of the MySQL service.

public_access

boolean

Allow access to the service from the public Internet

public_access_prometheus

boolean

Allow access to Prometheus metrics from the public Internet

relay_log_space_limit

integer · min: 134217728 · max: 18446744073709552000

The maximum amount of space in bytes to use for all relay logs while replicating from an external migration source. When the limit is reached, the replication I/O thread stops fetching relay log events until the SQL thread has caught up. Raise this to give a large migration a bigger relay-log budget; ensure the service disk is sized accordingly. The setting applies only on the node replicating from the external source; standby nodes always use the UpCloud-managed default (the smaller of 5 GiB and 30% of the service disk), which is also used when this option is left unset. Changing this parameter will lead to a restart of the MySQL service.

service_log

boolean | null

Store logs for the service so that they are available in the HTTP API and console.

slow_query_log

boolean

Slow query log enables capturing of slow queries. Setting slow_query_log to false also truncates the mysql.slow_log table.

sort_buffer_size

integer · min: 32768 · max: 1073741824

Sort buffer size in bytes for ORDER BY optimization. Default is 262144 (256K)

sql_mode

string · maxLength: 1024 · pattern: ^[A-Z_]*(,[A-Z_]+)*$

Global SQL mode. Set to empty to use MySQL server defaults. When creating a new service and not setting this field UpCloud default SQL mode (strict, SQL standard compliant) will be assigned.

sql_require_primary_key

boolean

Require primary key to be defined for new tables or old tables modified with ALTER TABLE and fail if missing. It is recommended to always have primary keys because various functionality may break if any large table is missing them.

tmp_table_size

integer · min: 1048576 · max: 1073741824

Limits the size of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M)

version

string | null · enum

Enum values:

8.4

wait_timeout

integer · min: 1 · max: 2147483

The number of seconds the server waits for activity on a noninteractive connection before closing it.

databaseServicePropertiesMysql

mysql properties

admin_password

string | null · minLength: 8 · maxLength: 256 · pattern: ^[a-zA-Z0-9-_]+$

admin_username

string | null · maxLength: 64 · pattern: ^[_A-Za-z0-9][-._A-Z…

automatic_utility_network_ip_filter

boolean

Automatically allow connections from servers in the utility network within the same zone

backup_hour

integer · min: 0 · max: 23

backup_minute

integer · min: 0 · max: 59

binlog_retention_period

integer · min: 600 · max: 9007199254740991

connect_timeout

integer · min: 2 · max: 3600

The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake

default_time_zone

string · minLength: 2 · maxLength: 100 · pattern: ^([-+][\d:]*|[\w/]*)…

Default server time zone as an offset from UTC (from -12:00 to +12:00), a time zone name, or 'SYSTEM' to use the MySQL server default.

group_concat_max_len

integer · min: 4 · max: 18446744073709552000

The maximum permitted result length in bytes for the GROUP_CONCAT() function.

information_schema_stats_expiry

integer · min: 900 · max: 31536000

The time, in seconds, before cached statistics expire

innodb_change_buffer_max_size

integer · min: 0 · max: 50

Maximum size for the InnoDB change buffer, as a percentage of the total size of the buffer pool. Default is 25

innodb_flush_neighbors

integer · min: 0 · max: 2

innodb_ft_min_token_size

integer · min: 0 · max: 16

Minimum length of words that are stored in an InnoDB FULLTEXT index. Changing this parameter will lead to a restart of the MySQL service.

innodb_ft_server_stopword_table

null | string · maxLength: 1024 · pattern: ^.+/.+$

This option is used to specify your own InnoDB FULLTEXT index stopword list for all InnoDB tables.

innodb_lock_wait_timeout

integer · min: 1 · max: 3600

The length of time in seconds an InnoDB transaction waits for a row lock before giving up. Default is 120.

innodb_log_buffer_size

integer · min: 1048576 · max: 4294967296

The size in bytes of the buffer that InnoDB uses to write to the log files on disk.

innodb_online_alter_log_max_size

integer · min: 65536 · max: 1099511627776

The upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables.

innodb_print_all_deadlocks

boolean

When enabled, information about all deadlocks in InnoDB user transactions is recorded in the error log. Disabled by default.

innodb_read_io_threads

integer · min: 1 · max: 64

The number of I/O threads for read operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service.

innodb_rollback_on_timeout

boolean

When enabled a transaction timeout causes InnoDB to abort and roll back the entire transaction. Changing this parameter will lead to a restart of the MySQL service.

innodb_thread_concurrency

integer · min: 0 · max: 1000

Defines the maximum number of threads permitted inside of InnoDB. Default is 0 (infinite concurrency - no limit)

innodb_write_io_threads

integer · min: 1 · max: 64

The number of I/O threads for write operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service.

interactive_timeout

integer · min: 30 · max: 604800

The number of seconds the server waits for activity on an interactive connection before closing it.

internal_tmp_mem_storage_engine

string · enum

The storage engine for in-memory internal temporary tables.

Enum values:

TempTable

MEMORY

ip_filter

string[]

Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'

log_output

string · enum

Enum values:

INSIGHTS

TABLE

INSIGHTS,TABLE

NONE

long_query_time

number · min: 0 · max: 3600

The slow_query_logs work as SQL statements that take more than long_query_time seconds to execute.

lower_case_table_names

integer · enum

Enum values:

max_allowed_packet

integer · min: 102400 · max: 1073741824

Size of the largest message in bytes that can be received by the server. Default is 67108864 (64M)

max_heap_table_size

integer · min: 1048576 · max: 1073741824

Limits the size of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M)

migration

object | null

object

net_buffer_length

integer · min: 1024 · max: 1048576

Start sizes of connection buffer and result buffer. Default is 16384 (16K). Changing this parameter will lead to a restart of the MySQL service.

net_read_timeout

integer · min: 1 · max: 3600

The number of seconds to wait for more data from a connection before aborting the read.

net_write_timeout

integer · min: 1 · max: 3600

The number of seconds to wait for a block to be written to a connection before aborting the write.

performance_schema_events_statements_history_size

integer | null · min: 0 · max: 1024

The number of rows per thread in the events_statements_history table. Changing this parameter will lead to a restart of the MySQL service.

public_access

boolean

Allow access to the service from the public Internet

public_access_prometheus

boolean

Allow access to Prometheus metrics from the public Internet

relay_log_space_limit

integer · min: 134217728 · max: 18446744073709552000

service_log

boolean | null

Store logs for the service so that they are available in the HTTP API and console.

slow_query_log

boolean

Slow query log enables capturing of slow queries. Setting slow_query_log to false also truncates the mysql.slow_log table.

sort_buffer_size

integer · min: 32768 · max: 1073741824

Sort buffer size in bytes for ORDER BY optimization. Default is 262144 (256K)

sql_mode

string · maxLength: 1024 · pattern: ^[A-Z_]*(,[A-Z_]+)*$

Global SQL mode. Set to empty to use MySQL server defaults. When creating a new service and not setting this field UpCloud default SQL mode (strict, SQL standard compliant) will be assigned.

sql_require_primary_key

boolean

tmp_table_size

integer · min: 1048576 · max: 1073741824

Limits the size of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M)

version

string | null · enum

Enum values:

8.4

wait_timeout

integer · min: 1 · max: 2147483

The number of seconds the server waits for activity on a noninteractive connection before closing it.

databaseServicePropertiesPg

pg properties

admin_password

string | null · minLength: 8 · maxLength: 256 · pattern: ^[a-zA-Z0-9-_]+$

admin_username

string | null · maxLength: 64 · pattern: ^[_A-Za-z0-9][-._A-Z…

automatic_utility_network_ip_filter

boolean

Automatically allow connections from servers in the utility network within the same zone

autovacuum_analyze_scale_factor

number · min: 0 · max: 1

Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. 0.2 for 20% of the table size). The default is 0.2.

autovacuum_analyze_threshold

integer · min: 0 · max: 2147483647

Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50.

autovacuum_freeze_max_age

integer · min: 200000000 · max: 1500000000

Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart.

autovacuum_max_workers

integer · min: 1 · max: 20

Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is 3. Changing this parameter causes a service restart.

autovacuum_naptime

integer · min: 1 · max: 86400

Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is 60.

autovacuum_vacuum_cost_delay

integer · min: -1 · max: 100

Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default is 2 (upstream default).

autovacuum_vacuum_cost_limit

integer · min: -1 · max: 10000

Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_limit value will be used. The default is -1 (upstream default).

autovacuum_vacuum_scale_factor

number · min: 0 · max: 1

Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. 0.2 for 20% of the table size). The default is 0.2.

autovacuum_vacuum_threshold

integer · min: 0 · max: 2147483647

Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50.

backup_hour

integer | null · min: 0 · max: 23

backup_interval_hours

integer | null · enum · min: 3 · max: 24

Interval in hours between automatic backups. Minimum value is 3 hours. Must be a divisor of 24 (3, 4, 6, 8, 12, 24). (Applicable to ACU plans only)

Enum values:

backup_minute

integer | null · min: 0 · max: 59

backup_retention_days

integer | null · min: 1 · max: 30

Number of days to retain automatic backups. Backups older than this value will be automatically deleted. (Applicable to ACU plans only)

bgwriter_delay

integer · min: 10 · max: 10000

Specifies the delay between activity rounds for the background writer in milliseconds. The default is 200.

bgwriter_flush_after

integer · min: 0 · max: 2048

Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is 512.

bgwriter_lru_maxpages

integer · min: 0 · max: 1073741823

In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. The default is 100.

bgwriter_lru_multiplier

number · min: 0 · max: 10

The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.

deadlock_timeout

integer · min: 500 · max: 1800000

This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. The default is 1000 (upstream default).

default_toast_compression

string · enum

Specifies the default TOAST compression method for values of compressible columns. The default is lz4. Only available for PostgreSQL 14+.

Enum values:

lz4

pglz

enable_ha_replica_dns

boolean

Creates a dedicated read-only DNS that automatically falls back to the primary if standby nodes are unavailable. It switches back when a standby recovers.

idle_in_transaction_session_timeout

integer · min: 0 · max: 604800000

Time out sessions with open transactions after this number of milliseconds

io_combine_limit

integer · min: 1 · max: 32

EXPERIMENTAL: Controls the largest I/O size in operations that combine I/O in 8kB units. Version 17 and up only.

io_max_combine_limit

integer · min: 1 · max: 128

EXPERIMENTAL: Controls the largest I/O size in operations that combine I/O in 8kB units, and silently limits the user-settable parameter io_combine_limit. Version 18 and up only. Changing this parameter causes a service restart.

io_max_concurrency

integer · min: -1 · max: 1024

EXPERIMENTAL: Controls the maximum number of I/O operations that one process can execute simultaneously. Version 18 and up only. Changing this parameter causes a service restart.

io_method

string · enum

EXPERIMENTAL: Controls the maximum number of I/O operations that one process can execute simultaneously. Version 18 and up only. Changing this parameter causes a service restart.

Enum values:

worker

sync

io_uring

io_workers

integer · min: 1 · max: 32

EXPERIMENTAL: Number of IO worker processes, for io_method=worker. Version 18 and up only. Changing this parameter causes a service restart.

ip_filter

string[]

Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'

jit

boolean

Controls system-wide use of Just-in-Time Compilation (JIT).

log_autovacuum_min_duration

integer · min: -1 · max: 2147483647

Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one disables logging autovacuum actions. The default is 1000.

log_error_verbosity

string · enum

Controls the amount of detail written in the server log for each message that is logged.

Enum values:

TERSE

DEFAULT

VERBOSE

log_line_prefix

string · enum

Choose from one of the available log formats.

Enum values:

'pid=%p,user=%u,db=%d,app=%a,client=%h '

'pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '

'%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h '

'%m [%p] %q[user=%u,db=%d,app=%a] '

log_min_duration_statement

integer · min: -1 · max: 86400000

Log statements that take more than this number of milliseconds to run, -1 disables

log_temp_files

integer · min: -1 · max: 2147483647

Log statements for each temporary file created larger than this number of kilobytes, -1 disables

max_connections

integer · min: 25 · max: 60000

Sets the PostgreSQL maximum number of concurrent connections to the database server. For services with a read replica, first increase the read replica's value. After the change is applied to the replica, you can increase the primary service's value. Changing this parameter causes a service restart.

max_files_per_process

integer · min: 1000 · max: 4096

PostgreSQL maximum number of files that can be open per process. The default is 1000 (upstream default). Changing this parameter causes a service restart.

max_locks_per_transaction

integer · min: 64 · max: 6400

PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart.

max_logical_replication_workers

integer · min: 4 · max: 256

PostgreSQL maximum logical replication workers (taken from the pool defined by max_worker_processes). The default is 4 (upstream default). Changing this parameter causes a service restart.

max_parallel_workers

integer · min: 0 · max: 96

Sets the maximum number of workers that the system can support for parallel queries. The default is 8 (upstream default).

max_parallel_workers_per_gather

integer · min: 0 · max: 96

Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is 2 (upstream default).

max_pred_locks_per_transaction

integer · min: 64 · max: 5120

PostgreSQL maximum predicate locks per transaction. The default is 64 (upstream default). Changing this parameter causes a service restart.

max_prepared_transactions

integer · min: 0 · max: 10000

PostgreSQL maximum prepared transactions. The default is 0. Changing this parameter causes a service restart.

max_replication_slots

integer · min: 8 · max: 256

PostgreSQL maximum replication slots. The default is 20. Changing this parameter causes a service restart.

max_slot_wal_keep_size

integer · min: -1 · max: 2147483647

PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1 is specified, replication slots may retain an unlimited amount of WAL files. The default is -1 (upstream default). wal_keep_size minimum WAL size setting takes precedence over this.

max_stack_depth

integer · min: 2097152 · max: 6291456

Maximum depth of the stack in bytes. The default is 2097152 (upstream default).

max_standby_archive_delay

integer · min: 1 · max: 43200000

Max standby archive delay in milliseconds. The default is 30000 (upstream default).

max_standby_streaming_delay

integer · min: 1 · max: 43200000

Max standby streaming delay in milliseconds. The default is 30000 (upstream default).

max_sync_workers_per_subscription

integer · min: 2 · max: 8

Maximum number of synchronization workers per subscription. The default is 2.

max_wal_senders

integer · min: 20 · max: 256

PostgreSQL maximum WAL senders. The default is 20. Changing this parameter causes a service restart.

max_worker_processes

integer · min: 8 · max: 288

Sets the maximum number of background processes that the system can support. The default is 8. Changing this parameter causes a service restart.

migration

object | null

node_count

integer · min: 1 · max: 100

password_encryption

string | null · enum

Chooses the algorithm for encrypting passwords.

Enum values:

md5

scram-sha-256

pg_partman_bgw_interval

integer · min: 3600 · max: 604800

Sets the time interval in seconds to run pg_partman's scheduled tasks. The default is 3600.

pg_partman_bgw_role

string · maxLength: 64 · pattern: ^[_A-Za-z0-9][-._A-Z…

Controls which role to use for pg_partman's scheduled background tasks.

pg_stat_monitor_enable

boolean

Enable the pg_stat_monitor extension. Changing this parameter causes a service restart. When this extension is enabled, pg_stat_statements results for utility commands are unreliable

pg_stat_monitor_pgsm_enable_query_plan

boolean

Enables or disables query plan monitoring. Changing this parameter causes a service restart. Only available for PostgreSQL 13+.

pg_stat_monitor_pgsm_max_buckets

integer · min: 1 · max: 10

Sets the maximum number of buckets. Changing this parameter causes a service restart. Only available for PostgreSQL 13+.

pg_stat_statements_track

string · enum

Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default is top.

Enum values:

all

top

none

object

System-wide settings for the pgaudit extension.

object

System-wide settings for pgbouncer.

object

System-wide settings for pglookout.

public_access

boolean

Allow access to the service from the public Internet

public_access_prometheus

boolean

Allow access to Prometheus metrics from the public Internet

service_log

boolean | null

Store logs for the service so that they are available in the HTTP API and console.

shared_buffers_percentage

number · min: 20 · max: 60

Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. Changing this parameter causes a service restart.

synchronous_commit

string · enum

Sets the current transaction's synchronization level. The default is off. This setting takes precedence over synchronous_replication.

Enum values:

local

remote_write

remote_apply

off

synchronous_replication

string · enum

This setting is deprecated. Use synchronous_commit instead. Any change to this setting will automatically update synchronous_commit. Setting the value to quorum changes synchronous_commit to remote_write, while setting it to off changes synchronous_commit to off.

Enum values:

quorum

off

temp_file_limit

integer · min: -1 · max: 2147483647

PostgreSQL temporary file limit in KiB, -1 for unlimited

object

System-wide settings for the timescaledb extension

timezone

string · maxLength: 64 · pattern: ^[\w/]*$

PostgreSQL service timezone

track_activity_query_size

integer · min: 1024 · max: 10240

Specifies the number of bytes reserved to track the currently executing command for each active session. Changing this parameter causes a service restart.

track_commit_timestamp

string · enum

Record commit time of transactions. Changing this parameter causes a service restart.

Enum values:

off

track_functions

string · enum

Enables tracking of function call counts and time used.

Enum values:

all

none

track_io_timing

string · enum

Enables timing of database I/O calls. The default is off. When on, it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.

Enum values:

off

variant

string | null · enum

Enum values:

aiven

timescale

version

string | null · enum

Enum values:

integer

Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout.

wal_writer_delay

integer · min: 10 · max: 200

WAL flush interval in milliseconds. The default is 200. Setting this parameter to a lower value may negatively impact performance.

work_mem

integer · min: 1 · max: 1024

Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. The default is 1MB + 0.075% of total RAM (up to 32MB).

databaseServicePropertiesRedis

redis properties

automatic_utility_network_ip_filter

boolean

Automatically allow connections from servers in the utility network within the same zone

backup_hour

integer | null · min: 0 · max: 23

backup_minute

integer | null · min: 0 · max: 59

ip_filter

string[]

Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'

migration

object | null

public_access

boolean

Allow access to the service from the public Internet

public_access_prometheus

boolean

Allow access to Prometheus monitoring from the public Internet

redis_acl_channels_default

string · enum

Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Redis configuration acl-pubsub-default.

Enum values:

allchannels

resetchannels

redis_io_threads

integer · min: 1 · max: 32

Set Redis IO thread count. Changing this will cause a restart of the Redis service.

redis_lfu_decay_time

integer · min: 1 · max: 120

redis_lfu_log_factor

integer · min: 0 · max: 100

redis_maxmemory_policy

string | null · enum

Enum values:

noeviction

allkeys-lru

volatile-lru

allkeys-random

volatile-random

volatile-ttl

volatile-lfu

allkeys-lfu

redis_notify_keyspace_events

string · maxLength: 32 · pattern: ^[KEg\$lshzxentdmA]*…

redis_number_of_databases

integer · min: 1 · max: 128

Set number of Redis databases. Changing this will cause a restart of the Redis service.

redis_persistence

string · enum

When persistence is 'rdb', Redis does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to the backup schedule for backup purposes. When persistence is 'off', no RDB dumps or backups are done, so data can be lost at any moment if the service is restarted for any reason, or if the service is powered off. Also, the service can't be forked.

Enum values:

off

rdb

redis_pubsub_client_output_buffer_limit

integer · min: 32 · max: 512

Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.

redis_ssl

boolean

redis_timeout

integer · min: 0 · max: 2073600

redis_version

string | null · enum

Enum values:

7.0

service_log

boolean | null

Store logs for the service so that they are available in the HTTP API and console.

databaseServicePropertiesOpensearch

opensearch properties

action_auto_create_index_enabled

boolean

Explicitly allow or block automatic creation of indices. Defaults to true

action_destructive_requires_name

boolean | null

object

automatic_utility_network_ip_filter

boolean

Automatically allow connections from servers in the utility network within the same zone

cluster_filecache_remote_data_ratio

integer | number | null · min: 0 · max: 100

Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 0.

cluster_max_shards_per_node

integer · min: 10 · max: 10000

Controls the number of shards allowed in the cluster per data node

object

cluster_routing_allocation_balance_prefer_primary

boolean

When set to true, OpenSearch attempts to evenly distribute the primary shards between the cluster nodes. Enabling this setting does not always guarantee an equal number of primary shards on each node, especially in the event of a failover. Changing this setting to false after it was set to true does not invoke redistribution of primary shards. Default is false.

cluster_routing_allocation_node_concurrent_recoveries

integer · min: 2 · max: 16

How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2.

object

custom_domain

string | null · maxLength: 255

Serve the web frontend using a custom CNAME pointing to the UpCloud DNS name. When you set a custom domain for a service deployed in a VPC, the service certificate is only created for the public-* hostname and the custom domain.

object[]

Allow to register custom keystores in OpenSearch

object[]

Allow to register object storage repositories in OpenSearch

object

email_sender_name

string · maxLength: 40 · pattern: ^[a-zA-Z0-9-_]+$

This should be identical to the Sender name defined in Opensearch dashboards

email_sender_password

string · maxLength: 1024 · pattern: ^[^\x00-\x1F]+$

Sender password for Opensearch alerts to authenticate with SMTP server

email_sender_username

string · maxLength: 320 · pattern: ^[^\x00-\x1F]+$

enable_remote_backed_storage

boolean

enable_searchable_snapshots

boolean

enable_security_audit

boolean

enable_snapshot_api

boolean

Enable/Disable snapshot API for custom repositories, this requires security management to be enabled

http_max_content_length

integer · min: 1 · max: 2147483647

Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.

http_max_header_size

integer · min: 1024 · max: 262144

The max size of allowed headers, in bytes

http_max_initial_line_length

integer · min: 1024 · max: 65536

The max length of an HTTP URL, in bytes

object[]

object

indices_fielddata_cache_size

integer | null · min: 3 · max: 100

Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.

indices_memory_index_buffer_size

integer · min: 3 · max: 40

Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.

indices_memory_max_index_buffer_size

integer · min: 3 · max: 2048

Absolute value. Default is unbound. Doesn't work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit.

indices_memory_min_index_buffer_size

integer · min: 3 · max: 2048

Absolute value. Default is 48mb. Doesn't work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit.

indices_queries_cache_size

integer · min: 3 · max: 40

Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.

indices_query_bool_max_clause_count

integer · min: 64 · max: 4096

Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.

indices_recovery_max_bytes_per_sec

integer · min: 40 · max: 400

Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb

indices_recovery_max_concurrent_file_chunks

integer · min: 2 · max: 5

Number of file chunks sent in parallel for each recovery. Defaults to 2.

ip_filter

string[]

Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'

ism_enabled

boolean

ism_history_enabled

boolean

ism_history_max_age

integer · min: 1 · max: 2147483647

ism_history_max_docs

integer · min: 1 · max: 9223372036854776000

ism_history_rollover_check_period

integer · min: 1 · max: 2147483647

ism_history_rollover_retention_period

integer · min: 1 · max: 2147483647

object

keep_index_refresh_interval

boolean

UpCloud automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.

knn_memory_circuit_breaker_enabled

boolean

Enable or disable KNN memory circuit breaker. Defaults to true.

knn_memory_circuit_breaker_limit

integer · min: 0 · max: 100

Maximum amount of memory in percentage that can be used for the KNN index. Defaults to 50% of the JVM heap size. 0 is used to set it to null which can be used to invalidate caches.

ml_commons_model_access_control_enabled

boolean

Enable or disable model access control for ML Commons. When enabled, access to ML models is controlled by security permissions. Defaults to false.

ml_commons_native_memory_threshold

integer · min: 1 · max: 100

Native memory threshold percentage for ML Commons. Controls the maximum percentage of native memory that can be used by ML Commons operations. Defaults to 90%.

ml_commons_only_run_on_ml_node

boolean

Enable or disable running ML Commons tasks only on ML nodes. When enabled, ML tasks will only execute on nodes designated as ML nodes. Defaults to true.

node_search_cache_size

string | null · pattern: \d+(?:b|kb|mb|gb|tb)

object

override_main_response_version

boolean

Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false. Deprecated and ignored for service version 3.3 and higher.

plugins_alerting_filter_by_backend_roles

boolean

Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false

public_access

boolean

Allow access to the service from the public Internet

public_access_prometheus

boolean

Allow access to Prometheus metrics from the public Internet

reindex_remote_whitelist

array | null

Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.

object

script_max_compilations_rate

string · maxLength: 1024 · pattern: ^[^\r\n]*$

Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context

object

search_max_buckets

integer | null · min: 1 · max: 1000000

Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.

object

service_log

boolean | null

Store logs for the service so that they are available in the HTTP API and console.

object

thread_pool_analyze_queue_size

integer · min: 10 · max: 2000

Size for the thread pool queue. See documentation for exact details.

thread_pool_analyze_size

integer · min: 1 · max: 128

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

thread_pool_force_merge_size

integer · min: 1 · max: 128

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

thread_pool_get_queue_size

integer · min: 10 · max: 2000

Size for the thread pool queue. See documentation for exact details.

thread_pool_get_size

integer · min: 1 · max: 128

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

thread_pool_search_queue_size

integer · min: 10 · max: 2000

Size for the thread pool queue. See documentation for exact details.

thread_pool_search_size

integer · min: 1 · max: 128

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

thread_pool_search_throttled_queue_size

integer · min: 10 · max: 2000

Size for the thread pool queue. See documentation for exact details.

thread_pool_search_throttled_size

integer · min: 1 · max: 128

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

thread_pool_write_queue_size

integer · min: 10 · max: 2000

Size for the thread pool queue. See documentation for exact details.

thread_pool_write_size

integer · min: 1 · max: 128

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

version

string | null · enum

Enum values:

2.19

3.3

databaseServicePropertiesValkey

valkey properties

automatic_utility_network_ip_filter

boolean

Automatically allow connections from servers in the utility network within the same zone

backup_hour

integer | null · min: 0 · max: 23

backup_minute

integer | null · min: 0 · max: 59

frequent_snapshots

boolean

When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off.

ip_filter

string[]

Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'

migration

object | null

public_access

boolean

Allow access to the service from the public Internet

public_access_prometheus

boolean

Allow access to Prometheus metrics from the public Internet

service_log

boolean | null

Store logs for the service so that they are available in the HTTP API and console.

valkey_acl_channels_default

string · enum

Enum values:

allchannels

resetchannels

valkey_active_expire_effort

integer · min: 1 · max: 10

Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency.

valkey_io_threads

integer · min: 1 · max: 256

Set Valkey IO thread count. Changing this will cause a restart of the Valkey service.

valkey_lfu_decay_time

integer · min: 1 · max: 120

valkey_lfu_log_factor

integer · min: 0 · max: 100

valkey_maxmemory_policy

string | null · enum

Enum values:

noeviction

allkeys-lru

volatile-lru

allkeys-random

volatile-random

volatile-ttl

volatile-lfu

allkeys-lfu

valkey_notify_keyspace_events

string · maxLength: 32 · pattern: ^[KEg\$lshzxentdmA]*…

valkey_number_of_databases

integer · min: 1 · max: 128

Set number of Valkey databases. Changing this will cause a restart of the Valkey service.

valkey_persistence

string · enum

When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.

Enum values:

off

rdb

valkey_pubsub_client_output_buffer_limit

integer · min: 32 · max: 262144

valkey_ssl

boolean

valkey_timeout

integer · min: 0 · max: 2073600

valkey_version

string | null · enum

Enum values:

8.1

9.0

databaseServiceModifyOpenAPI

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object
	type = object
	type = object
	type = object

Properties for Variant 1:

mysql properties

databaseServiceCloneMysql

admin_password

string | null · minLength: 8 · maxLength: 256 · pattern: ^[a-zA-Z0-9-_]+$

admin_username

string | null · maxLength: 64 · pattern: ^[_A-Za-z0-9][-._A-Z…

automatic_utility_network_ip_filter

boolean

Automatically allow connections from servers in the utility network within the same zone

backup_hour

integer · min: 0 · max: 23

backup_minute

integer · min: 0 · max: 59

binlog_retention_period

integer · min: 600 · max: 9007199254740991

connect_timeout

integer · min: 2 · max: 3600

The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake

default_time_zone

string · minLength: 2 · maxLength: 100 · pattern: ^([-+][\d:]*|[\w/]*)…

Default server time zone as an offset from UTC (from -12:00 to +12:00), a time zone name, or 'SYSTEM' to use the MySQL server default.

group_concat_max_len

integer · min: 4 · max: 18446744073709552000

The maximum permitted result length in bytes for the GROUP_CONCAT() function.

information_schema_stats_expiry

integer · min: 900 · max: 31536000

The time, in seconds, before cached statistics expire

innodb_change_buffer_max_size

integer · min: 0 · max: 50

Maximum size for the InnoDB change buffer, as a percentage of the total size of the buffer pool. Default is 25

innodb_flush_neighbors

integer · min: 0 · max: 2

innodb_ft_min_token_size

integer · min: 0 · max: 16

Minimum length of words that are stored in an InnoDB FULLTEXT index. Changing this parameter will lead to a restart of the MySQL service.

innodb_ft_server_stopword_table

null | string · maxLength: 1024 · pattern: ^.+/.+$

This option is used to specify your own InnoDB FULLTEXT index stopword list for all InnoDB tables.

innodb_lock_wait_timeout

integer · min: 1 · max: 3600

The length of time in seconds an InnoDB transaction waits for a row lock before giving up. Default is 120.

innodb_log_buffer_size

integer · min: 1048576 · max: 4294967296

The size in bytes of the buffer that InnoDB uses to write to the log files on disk.

innodb_online_alter_log_max_size

integer · min: 65536 · max: 1099511627776

The upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables.

innodb_print_all_deadlocks

boolean

When enabled, information about all deadlocks in InnoDB user transactions is recorded in the error log. Disabled by default.

innodb_read_io_threads

integer · min: 1 · max: 64

The number of I/O threads for read operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service.

innodb_rollback_on_timeout

boolean

When enabled a transaction timeout causes InnoDB to abort and roll back the entire transaction. Changing this parameter will lead to a restart of the MySQL service.

innodb_thread_concurrency

integer · min: 0 · max: 1000

Defines the maximum number of threads permitted inside of InnoDB. Default is 0 (infinite concurrency - no limit)

innodb_write_io_threads

integer · min: 1 · max: 64

The number of I/O threads for write operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service.

interactive_timeout

integer · min: 30 · max: 604800

The number of seconds the server waits for activity on an interactive connection before closing it.

internal_tmp_mem_storage_engine

string · enum

The storage engine for in-memory internal temporary tables.

Enum values:

TempTable

MEMORY

ip_filter

string[]

Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'

log_output

string · enum

Enum values:

INSIGHTS

TABLE

INSIGHTS,TABLE

NONE

long_query_time

number · min: 0 · max: 3600

The slow_query_logs work as SQL statements that take more than long_query_time seconds to execute.

lower_case_table_names

integer · enum

Enum values:

max_allowed_packet

integer · min: 102400 · max: 1073741824

Size of the largest message in bytes that can be received by the server. Default is 67108864 (64M)

max_heap_table_size

integer · min: 1048576 · max: 1073741824

Limits the size of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M)

migration

object | null

object

net_buffer_length

integer · min: 1024 · max: 1048576

Start sizes of connection buffer and result buffer. Default is 16384 (16K). Changing this parameter will lead to a restart of the MySQL service.

net_read_timeout

integer · min: 1 · max: 3600

The number of seconds to wait for more data from a connection before aborting the read.

net_write_timeout

integer · min: 1 · max: 3600

The number of seconds to wait for a block to be written to a connection before aborting the write.

performance_schema_events_statements_history_size

integer | null · min: 0 · max: 1024

The number of rows per thread in the events_statements_history table. Changing this parameter will lead to a restart of the MySQL service.

public_access

boolean

Allow access to the service from the public Internet

public_access_prometheus

boolean

Allow access to Prometheus metrics from the public Internet

relay_log_space_limit

integer · min: 134217728 · max: 18446744073709552000

service_log

boolean | null

Store logs for the service so that they are available in the HTTP API and console.

slow_query_log

boolean

Slow query log enables capturing of slow queries. Setting slow_query_log to false also truncates the mysql.slow_log table.

sort_buffer_size

integer · min: 32768 · max: 1073741824

Sort buffer size in bytes for ORDER BY optimization. Default is 262144 (256K)

sql_mode

string · maxLength: 1024 · pattern: ^[A-Z_]*(,[A-Z_]+)*$

Global SQL mode. Set to empty to use MySQL server defaults. When creating a new service and not setting this field UpCloud default SQL mode (strict, SQL standard compliant) will be assigned.

sql_require_primary_key

boolean

tmp_table_size

integer · min: 1048576 · max: 1073741824

Limits the size of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M)

version

string | null · enum

Enum values:

8.4

wait_timeout

integer · min: 1 · max: 2147483

The number of seconds the server waits for activity on a noninteractive connection before closing it.

databaseServiceTypeModify

Schema for modifying the service type

target_type

string · required

Service type

databaseServiceCloneOpenAPI

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: hostname_prefix
	type = object · requires: hostname_prefix
	type = object · requires: hostname_prefix
	type = object · requires: hostname_prefix
	type = object · requires: hostname_prefix

Properties for ServiceCloneMysql:

Schema for cloning a MySQL service

hostname_prefix

string · minLength: 3 · maxLength: 30 · required

Hostname prefix

plan

string · minLength: 1

Plan

title

databaseTitle · minLength: 1 · maxLength: 64

The title of an entity.

Example: my-service

clone_time

string · date-time · maxLength: 32

Clone time

Example: 2024-01-30T15:04:05Z

backup_name

string · maxLength: 128 · pattern: ^[a-zA-Z0-9-_:.]+$

Backup name

Example: daily-backup-2024-01-30

set_service_uuid

string · uuid

Title

Example: 123e4567-e89b-12d3-a456-426614174000

zone

string · pattern: ^[a-z]{2}-[a-z]{3}\d…

Zone

Example: fi-hel1

termination_protection

boolean

Termination protection

Example: true

Default: false

object

Maintenance

databaseNetworkCreate[] · maxItems: 8

Networks

databaseLabelCreate[] · maxItems: 255

Labels

additional_disk_space_gib

integer · int32

Additional disk space in GiB

Example: 10

mysql properties

databaseServiceCloneMysql

Schema for cloning a MySQL service

hostname_prefix

string · minLength: 3 · maxLength: 30 · required

Hostname prefix

plan

string · minLength: 1

Plan

title

databaseTitle · minLength: 1 · maxLength: 64

The title of an entity.

Example: my-service

clone_time

string · date-time · maxLength: 32

Clone time

Example: 2024-01-30T15:04:05Z

backup_name

string · maxLength: 128 · pattern: ^[a-zA-Z0-9-_:.]+$

Backup name

Example: daily-backup-2024-01-30

set_service_uuid

string · uuid

Title

Example: 123e4567-e89b-12d3-a456-426614174000

zone

string · pattern: ^[a-z]{2}-[a-z]{3}\d…

Zone

Example: fi-hel1

termination_protection

boolean

Termination protection

Example: true

Default: false

object

Maintenance

databaseNetworkCreate[] · maxItems: 8

Networks

databaseLabelCreate[] · maxItems: 255

Labels

additional_disk_space_gib

integer · int32

Additional disk space in GiB

Example: 10

databaseServicePropertiesPg

mysql properties

databaseMaintenanceDow

string · enum

Enum values:

sunday

monday

tuesday

wednesday

thursday

friday

saturday

Day of the week for maintenance window

Example: sunday

databaseMaintenanceTime

string

Time of day for maintenance window in HH:MM format

Example: 02:00

databaseNetworkCreate

Schema for creating a network.

name

databaseNetworkName · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

The name of the network.

Example: private-network

type

databaseNetworkType · enum · required

The type of network.

Enum values:

private

Example: private

family

databaseNetworkFamily · enum · required

The network protocol family.

Enum values:

IPv4

IPv6

Example: IPv4

uuid

string · uuid

Optional UUID for the network. If not provided, a new UUID will be generated.

Example: 123e4567-e89b-12d3-a456-426614174000

databaseNetworkName

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

The name of the network.

Example: private-network

databaseNetworkType

string · enum

Enum values:

private

The type of network.

Example: private

databaseNetworkFamily

string · enum

Enum values:

IPv4

IPv6

The network protocol family.

Example: IPv4

databaseLabelCreate

Schema for creating a label with a key and value.

key

databaseLabelKey · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E… · required

The key of a label.

Example: foo

value

databaseLabelValue · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p… · required

The value of a label.

Example: bar

databaseLabelValue

string · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p…

The value of a label.

Example: bar

databaseServiceClonePg

Schema for cloning a PostgreSQL service.

hostname_prefix

string · minLength: 3 · maxLength: 30 · required

Hostname prefix

Example: my-pg-service

plan

string · minLength: 1

Plan

Example: basic-pg-plan

title

databaseTitle · minLength: 1 · maxLength: 64

The title of an entity.

Example: my-service

clone_time

string · date-time · maxLength: 32

Clone time

Example: 2024-01-30T15:04:05Z

backup_name

string · maxLength: 128 · pattern: ^[a-zA-Z0-9-_:.]+$

Backup name

Example: daily-backup-2024-01-30

set_service_uuid

string · uuid

Title

Example: 123e4567-e89b-12d3-a456-426614174000

zone

string · pattern: ^[a-z]{2}-[a-z]{3}\d…

Zone

Example: fi-hel1

termination_protection

boolean

Termination protection

Example: true

object

Maintenance

databaseNetworkCreate[] · maxItems: 8

databaseLabelCreate[] · maxItems: 255

Labels

additional_disk_space_gib

integer · int32

Additional disk space in GiB

pg properties

databaseServiceCloneRedis

Schema for cloning a Redis service.

hostname_prefix

string · minLength: 3 · maxLength: 30 · required

Hostname prefix

Example: my-redis

plan

string · minLength: 1

Plan

Example: basic-redis-plan

title

databaseTitle · minLength: 1 · maxLength: 64

The title of an entity.

Example: my-service

clone_time

string · date-time · maxLength: 32

Clone time

Example: 2024-01-30T15:04:05Z

backup_name

string · string · maxLength: 128 · pattern: ^[a-zA-Z0-9-_:.]+$

Backup name

Example: daily-backup-2024-01-30

set_service_uuid

string · uuid

Title

Example: 123e4567-e89b-12d3-a456-426614174000

zone

string · pattern: ^[a-z]{2}-[a-z]{3}\d…

Zone

Example: fi-hel1

termination_protection

boolean

Termination protection

Example: true

object

Maintenance

databaseNetworkCreate[] · maxItems: 8

databaseLabelCreate[] · maxItems: 255

Labels

databaseServicePropertiesRedis

redis properties

databaseServiceCloneOpensearch

Schema for cloning an OpenSearch service

hostname_prefix

string · minLength: 3 · maxLength: 30 · required

Hostname prefix

Example: my-opensearch

plan

string · minLength: 1

Plan

Example: my-plan

title

databaseTitle · minLength: 1 · maxLength: 64

The title of an entity.

Example: my-service

clone_time

string · date-time · maxLength: 32

Clone time

Example: 2024-01-30T15:04:05Z

backup_name

string · string · maxLength: 128 · pattern: ^[a-zA-Z0-9-_:.]+$

Backup name

Example: daily-backup-2024-01-30

set_service_uuid

string · uuid

Title

Example: 123e4567-e89b-12d3-a456-426614174000

zone

string · pattern: ^[a-z]{2}-[a-z]{3}\d…

Zone

Example: fi-hel1

termination_protection

boolean

Termination protection

Example: true

object

Maintenance

databaseNetworkCreate[] · maxItems: 8

Networks

databaseLabelCreate[] · maxItems: 255

Labels

additional_disk_space_gib

integer · int32

Additional disk space in GiB

Example: 10

databaseServicePropertiesOpensearch

opensearch properties

databaseServiceCloneValkey

Schema for cloning a service with valkey.

hostname_prefix

string · minLength: 3 · maxLength: 30 · required

Hostname prefix

Example: my-service

plan

string · minLength: 1

Plan

Example: basic-plan

title

databaseTitle · minLength: 1 · maxLength: 64

The title of an entity.

Example: my-service

clone_time

string · date-time · maxLength: 32

Clone time

Example: 2024-01-30T15:04:05Z

backup_name

string · string · maxLength: 128 · pattern: ^[a-zA-Z0-9-_:.]+$

Backup name

Example: daily-backup-2024-01-30

set_service_uuid

string · uuid

Title

Example: 123e4567-e89b-12d3-a456-426614174000

zone

string · pattern: ^[a-z]{2}-[a-z]{3}\d…

Zone

Example: fi-hel1

termination_protection

boolean

Termination protection

Example: true

object

Maintenance

databaseNetworkCreate[] · maxItems: 8

databaseLabelCreate[] · maxItems: 255

Labels

databaseServicePropertiesValkey

valkey properties

databaseServiceUpgrade

Schema for upgrading the service version

target_version

string · required

Version to upgrade the service

databaseLabelModify

Schema for modifying a label with a key and/or value.

key

databaseLabelKey · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E…

The key of a label.

Example: foo

value

databaseLabelValue · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p…

The value of a label.

Example: bar

databaseServiceAclModify

Schema for modifying service access control settings.

access_control

boolean

Enables OpenSearch access control

Example: true

extended_access_control

boolean

Enables OpenSearch extended access control

Example: true

databaseServiceSecurityModify

Schema for modifying service security settings

admin_password

string · required

Current admin password

Example: current_password_123

new_password

string · required

New admin password

Example: new_secure_password_456

databaseServiceSecurityEnable

Schema for enabling security on a service instance

admin_password

string · required

Security admin password

Example: Str0ngP@ssw0rd!

databaseIntegrationEndpointCreate

Schema for creating an integration endpoint.

type

databaseIntegrationEndpoint · enum · required

The type of integration endpoint.

Enum values:

logs

prometheus

rsyslog

Example: rsyslog

name

string · required

The name of the integration endpoint.

Example: webhook-endpoint

properties

object

A key-value map of properties specific to the integration endpoint type.

Example: {"format":"rfc5424","max_message_size":8192,"port":514,"server":"1.1.1.1","tls":false}

databaseIntegrationEndpoint

string · enum

Enum values:

logs

prometheus

rsyslog

The type of integration endpoint.

Example: rsyslog

databaseIntegrationEndpointModify

Schema for modifying an integration endpoint.

object

databaseConnectionPoolCreate

Schema for creating a connection pool.

database

string · required

Database

Example: defaultdb

pool_mode

string · enum · required

Connection Pool mode

Enum values:

session

transaction

statement

Example: session

pool_name

string · required

Connection Pool name

Example: pool-1

pool_size

integer · int32 · required

Connection Pool size

Example: 20

username

string

Connection Pool username

Example: app-user

databaseConnectionPoolModify

Schema for modifying a connection pool.

database

string

Database

Example: defaultdb

pool_mode

string · enum

Connection Pool mode

Enum values:

session

transaction

statement

Example: session

pool_size

integer · int32

Connection Pool size

Example: 20

username

string | null

Connection Pool username

Example: app-user

databaseServiceIntegrationCreate

Schema for creating a service integration.

type

databaseServiceIntegration · enum · required

The type of service integration.

Enum values:

logs

prometheus

rsyslog

Example: logs

destination_uuid

string · uuid

The UUID of the destination where the service integration will send data.

Example: 123e4567-e89b-12d3-a456-426614174000

properties

object

databaseServiceIntegration

string · enum

Enum values:

logs

prometheus

rsyslog

The type of service integration.

Example: logs

databaseServiceIntegrationModify

Schema for modifying a service integration.

properties

object

databaseServiceTaskCreate

Schema for creating a service task with various operations such as dataset import and migration checks.

operation

string · required

The operation to be performed.

Example: upgrade

object

target_version

string · minLength: 1

The target version for upgrade operations.

Example: 14

databaseServiceUserCreate

Schema for creating a service user with access control settings

username

string · required

The username of the service user

Example: defaultdb

password

string

The password of the service user

Example: strongpassword123

authentication

string

The authentication method for the service user

Example: caching_sha2_password

object · minProps: 1

Redis access control settings

object

PostgreSQL access control settings

object

OpenSearch access control settings

object · minProps: 1

Valkey access control settings

databaseServiceUserModify

Schema for modifying a service user

password

string

New password for the service user

Example: new_secure_password_123!

authentication

string

Authentication method for the service user

Example: caching_sha2_password

databaseServiceUserAclModify

Schema for modifying user access control lists (ACL) for various services

object · minProps: 1

Redis ACL modification schema

object

PostgreSQL replication permission modification schema

object

OpenSearch index permission modification schema

object · minProps: 1

Valkey ACL modification schema

databaseAvailableServiceTypesResponse

Response map schema for available service types

name

string

The name of the service type

description

string

The description of the service type

latest_available_version

string

The latest available version of the service type

databaseServicePlanResponse[]

object

databaseServiceTypeResponse

Response schema for available service types

name

string

The name of the service type

description

string

The description of the service type

latest_available_version

string

The latest available version of the service type

databaseServicePlanResponse[]

object

databaseServicePlanResponse

Schema definition for a service plan

General backup configuration schema

Example: {"interval":24,"max_count":7,"recovery_mode":"point_in_time"}

General backup configuration schema

Example: {"interval":24,"max_count":7,"recovery_mode":"point_in_time"}

General backup configuration schema

Example: {"interval":24,"max_count":7,"recovery_mode":"point_in_time"}

General backup configuration schema

Example: {"interval":24,"max_count":7,"recovery_mode":"point_in_time"}

databaseBackupConfigOpenSearchResponse

General backup configuration schema

Example: {"interval":24,"max_count":7,"recovery_mode":"point_in_time"}

OpenSearch specific backup configuration response

Example: {"frequent_interval_minutes":15,"frequent_oldest_age_minutes":60,"infrequent_interval_minutes":240,"infrequent_oldest_age_minutes":1440,"recovery_mode":"point_in_time"}

node_count

integer · int32

Number of nodes in the service plan

object

plan

string

Name of the service plan

core_number

integer · int32

Number of CPU cores per node

storage_size

integer · int32

Storage size in MiB per node

memory_amount

integer · int32

Memory amount in MB per node

databaseBackupConfigResponse

General backup configuration schema

interval

integer · int32

Backup interval

Example: 24

max_count

integer · int32

Maximum number of backups to keep

Example: 7

recovery_mode

string

Recovery mode for backups

Example: point_in_time

databaseBackupConfigOpenSearchResponse

OpenSearch specific backup configuration response

frequent_interval_minutes

integer · int32

Frequent backup interval in minutes

frequent_oldest_age_minutes

integer · int32

Oldest age for frequent backups in minutes

infrequent_interval_minutes

integer · int32

Infrequent backup interval in minutes

infrequent_oldest_age_minutes

integer · int32

Oldest age for infrequent backups in minutes

recovery_mode

string

Recovery mode for backups

databaseZoneInfoResponse

Schema for representing a Zone

name

string

Zone identifier

databasePropertySchemaResponse

Schema definition for a single property

$schema

string

JSON Schema URI

$id

string

Schema identifier

createOnly

boolean

Whether the property can only be set during creation

default

object

Any valid JSON value is allowed here

example

object

Any valid JSON value is allowed here

maxLength

integer · int32

Maximum length for the property schema

minLength

integer · int32

Minimum length for the property schema

pattern

string

Allowed patterns for the property

title

string

Human-readable title for the property

type

string

Data type of the property

user_error

string

User-friendly error message

databasePropertySchemaResponse

Schema definition for a single property

object

Properties for object type

Example: {"foobar":[{"title":"property schema title"}]}

object

Property dependency collection

required

string[]

List of required properties

maxItems

integer · int32

Maximum number of items for arrays

description

string

Description of the property

object[]

Minimum values for numeric properties

object[]

Maximum values for numeric properties

array

Enumeration of allowed values

additionalProperties

boolean

Whether additional properties are allowed

Example: true

databaseDependencyResponse

a dependency definition

required

string[]

List of required properties when this dependency is present

databaseErrorResponse

Schema for error responses from the API.

object

databaseServiceInformationListResponse

databaseServiceInformationResponse[]

Schema for a list of service information

Example: [{"uuid":"123e4567-e89b-12d3-a456-426614174000","zone":"fi-hel1","name":"my-db","type":"pg"}]

Schema for service information response.

databaseServiceInformationResponse

uuid

string · uuid

The unique identifier for the service.

Example: 123e4567-e89b-12d3-a456-426614174000

zone

string

The zone where the service is hosted.

Example: fi-hel1

name

string

The name of the service.

Example: my-db

title

string

The title of the service.

Example: My Database Service

type

string

The type of the service.

Example: pg

plan

string

The plan of the service.

Example: 1x1xCPU-2GB-25GB

additional_disk_space_gib

integer · int32

The additional disk space allocated to the service in GiB.

Example: 10

state

string

The current state of the service.

Example: running

object

A map of errors related to the service state.

Example: {"init":"failed"}

powered

boolean

Indicates whether the service is powered on.

Example: true

termination_protection

boolean

Indicates whether termination protection is enabled for the service.

Example: false

node_count

integer · int32

The number of nodes in the service.

Example: 1

create_time

string · date-time

The time when the service was created.

Example: 2023-10-01T12:00:00Z

update_time

string · date-time

The time when the service was last updated.

Example: 2023-10-10T12:00:00Z

service_uri

string · uri

The URI for accessing the service.

Example: postgres://upadmin:example-prefix-project@pg-2x2xcpu-4gb-50gb-de-fra1-example-prefix-project.db.upclouddatabases.com:11550/defaultdb?sslmode=require

object

A map of connection parameters for the service.

Example: {"dbname":"defaultdb","host":"pg-2x2xcpu-4gb-50gb-de-fra1-example-prefix-project.db.upclouddatabases.com","password":"example-prefix-project","port":"11550","ssl_mode":"require","user":"upadmin"}

databaseMaintenanceWindowResponse

Schema for a maintenance window response.

Example: {"dow":"Monday","time":"2023-05-07T15:55:24.655776Z","pending_updates":[{"deadline":"2022-01-21T12:21:00Z","description":"description related to the update","start_after":"2022-01-21T12:21:00Z","start_at":"2022-10-21T12:21:00Z"}]}

object

A map of metadata key-value pairs for the service.

Example: {"owner":"team-databases"}

object

A map of additional properties for the service.

Example: {"public_access":false}

databaseNetworkInformationDetailsResponse[]

List of network information details associated with the service.

Example: [{"uuid":"123e4567-e89b-12d3-a456-426614174000","name":"example-private-network","family":"IPv4","type":"private","create_time":"2025-08-01T10:40:04.140473Z","update_time":"2025-08-01T10:40:04.140473Z"}]

databaseNodeStateResponse[]

The states of individual nodes in the service.

Example: [{"name":"node-1","role":"master","state":"running","progress_updates":[{"completed":false,"current":45,"max":100,"min":0,"phase":"prepare","unit":"bytes_uncompressed"}]}]

databaseLabelInformationResponse[]

List of label information associated with the service.

Example: [{"key":"environment","value":"production"}]

databaseBackupResponse[]

List of backups associated with the service.

Example: [{"backup_name":"pg-backup-2024-01-01","backup_time":"2024-01-01T12:00:00Z","data_size":36413440}]

databaseServiceComponentResponse[]

List of service components associated with the service.

Example: [{"component":"pg","host":"pg-2x2xcpu-4gb-50gb-de-fra1-example-prefix-project.db.upclouddatabases.com","port":1150,"route":"dynamic","usage":"replica","ssl":true}]

databaseConnectionPoolResponse[]

List of connection pools associated with the service.

Example: [{"connection_uri":"postgresql://user:password@hostname:5432/dbname","database":"pg-db-1","pool_mode":"session","pool_name":"pool-2","pool_size":10,"username":"updamin"}]

databaseUserResponse[]

List of users associated with the service.

Example: [{"username":"admin","password":"my-password","authentication":"caching_sha2_password","type":"admin"}]

LogicalDatabaseResponse[]

A list of logical databases.

Example: [{"name":"postgres","lc_collate":"en_US.UTF-8","lc_ctype":"en_US.UTF-8"}]

databaseAclResponse[]

List of ACLs associated with the service.

Example: [{"id":"123e4567-e89b-12d3-a456-426614174000","permission":"read-write","topic":"sensors/temperature","username":"user123"}]

databaseServiceIntegrationResponse[]

List of service integrations associated with the service.

Example: [{"uuid":"123e4567-e89b-12d3-a456-426614174000","type":"rsyslog","source_name":"my-database","source_uuid":"123e4567-e89b-12d3-a456-426614174000","destination_name":"my-rsyslog-server","destination_uuid":"123e4567-e89b-12d3-a456-426614174000","state":"active","state_error":[],"node_states":[{"name":"node-1","status":"running","errors":["some error"],"likely_error_cause":null}],"properties":{"key1":"value1","key2":2,"key3":true}}]

databaseServiceInformationResponse

Schema for service information response.

uuid

string · uuid

The unique identifier for the service.

Example: 123e4567-e89b-12d3-a456-426614174000

zone

string

The zone where the service is hosted.

Example: fi-hel1

name

string

The name of the service.

Example: my-db

title

string

The title of the service.

Example: My Database Service

type

string

The type of the service.

Example: pg

plan

string

The plan of the service.

Example: 1x1xCPU-2GB-25GB

additional_disk_space_gib

integer · int32

The additional disk space allocated to the service in GiB.

Example: 10

state

string

The current state of the service.

Example: running

object

A map of errors related to the service state.

Example: {"init":"failed"}

powered

boolean

Indicates whether the service is powered on.

Example: true

termination_protection

boolean

Indicates whether termination protection is enabled for the service.

Example: false

node_count

integer · int32

The number of nodes in the service.

Example: 1

create_time

string · date-time

The time when the service was created.

Example: 2023-10-01T12:00:00Z

update_time

string · date-time

The time when the service was last updated.

Example: 2023-10-10T12:00:00Z

service_uri

string · uri

The URI for accessing the service.

Example: postgres://upadmin:example-prefix-project@pg-2x2xcpu-4gb-50gb-de-fra1-example-prefix-project.db.upclouddatabases.com:11550/defaultdb?sslmode=require

object

A map of connection parameters for the service.

databaseMaintenanceWindowResponse

Schema for a maintenance window response.

object

A map of metadata key-value pairs for the service.

Example: {"owner":"team-databases"}

object

A map of additional properties for the service.

Example: {"public_access":false}

databaseNetworkInformationDetailsResponse[]

List of network information details associated with the service.

databaseNodeStateResponse[]

The states of individual nodes in the service.

Example: [{"name":"node-1","role":"master","state":"running","progress_updates":[{"completed":false,"current":45,"max":100,"min":0,"phase":"prepare","unit":"bytes_uncompressed"}]}]

databaseLabelInformationResponse[]

List of label information associated with the service.

Example: [{"key":"environment","value":"production"}]

databaseBackupResponse[]

List of backups associated with the service.

Example: [{"backup_name":"pg-backup-2024-01-01","backup_time":"2024-01-01T12:00:00Z","data_size":36413440}]

databaseServiceComponentResponse[]

List of service components associated with the service.

Example: [{"component":"pg","host":"pg-2x2xcpu-4gb-50gb-de-fra1-example-prefix-project.db.upclouddatabases.com","port":1150,"route":"dynamic","usage":"replica","ssl":true}]

databaseConnectionPoolResponse[]

List of connection pools associated with the service.

Example: [{"connection_uri":"postgresql://user:password@hostname:5432/dbname","database":"pg-db-1","pool_mode":"session","pool_name":"pool-2","pool_size":10,"username":"updamin"}]

databaseUserResponse[]

List of users associated with the service.

Example: [{"username":"admin","password":"my-password","authentication":"caching_sha2_password","type":"admin"}]

LogicalDatabaseResponse[]

A list of logical databases.

Example: [{"name":"postgres","lc_collate":"en_US.UTF-8","lc_ctype":"en_US.UTF-8"}]

databaseAclResponse[]

List of ACLs associated with the service.

Example: [{"id":"123e4567-e89b-12d3-a456-426614174000","permission":"read-write","topic":"sensors/temperature","username":"user123"}]

databaseServiceIntegrationResponse[]

List of service integrations associated with the service.

databaseMaintenanceWindowResponse

Schema for a maintenance window response.

dow

string

Day of the week when maintenance occurs (e.g., Monday, Tuesday).

time

string · date-time

Time of day when maintenance should start (e.g., HH:MM format).

databaseMaintenancePendingUpdatesResponse[]

List of updates pending during this maintenance window.

databaseMaintenancePendingUpdatesResponse

Response schema for pending maintenance updates.

deadline

string · date-time

The deadline by which the update must be applied

description

string

A description of the pending update

start_after

string · date-time

The earliest time after which the update can start

start_at

string · date-time

The exact scheduled start time for the update

databaseNetworkInformationDetailsResponse

Schema for network information response details

uuid

string · uuid

Unique identifier for the network

name

string

Name of the network

family

string · enum

Address family (e.g., IPv4, IPv6)

Enum values:

IPv4

IPv6

Example: IPv4

type

string · enum

Type of network (e.g., private, public)

Enum values:

private

public

Example: private

create_time

string · date-time

Timestamp when the network was created

update_time

string · date-time

Timestamp when the network was last updated

databaseNodeStateResponse

Schema for the state of a node in a service.

name

string

Name of the node.

role

string

Role of the node in the service.

state

string

Current state of the node.

databaseNodeProgressUpdateResponse[]

Response schema for node progress updates

databaseNodeProgressUpdatesResponse

databaseNodeProgressUpdateResponse[]

Response schema for node progress updates

Schema for node progress update response.

databaseNodeProgressUpdateResponse

completed

boolean

Indicates whether the progress is fully completed.

current

integer · int32

The current progress value.

max

integer · int32

The maximum value for the progress range.

min

integer · int32

The minimum value for the progress range.

phase

string

The current node progress.

unit

string

The unit of measurement for the progress values (e.g., percent, MB).

databaseNodeProgressUpdateResponse

Schema for node progress update response.

completed

boolean

Indicates whether the progress is fully completed.

current

integer · int32

The current progress value.

max

integer · int32

The maximum value for the progress range.

min

integer · int32

The minimum value for the progress range.

phase

string

The current node progress.

unit

string

The unit of measurement for the progress values (e.g., percent, MB).

databaseLabelInformationResponse

Schema representing a label with a key and value.

key

string

The key of the label.

value

string

The value of the label.

databaseBackupResponse

Schema for a backup response.

backup_name

string

The name of the backup.

backup_time

string · date-time

The time the backup was created.

data_size

integer · int32

The size of the backup data in bytes.

databaseServiceComponentResponse

Schema for a service component response.

component

string

The name of the service component.

host

string · hostname

The hostname or IP address of the service component.

port

integer · int32 · min: 0 · max: 65535

The port number of the service component.

route

string

The route to access the service component.

usage

string

The usage of the service component.

ssl

boolean

Indicates if SSL is enabled for the service component.

databaseConnectionPoolResponse

Schema for a connection pool response.

connection_uri

string · uri

The connection URI of the connection pool.

database

string

The database name associated with the connection pool.

pool_mode

string

The mode of the connection pool.

pool_name

string

The name of the connection pool.

Example: pool-2

pool_size

integer · int32

The size of the connection pool.

username

string

The username for the connection pool

databaseUserResponse

Schema for a user response.

username

string

The username of the user.

password

string

The password of the user.

authentication

string

The authentication method used by the user.

type

string

The type of the user.

databasePgAccessControlResponse

Schema for PostgreSQL access control response.

Example: {"allow_replication":true}

databaseRedisAccessControlResponse

Schema for Redis access control response.

Example: {"categories":["@all","@fast"],"channels":["news","updates"],"commands":["GET","SET","DEL"],"keys":["user:*","session:*"]}

databaseValkeyAccessControlResponse

Schema for Valkey user access control response

Example: {"categories":["@all","@fast"],"channels":["news","updates"],"commands":["GET","SET","DEL"],"keys":["user:*","session:*"]}

databaseOpenSearchAccessControlResponse

Schema for OpenSearch access control response.

Example: {"rules":[{"index":"log-*","permission":"read"}]}

databasePgAccessControlResponse

Schema for PostgreSQL access control response.

allow_replication

boolean

If true, allows replication connections.

databaseRedisAccessControlResponse

Schema for Redis access control response.

categories

string[]

List of command categories the user has access to.

channels

string[]

List of Pub/Sub channels the user has access to.

commands

string[]

List of specific commands the user has access to.

keys

string[]

List of key patterns the user has access to.

databaseValkeyAccessControlResponse

Schema for Valkey user access control response

categories

string[]

List of command categories the user has access to.

channels

string[]

List of Pub/Sub channels the user has access to.

commands

string[]

List of specific commands the user has access to.

keys

string[]

List of key patterns the user has access to.

databaseOpenSearchAccessControlResponse

Schema for OpenSearch access control response.

databaseOpenSearchAccessControlRuleResponse[]

databaseOpenSearchAccessControlRuleResponse

Schema for OpenSearch access control rule response.

index

string

Index name or pattern (e.g., 'log-*' for all indices starting with 'log-')

permission

string

Permission level for the specified index

databaseAclResponse

Response schema for an Access Control List (ACL) entry.

id

string · uuid

Unique identifier for the ACL entry.

permission

string

The permission level for the ACL entry.

topic

string

The topic associated with the ACL entry.

username

string

The username associated with the ACL entry.

databaseServiceIntegrationResponse

Schema for a service integration response.

uuid

string · uuid

The UUID of the service integration.

type

string

The type of service integration.

source_name

string

The name of the source service.

source_uuid

string · uuid

The UUID of the source service.

destination_name

string

The name of the destination service.

destination_uuid

string · uuid

The UUID of the destination service.

state

string

The current state of the service integration.

array

A list of errors related to the service integration state.

databaseIntegrationNodeStateResponse[]

The states of individual nodes in the service integration.

object

A map of additional properties for the service integration.

databaseIntegrationNodeStateResponse

Schema for representing the state of an integration node

name

string

The name of the integration node

status

string

The current status of the node

array

A list of errors encountered by the node

likely_error_cause

string | null

The likely cause of the error

Example: some error

databaseNetworksInformationResponse

databaseNetworkInformationDetailsResponse[]

Schema for networks information response

Schema for network information response details

databaseNetworkInformationDetailsResponse

uuid

string · uuid

Unique identifier for the network

name

string

Name of the network

family

string · enum

Address family (e.g., IPv4, IPv6)

Enum values:

IPv4

IPv6

Example: IPv4

type

string · enum

Type of network (e.g., private, public)

Enum values:

private

public

Example: private

create_time

string · date-time

Timestamp when the network was created

update_time

string · date-time

Timestamp when the network was last updated

databaseLabelsResponse

databaseLabelResponse[]

Schema for a list of labels.

Example: [{"key":"environment","value":"production"}]

Schema for deleting a label with a key and value.

databaseLabelResponse

key

string

The key of the label to delete.

value

string

The value of the label to delete.

databaseLabelResponse

Schema for deleting a label with a key and value.

key

string

The key of the label to delete.

value

string

The value of the label to delete.

databaseAvailableExtensionsResponse

object[]

Response schema for listing available PostgreSQL extensions

Example: [{"default_version":"1.12","name":"pg_stat_statements","versions":["1.10","1.11","1.12"]},{"default_version":"3.4.0","name":"postgis","versions":["3.3.0","3.4.0"]},{"default_version":"0.8.1","name":"vector","versions":["0.8.1"]},{"default_version":"1.1","name":"uuid-ossp","versions":["1.1"]}]

default_version

string · required

The default version of the extension

name

string · required

The name of the PostgreSQL extension

versions

string[] · minItems: 1 · required

List of available versions for this extension

databasePGAvailableExtensionsResponse

object[]

Response schema for listing available PostgreSQL extensions grouped by version

Example: [{"version":"16","extensions":[{"default_version":"1.12","name":"pg_stat_statements","versions":["1.10","1.11","1.12"]},{"default_version":"3.4.0","name":"postgis","versions":["3.3.0","3.4.0"]}]},{"version":"15","extensions":[{"default_version":"1.10","name":"pg_stat_statements","versions":["1.9","1.10"]},{"default_version":"3.3.0","name":"postgis","versions":["3.2.0","3.3.0"]}]}]

version

string · required

The PostgreSQL major version

object[] · required

List of available extensions for this PostgreSQL version

databaseVersionsResponse

object[]

Response schema for listing available service versions across all service types

Example: [{"major_version":"8","service_type":"mysql","state":"available","end_of_life_time":null,"availability_end_time":null,"availability_start_time":"2019-05-10T00:00:00Z","termination_time":null,"upgrade_to_service_type":null,"upgrade_to_version":null,"upstream_end_of_life_time":null},{"major_version":"16","service_type":"pg","state":"available","end_of_life_time":"2028-11-09T00:00:00Z","availability_end_time":"2028-05-09T00:00:00Z","availability_start_time":"2024-01-08T00:00:00Z","termination_time":null,"upgrade_to_service_type":null,"upgrade_to_version":null,"upstream_end_of_life_time":"2028-11-09T00:00:00Z"},{"major_version":"2","service_type":"opensearch","state":"available","end_of_life_time":null,"availability_end_time":null,"availability_start_time":"2022-07-12T00:00:00Z","termination_time":null,"upgrade_to_service_type":null,"upgrade_to_version":null,"upstream_end_of_life_time":null}]

major_version

string · required

The major version of the service

service_type

string · enum · required

The type of service (e.g., mysql, pg, opensearch, valkey)

Enum values:

mysql

opensearch

valkey

state

string · enum · required

The availability state of the version

Enum values:

available

preview

end_of_life_time

string | null · date-time

The date when this version reaches end of life

availability_end_time

string | null · date-time

The date when this version will no longer be available for new services

availability_start_time

string | null · date-time

The date when this version became available

termination_time

string | null · date-time

The date when services running this version will be terminated

upgrade_to_service_type

string | null · date-time

The service type to upgrade to when this version reaches end of life

upgrade_to_version

string | null

The version to upgrade to when this version reaches end of life

upstream_end_of_life_time

string | null · date-time

The upstream end of life date for this version

databaseAccessControlSettingsResponse

Response schema for access control settings of a cluster.

access_control

boolean

If true, access control is enabled for the cluster.

extended_access_control

boolean

If true, extended access control features are enabled.

databaseOpenSearchSecurityPluginStatusResponse

OpenSearch security plugin status response

security_plugin_admin_enabled

boolean

Indicates if the security plugin admin is enabled

security_plugin_available

boolean

Indicates if the security plugin is available

security_plugin_enabled

boolean

Indicates if the security plugin is enabled

databaseIntegrationEndpointsResponse

databaseIntegrationEndpointResponse[]

Schema for a list of integration endpoints.

Example: [{"uuid":"20e86f48-2dcd-4a43-843d-3532ab112c1d","name":"rsyslog","type":"rsyslog","properties":{"format":"rfc5424","max_message_size":8192,"port":514,"sd":"","server":"94.237.95.164","tls":false}}]

Schema for an integration endpoint response.

databaseIntegrationEndpointResponse

uuid

string · uuid

The universally unique identifier (UUID) of the integration endpoint.

name

string

The name of the integration endpoint.

type

string

The type of the integration endpoint.

object

A key-value map of properties specific to the integration endpoint type.

Example: {"format":"rfc5424","max_message_size":8192,"port":514,"sd":"","server":"94.237.95.164","tls":false}

databaseIntegrationEndpointResponse

Schema for an integration endpoint response.

uuid

string · uuid

The universally unique identifier (UUID) of the integration endpoint.

name

string

The name of the integration endpoint.

type

string

The type of the integration endpoint.

object

A key-value map of properties specific to the integration endpoint type.

Example: {"format":"rfc5424","max_message_size":8192,"port":514,"sd":"","server":"94.237.95.164","tls":false}

databaseAccountCaResponse

Response schema for account CA

certificate

string

Name of the CA

databaseProjectAlertsResponse

databaseProjectAlertResponse[]

Schema for a project alerts

Schema for a project alert response

databaseProjectAlertResponse

create_time

string · date-time

Timestamp when the alert was created

event

string

Event type for the alert

uuid

string · uuid

Unique identifier for the alert

title

string

Optional title of the alert

service_type

string

Service type related to the alert

severity

string

Severity of the alert

databaseProjectAlertResponse

Schema for a project alert response

create_time

string · date-time

Timestamp when the alert was created

event

string

Event type for the alert

uuid

string · uuid

Unique identifier for the alert

title

string

Optional title of the alert

service_type

string

Service type related to the alert

severity

string

Severity of the alert

databaseServiceStatusResponse

Schema for representing the status of a service instance.

state

string

The service status indicates the service's current operational status.

databaseServiceVersionsResponse

string[]

Schema for representing available service versions

Example: ["12","13","14","15","16"]

databaseUpCloudApiResponse

Schema for UpCloud API error responses.

array

A list of error messages returned by UpCloud's API.

message

string

The time the backup was created.

databaseServiceMigrationStatusResponse

Response schema for service migration status

error

string

Error message if any

method

string

Migration method used

seconds_behind_master

integer · int32

Seconds behind master

source_active

boolean

Is source active

status

string

Current status of the migration

databaseMigrationStatusDetailsResponse[]

databaseMigrationStatusDetailsResponse

Schema for migration status details response.

error

string

Error message if any

dbname

string

Name of the database

method

string

Migration method used

status

string

Current status of the migration

databaseServiceAlertsResponse

databaseServiceAlertResponse[]

Schema for service alerts response

Schema for a service alert

databaseServiceAlertResponse

create_time

string · date-time

The time when the alert was created.

event

string

A brief description of the alert event.

service_type

string

The type of service associated with the alert.

severity

string

The severity level of the alert.

databaseServiceAlertResponse

Schema for a service alert

create_time

string · date-time

The time when the alert was created.

event

string

A brief description of the alert event.

service_type

string

The type of service associated with the alert.

severity

string

The severity level of the alert.

databaseMetricsResponse

Schema for metrics response.

databaseMetricsDataResponse

Schema for metrics data response.

Example: {"cols":[{"label":"time","type":"date"},{"label":"test-1 (master)","type":"number","format":"float"},{"label":"test-2 (standby)","type":"number","format":"float"}],"rows":[["2022-01-21T13:10:30Z",2.744682398273781,3.054323473090861],["2022-01-21T13:11:00Z",3.0735645433218366,2.972423595745795],["2022-01-21T13:11:30Z",2.61619694060839,3.1358378052207883],["2022-01-21T13:12:00Z",3.275132296130991,4.196249043309251]]}

object

Additional hints or metadata about the metric data.

databaseMetricsItemResponse

Schema for a single metrics item response.

databaseMetricsDataResponse

Schema for metrics data response.

object

Additional hints or metadata about the metric data.

databaseMetricsDataResponse

Schema for metrics data response.

databaseMetricsColumnHeaderResponse[]

databaseMetricsRowDataResponse[]

databaseMetricsColumnHeaderResponse

Schema for a metrics column header response.

label

string

The label for the column header.

type

string

The label for the column header.

databaseMetricsRowDataResponse

array

Array of objects representing a row of metrics data - can be any format.

No data returned

databaseQueryStatisticsResponse

Schema for query statistics response.

databaseQueryStatisticsMysqlResponse[]

databaseQueryStatisticsPgResponse[]

databaseQueryStatisticsMysqlResponse

Schema for MySQL query statistics response.

avg_timer_wait

integer · int32

Average wait time for the query.

count_star

integer · int32

Total number of times the query was executed.

digest

string

Query digest hash.

digest_text

string

Normalized query text.

first_seen

string · date-time

Timestamp when the query was first seen.

last_seen

string · date-time

Timestamp when the query was last seen.

max_timer_wait

integer · int32

Maximum wait time for the query.

min_timer_wait

integer · int32

Minimum wait time for the query.

quantile_95

integer · int32

95th percentile wait time.

quantile_99

integer · int32

99th percentile wait time.

quantile_999

integer · int32

99.9th percentile wait time.

query_sample_seen

string · date-time

Timestamp when the sample query was seen.

query_sample_text

string

Sample query text.

query_sample_timer_wait

integer · int32

Wait time for the sample query.

schema_name

string

Name of the database schema.

sum_created_tmp_disk_tables

integer · int32

Total number of temporary disk tables created.

sum_created_tmp_tables

integer · int32

Total number of temporary tables created.

sum_errors

integer · int32

Total number of errors encountered.

sum_lock_time

integer · int32

Total lock time for the query.

sum_no_good_index_used

integer · int32

Total number of times no good index was used.

sum_no_index_used

integer · int32

Total number of times no index was used.

sum_rows_affected

integer · int32

Total number of rows affected.

sum_rows_examined

integer · int32

Total number of rows examined.

sum_rows_sent

integer · int32

Total number of rows sent.

sum_select_full_join

integer · int32

Total number of full joins performed.

sum_select_full_range_join

integer · int32

Total number of full range joins performed.

sum_select_range

integer · int32

Total number of range selects performed.

sum_select_range_check

integer · int32

Total number of range checks performed.

sum_select_scan

integer · int32

Total number of select scans performed.

sum_sort_merge_passes

integer · int32

Total number of sort merge passes.

sum_sort_range

integer · int32

Total number of sort range operations.

sum_sort_rows

integer · int32

Total number of rows sorted.

sum_sort_scan

integer · int32

Total number of sort scans performed.

sum_timer_wait

integer · int32

Total wait time for the query.

sum_warnings

integer · int32

Total number of warnings generated.

databaseQueryStatisticsPgResponse

Schema for PostgreSQL query statistics response.

blk_read_time

integer · int32

Time spent reading data blocks, in milliseconds.

blk_write_time

integer · int32

Time spent writing data blocks, in milliseconds.

calls

integer · int32

Number of times the query was executed.

database_name

string

Name of the database.

local_blks_dirtied

integer · int32

Number of local blocks dirtied.

local_blks_hit

integer · int32

Number of local block cache hits.

local_blks_read

integer · int32

Number of local blocks read.

local_blks_written

integer · int32

Number of local blocks written.

max_time

integer · int32

Maximum execution time, in milliseconds.

mean_time

integer · int32

Mean execution time, in milliseconds.

min_time

integer · int32

Minimum execution time, in milliseconds.

query

string

The SQL query text.

rows

integer · int32

Total number of rows returned or affected.

shared_blks_dirtied

integer · int32

Number of shared blocks dirtied.

shared_blks_hit

integer · int32

Number of shared block cache hits.

shared_blks_read

integer · int32

Number of shared blocks read.

shared_blks_written

integer · int32

Number of shared blocks written.

stddev_time

integer · int32

Standard deviation of execution time, in milliseconds.

temp_blks_read

integer · int32

Number of temporary blocks read.

temp_blks_written

integer · int32

Number of temporary blocks written.

total_time

integer · int32

Total execution time, in milliseconds.

user_name

string

Name of the user who executed the query.

databaseLogListResponse

Schema representing a paginated list of log entries from UpCloud services.

first_log_offset

string

Offset of the first log entry in the list.

offset

string

Current offset for pagination.

databaseLogEntryResponse[]

Array of log entries from UpCloud services.

databaseLogEntryResponse

Schema representing a log entry from an UpCloud service.

hostname

string

The name of the UpCloud service host where the log entry originated.

msg

string

The log message content.

time

string · date-time

Timestamp of the log entry.

service

string

Name of the UpCloud service that generated the log entry.

databaseConnectionPoolsResponse

databaseConnectionPoolResponse[]

An array of connection pool response objects.

Schema for a connection pool response.

databaseConnectionPoolResponse

connection_uri

string · uri

The connection URI of the connection pool.

database

string

The database name associated with the connection pool.

pool_mode

string

The mode of the connection pool.

pool_name

string

The name of the connection pool.

Example: pool-2

pool_size

integer · int32

The size of the connection pool.

username

string

The username for the connection pool

databaseIndexesResponse

databaseIndexResponse[]

Response schema for indexes

Example: [{"create_time":"2023-05-11T13:24:10.623Z","docs":1,"health":"green","index_name":".kibana_1","number_of_replicas":0,"number_of_shards":1,"read_only_allow_delete":false,"size":5313,"status":"open"}]

Schema representing the details of an index.

databaseIndexResponse

create_time

string · date-time

Creation time of the index.

docs

integer · int32

Number of documents in the index.

health

string

Health status of the index.

index_name

string

Name of the index.

number_of_replicas

integer · int32

Number of replicas for the index.

number_of_shards

integer · int32

Number of shards for the index.

read_only_allow_delete

boolean

Indicates if the index is read-only and allows deletion.

size

integer · int32

Size of the index in bytes.

status

string

Status of the index.

databaseIndexResponse

Schema representing the details of an index.

create_time

string · date-time

Creation time of the index.

docs

integer · int32

Number of documents in the index.

health

string

Health status of the index.

index_name

string

Name of the index.

number_of_replicas

integer · int32

Number of replicas for the index.

number_of_shards

integer · int32

Number of shards for the index.

read_only_allow_delete

boolean

Indicates if the index is read-only and allows deletion.

size

integer · int32

Size of the index in bytes.

status

string

Status of the index.

databaseServiceIntegrationsResponse

databaseServiceIntegrationResponse[]

Schema for a list of service integrations

Schema for a service integration response.

databaseServiceIntegrationResponse

uuid

string · uuid

The UUID of the service integration.

type

string

The type of service integration.

source_name

string

The name of the source service.

source_uuid

string · uuid

The UUID of the source service.

destination_name

string

The name of the destination service.

destination_uuid

string · uuid

The UUID of the destination service.

state

string

The current state of the service integration.

array

A list of errors related to the service integration state.

databaseIntegrationNodeStateResponse[]

The states of individual nodes in the service integration.

object

A map of additional properties for the service integration.

databaseServiceNetworkDetailsResponse

Schema for service network details response

create_time

string | null · date-time

The creation time of the service network.

Example: 2023-10-05T14:48:00.000Z

update_time

string | null · date-time

The last update time of the service network.

Example: 2023-10-05T14:48:00.000Z

state

string

The current state of the service network.

Example: active

databasePeeringStatusResponse[]

databasePeeringStatusResponse

Schema for peering status response.

create_time

string · date-time

The time when the peering status was created.

update_time

string · date-time

The time when the peering status was last updated.

network_peer

string · uuid

The UUID of the network peer.

state

string

The current state of the peering connection.

state_info

string

Additional information about the current state of the peering connection.

databaseCurrentSessionsResponse

Schema for representing current sessions for various services

databasePgCurrentSessionResponse[]

databaseMysqlCurrentSessionResponse[]

databaseRedisValkeyCurrentSessionResponse[]

databasePgCurrentSessionResponse

Schema for PostgreSQL current session response.

application_name

string

Name of the application that is connected to this service.

backend_start

string · date-time

Time when this process was started (when the client connected).

backend_type

string

Type of current service (e.g., client backend).

backend_xid

integer · int32

Top-level transaction identifier of this service, if any.

backend_xmin

integer · int32

The current service's xmin horizon.

client_addr

string

IP address of the connected client.

client_hostname

string

Hostname of the connected client (reverse DNS of client_addr).

client_port

integer · int32

TCP port number used by the client, or -1 if a Unix socket is used.

datid

integer · int32

OID of the database this service is connected to.

datname

string

Name of the database this service is connected to.

id

string

Process ID of this service.

query

string

Most recent query. If state is active, this is the currently executing query.

query_duration

string

The active query's current duration (as a string).

query_start

string · date-time

Time when the currently active (or last) query started.

state

string

Overall state of this service (e.g., 'active' or 'idle').

state_change

string · date-time

Time when the state was last changed.

usename

string

Name of the user logged into this service.

usesysid

integer · int32

OID of the user logged into this service.

wait_event

string

Wait event name if the service is currently waiting.

wait_event_type

string

Type of event for which the service is waiting (if any).

xact_start

string · date-time

Time when the current transaction started.

databaseMysqlCurrentSessionResponse

Schema for the current session of a MySQL service.

application_name

string

Name of the application that is connected to this service.

client_addr

string

IP address of the client connected to this service.

datname

string

Name of the database this service is connected to.

id

string

Process ID of this service.

query

string

Text of this service's most recent query. If state is active this shows the currently executing query; otherwise an empty string.

query_duration

integer · int64

The active query’s current duration, serialized as nanoseconds.

state

string

Current overall state of this service. Allowed values include: active (executing a query) and idle (waiting for a new client command).

usename

string

Name of the user logged into this service.

databaseRedisValkeyCurrentSessionResponse

Schema for Redis Valkey current session response.

active_channel_subscriptions

integer · int32

Number of active channel subscriptions.

active_database

integer · int32

Current database ID.

active_pattern_matching_channel_subscriptions

integer · int32

Number of pattern matching subscriptions.

application_name

string

Name of the application that is connected to this service.

client_addr

string

IP address of the client connected to this service.

connection_age

integer · int32

Total duration of the connection in nanoseconds.

connection_idle

integer · int32

Idle time of the connection in nanoseconds.

flags

string[]

List of flags describing the client connection.

flags_raw

string

Client connection flags (raw string).

id

integer · int32

Process ID of this session.

multi_exec_commands

integer · int32

Number of commands in a MULTI/EXEC context.

output_buffer

integer · int32

Output buffer length.

output_buffer_memory

integer · int32

Output buffer memory usage.

output_list_length

integer · int32

Output list length (replies queued when buffer is full).

query

string

The last executed command.

query_buffer

integer · int32

Query buffer length (0 means no query pending).

query_buffer_free

integer · int32

Free space of the query buffer (0 means the buffer is full).

databaseTerminateSessionResponse

Schema for the response received after terminating a session

success

boolean

Indicates whether the session termination was successful.

databaseServiceTaskResponse

Response schema for retrieving information about a service task, including the operation type.

create_time

string · date-time

The time when the service task was created

result

string

Optional result message

object[]

Optional list of result codes as key-value maps

ignore_dbs

string

Optional list of databases to ignore

Example: defaultdb

operation

string

The operation being performed

success

boolean

Indicates if the operation was successful

method

string

Optional method used for the operation

source_pg_version

string

Optional source PostgreSQL version

target_pg_version

string

Optional target PostgreSQL version

id

string · uuid

Optional identifier for the task

databaseServiceTaskBaseResponse

Schema for representing a service task response

create_time

string · date-time

The time when the service task was created

result

string

Optional result message

object[]

Optional list of result codes as key-value maps

ignore_dbs

string

Optional list of databases to ignore

Example: defaultdb

operation

string

The operation being performed

success

boolean

Indicates if the operation was successful

method

string

Optional method used for the operation

source_pg_version

string

Optional source PostgreSQL version

target_pg_version

string

Optional target PostgreSQL version

id

string · uuid

Optional identifier for the task

databaseServiceTaskDetailsResponse

Response schema for retrieving detailed information about a specific service task, including result codes and success status.

create_time

string · date-time

The time when the service task was created

result

string

Optional result message

object[]

Optional list of result codes as key-value maps

ignore_dbs

string

Optional list of databases to ignore

Example: defaultdb

operation

string

The operation being performed

success

boolean

Indicates if the operation was successful

method

string

Optional method used for the operation

source_pg_version

string

Optional source PostgreSQL version

target_pg_version

string

Optional target PostgreSQL version

id

string · uuid

Optional identifier for the task

databaseUsersResponse

databaseUserResponse[]

Schema for the response containing a list of users

Example: [{"username":"admin","password":"my-password","authentication":"caching_sha2_password","type":"admin"}]

Schema for a user response.

databaseUserResponse

username

string

The username of the user.

password

string

The password of the user.

authentication

string

The authentication method used by the user.

type

string

The type of the user.

databasePgAccessControlResponse

Schema for PostgreSQL access control response.

Example: {"allow_replication":true}

databaseRedisAccessControlResponse

Schema for Redis access control response.

Example: {"categories":["@all","@fast"],"channels":["news","updates"],"commands":["GET","SET","DEL"],"keys":["user:*","session:*"]}

databaseValkeyAccessControlResponse

Schema for Valkey user access control response

Example: {"categories":["@all","@fast"],"channels":["news","updates"],"commands":["GET","SET","DEL"],"keys":["user:*","session:*"]}

databaseOpenSearchAccessControlResponse

Schema for OpenSearch access control response.

Example: {"rules":[{"index":"log-*","permission":"read"}]}

gatewayMetricsDetailsResponse

Response schema for Gateway metrics details response.

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the plan

Example: gateway-service

active_connections

integer · int64

Number of active connections

Example: 0

created_at

string · date-time

Timestamp of when the plan was created.

Example: 2025-03-26T12:34:56Z

updated_at

string · date-time

Timestamp of when the plan was last updated.

Example: 2025-03-26T12:34:56Z

total_accepted_connections

integer · int64

Number of accepted connections

Example: 0

total_rejected_sessions

integer · int64

Number of rejected sessions

Example: 0

gatewayQueryParamlimit

integer · int64 · min: 0 · max: 100

Schema for a query parameter specifying the maximum number of entries to return (limit).

Example: 10

Default: 10

gatewayQueryParamOffset

integer · int64 · min: 0

Schema for a query parameter specifying the offset for pagination.

Example: 0

Default: 0

gatewayUuid

string · uuid

The unique identifier for the resource.

Example: 01234567-89ab-cdef-0123-456789abcdef

gatewayLabelKey

string · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E…

The key of a label.

Example: environment

gatewayServiceCreateRequest

Gateway service

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Name of the service

Example: gateway-service

zone

string · pattern: ^[a-z]{2}-[a-z]{3}\d… · required

Zone

Example: fi-hel1

features

gatewayServiceFeatures[] · minItems: 1 · required

Active features

Enum values:

nat

vpn

Example: ["nat"]

gatewayRouterCreateRequest[] · minItems: 1 · maxItems: 1 · required

Service routers

Example: []

configured_status

gatewayServiceConfiguredStatus · enum · required

Service configured status

Enum values:

started

stopped

Example: started

plan

string

Plan

Example: development-gwaas-1c2g

gatewayAddressCreateRequest[]

Service addresses

Example: []

gatewayConnectionCreateRequest[]

Service connections

Example: []

gatewayLabelCreateRequest[] · maxItems: 255

Labels

Example: []

automatic_tunnel_internal_ip_allocation

boolean

Allocate and use tunnel internal IPs automatically

Example: true

gatewayServiceFeatures

string · enum

Enum values:

nat

vpn

Service features

Example: nat

gatewayRouterCreateRequest

Network gateway router

uuid

gatewayUuid · uuid · required

The unique identifier for the resource.

Example: 01234567-89ab-cdef-0123-456789abcdef

gatewayAddressCreateRequest

Address create request

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Name of the address

Example: gateway-service

gatewayConnectionCreateRequest

Network gateway VPN connection

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Name of the connection

Example: gateway-service

type

gatewayConnectionType · enum

Connection type

Enum values:

ipsec

Example: ipsec

Connection local routes

Example: []

gatewayConnectionModifyRequest[]

Connection remote routes

Example: []

gatewayConnectionTunnel[]

Connection tunnels

Example: []

gatewayConnectionType

string · enum

Enum values:

ipsec

Connection type

Example: ipsec

gatewayConnectionRouteRequest

Network gateway VPN connection route

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Route name

Example: gateway-service

type

gatewayConnectionRouteType · enum · required

Connection route type

Enum values:

static

Example: static

static_network

string · required

Static network subnet

Example: 10.0.0.0/24

gatewayConnectionRouteType

string · enum

Enum values:

static

Connection route type

Example: static

gatewayConnectionTunnel

Network gateway VPN connection tunnel

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Name of the tunnel

Example: gateway-service

object

Local peer address

object

Remote peer address

object

IPSec configuration

object

BGP configuration

tunnel_internal_ip

string · maxLength: 64

Tunnel internal IP address, "" if disabled

Example: 10.0.0.1

internal_peer_ping_interval

integer · int64

Internal peer ping inverval in seconds, or zero if disabled

Example: 0

gatewayIpsecAuthenticationType

string · enum

Enum values:

psk

Ipsec authentication type

Example: psk

gatewaySupportedProposalAlgorithms

string · enum

Enum values:

aes128gcm16

aes128gcm128

aes192gcm16

aes192gcm128

aes256gcm16

aes256gcm128

aes128

aes192

List of supported IPsec proposal algorithms

Example: aes128gcm16

gatewaySupportedIntegrityAlgorithms

string · enum

Enum values:

aes128gmac

aes256gmac

sha1

sha256

sha384

sha512

List of supported IPsec integrity algorithms

Example: sha1

gatewayDiffieHellmanGroupNumber

integer · enum · int64

Enum values:

Diffie-Hellman group number

Example: 2

gatewayLabelCreateRequest

Gateway Label

key

gatewayLabelKey · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E… · required

The key of a label.

Example: environment

value

gatewayLabelValue · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p… · required

Schema for a label value property, allowing a string or null with specific character constraints.

Example: production

gatewayLabelValue

string · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p…

Schema for a label value property, allowing a string or null with specific character constraints.

Example: production

gatewayServiceConfiguredStatus

string · enum

Enum values:

started

stopped

Service configured status

Example: started

gatewayServiceReplaceRequest

Request to replace a gateway service

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Name of the service

Example: gateway-service

configured_status

gatewayServiceConfiguredStatus · enum · required

Service configured status

Enum values:

started

stopped

Example: started

plan

string

Plan

Example: development-gwaas-1c2g

connections

Service connections

gatewayLabelCreateRequest[] · maxItems: 255

Labels

Example: []

automatic_tunnel_internal_ip_allocation

boolean

Allocate and use tunnel internal IPs automatically

Example: true

gatewayServiceModifyRequest

Request to modify a gateway service

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the service

Example: gateway-service

features

gatewayServiceFeatures[] · minItems: 1

Active features

Enum values:

nat

vpn

Example: []

plan

string

Plan

Example: development-gwaas-1c2g

configured_status

gatewayServiceConfiguredStatus · enum

Service configured status

Enum values:

started

stopped

Example: started

Service connections

Example: []

gatewayLabelCreateRequest[] · maxItems: 255

Labels

Example: []

automatic_tunnel_internal_ip_allocation

boolean

Allocate and use tunnel internal IPs automatically

Example: true

gatewayConnectionModifyRequest

Network gateway VPN connection

uuid

gatewayUuid · uuid

The unique identifier for the resource.

Example: 01234567-89ab-cdef-0123-456789abcdef

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the connection

Example: gateway-service

type

gatewayConnectionType · enum

Connection type

Enum values:

ipsec

Example: ipsec

Connection local routes

Example: []

gatewayTunnelModifyRequest[]

Connection remote routes

Example: []

Tunnels

Example: []

gatewayTunnelModifyRequest

Request to modify a VPN tunnel

uuid

gatewayUuid · uuid

The unique identifier for the resource.

Example: 01234567-89ab-cdef-0123-456789abcdef

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the tunnel

Example: gateway-service

object

Local peer address

object

Remote peer address

object

IPSec configuration

object

BGP configuration

tunnel_internal_ip

string · maxLength: 64

Tunnel internal IP address, "" if disabled

Example: 10.0.0.1

internal_peer_ping_interval

integer · int64

Internal peer ping inverval in seconds, or zero if disabled

Example: 0

gatewayLabelModifyRequest

Gateway Label

key

gatewayLabelKey · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E…

The key of a label.

Example: environment

value

gatewayLabelValue · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p…

Schema for a label value property, allowing a string or null with specific character constraints.

Example: production

gatewayServiceLogSessionCreateRequest

Request to create a new log session for a service

session_type

gatewayServiceLogSessionTypes · enum · required

Service log session types

Enum values:

vpn

Example: vpn

gatewayServiceLogSessionTypes

string · enum

Enum values:

vpn

Service log session types

Example: vpn

gatewayPlanListResponse

gatewayPlanDetailsResponse[]

Response schema for a list of gwaas plans.

Example: []

Response schema for gwaas plan details.

gatewayPlanDetailsResponse

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the plan

Example: gateway-service

server_number

integer · int64 · min: 1 · max: 8

Number of nodes

Example: 4

per_gateway_max_connections

integer · int64 · min: 10000 · max: 10000000

Per gateway (agent node server) maximum conntrack connections

Example: 5005000

supported_features

gatewayServiceFeatures[] · minItems: 1

Enum values:

nat

vpn

Example: ["vpn"]

vpn_tunnel_amount

integer · int64 · min: 0 · max: 100

Number of VPN tunnels this plan allows.

Example: 50

per_gateway_bandwidth_mbps

integer · int64 · min: 10 · max: 10000

Per gateway (agent node server) bandwidth in megabits per second.

Example: 5005

per_gateway_maximum_vpn_bandwidth_mbps

integer · int64 · min: 10 · max: 10000

Per gateway (agent node server) maximum vpn bandwidth in megabits per second.

Example: 5005

gatewayPlanDetailsResponse

Response schema for gwaas plan details.

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the plan

Example: gateway-service

server_number

integer · int64 · min: 1 · max: 8

Number of nodes

Example: 4

per_gateway_max_connections

integer · int64 · min: 10000 · max: 10000000

Per gateway (agent node server) maximum conntrack connections

Example: 5005000

supported_features

gatewayServiceFeatures[] · minItems: 1

Enum values:

nat

vpn

Example: ["vpn"]

vpn_tunnel_amount

integer · int64 · min: 0 · max: 100

Number of VPN tunnels this plan allows.

Example: 50

per_gateway_bandwidth_mbps

integer · int64 · min: 10 · max: 10000

Per gateway (agent node server) bandwidth in megabits per second.

Example: 5005

per_gateway_maximum_vpn_bandwidth_mbps

integer · int64 · min: 10 · max: 10000

Per gateway (agent node server) maximum vpn bandwidth in megabits per second.

Example: 5005

gatewayErrorResponse

Schema for error responses from the API.

type

string · required

Error code string.

Example: example

title

string · required

Short description of the error.

Example: Validation error.

correlation_id

string · required

Unique identifier for the request, useful for debugging.

Example: 01K1K2TKEASWRJ6VFP9ZV5P2H4

status

integer · int32 · required

HTTP status code associated with the error.

Example: 400

object[]

List of invalid parameters in the request.

Example: []

gatewayServiceListResponse

gatewayServiceDetailsResponse[]

Response schema for a list of gwaas services.

Example: []

Gateway Service

gatewayServiceDetailsResponse

uuid

gatewayUuid · uuid

The unique identifier for the resource.

Example: 01234567-89ab-cdef-0123-456789abcdef

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the service

Example: gateway-service

zone

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Zone of the service

Example: fi-hel1

plan

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Plan

Example: development-gwaas-1c2g

features

gatewayServiceFeatures[] · minItems: 1

Active features

Enum values:

nat

vpn

Example: ["vpn"]

gatewayRouterDetailsResponse

Response containing details of a network gateway router

Example: {"uuid":"01234567-89ab-cdef-0123-456789abcdef","created_at":"2025-03-26T12:34:56Z","updated_at":"2025-03-26T12:34:56Z"}

gatewayAddressDetailsResponse[]

gatewayConnectionDetailsResponse[]

configured_status

gatewayServiceConfiguredStatus · enum

Service configured status

Enum values:

started

stopped

Example: started

operational_state

gatewayServiceOperationalState · enum

Service operational state

Enum values:

pending

setup-agent

setup-link-network

setup-service

setup-network

setup-gw

checkup

setup-dns

Example: pending

automatic_tunnel_internal_ip_allocation

boolean

Allocate and use tunnel internal IPs automatically

Example: true

gatewayLabelDetailsResponse[] · maxItems: 255

Labels

Example: []

created_at

string · date-time

Timestamp of when the service was created.

Example: 2025-03-26T12:34:56Z

updated_at

string · date-time

Timestamp of when the service was last updated.

Example: 2025-03-26T12:34:56Z

gatewayServiceDetailsResponse

Gateway Service

uuid

gatewayUuid · uuid

The unique identifier for the resource.

Example: 01234567-89ab-cdef-0123-456789abcdef

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the service

Example: gateway-service

zone

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Zone of the service

Example: fi-hel1

plan

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Plan

Example: development-gwaas-1c2g

features

gatewayServiceFeatures[] · minItems: 1

Active features

Enum values:

nat

vpn

Example: ["vpn"]

gatewayRouterDetailsResponse

Response containing details of a network gateway router

Example: {"uuid":"01234567-89ab-cdef-0123-456789abcdef","created_at":"2025-03-26T12:34:56Z","updated_at":"2025-03-26T12:34:56Z"}

gatewayAddressDetailsResponse[]

gatewayConnectionDetailsResponse[]

configured_status

gatewayServiceConfiguredStatus · enum

Service configured status

Enum values:

started

stopped

Example: started

operational_state

gatewayServiceOperationalState · enum

Service operational state

Enum values:

pending

setup-agent

setup-link-network

setup-service

setup-network

setup-gw

checkup

setup-dns

Example: pending

automatic_tunnel_internal_ip_allocation

boolean

Allocate and use tunnel internal IPs automatically

Example: true

gatewayLabelDetailsResponse[] · maxItems: 255

Labels

Example: []

created_at

string · date-time

Timestamp of when the service was created.

Example: 2025-03-26T12:34:56Z

updated_at

string · date-time

Timestamp of when the service was last updated.

Example: 2025-03-26T12:34:56Z

gatewayRouterDetailsResponse

Response containing details of a network gateway router

uuid

string · uuid

Router UUID

Example: 01234567-89ab-cdef-0123-456789abcdef

created_at

string · date-time

Timestamp of when the plan was created.

Example: 2025-03-26T12:34:56Z

updated_at

string · date-time

Timestamp of when the plan was last updated.

Example: 2025-03-26T12:34:56Z

gatewayAddressDetailsResponse

Details about a specific address

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the address

Example: gateway-service

address

string · ip-address

VPN address

Example: 203.0.113.10

gatewayConnectionDetailsResponse

Response schema for gwaas connection details.

uuid

gatewayUuid · uuid

The unique identifier for the resource.

Example: 01234567-89ab-cdef-0123-456789abcdef

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the connection

Example: gateway-service

type

gatewayConnectionType · enum

Connection type

Enum values:

ipsec

Example: ipsec

Local routes for the connection

Example: []

gatewayTunnelDetailsResponse[]

Remote routes for the connection

Example: []

created_at

string · date-time

Timestamp of when the connection was created.

Example: 2025-03-26T12:34:56Z

updated_at

string · date-time

Timestamp of when the connection was last updated.

Example: 2025-03-26T12:34:56Z

gatewayConnectionRouteDetailsResponse

Response schema for gwaas connection route details.

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the connection

Example: gateway-service

type

gatewayConnectionRouteType · enum

Connection route type

Enum values:

static

Example: static

static_network

string · ip-network

Static network for the connection route

Example: 10.0.0.0/24

gatewayTunnelDetailsResponse

Response schema for gwaas tunnel details.

uuid

gatewayUuid · uuid

The unique identifier for the resource.

Example: 01234567-89ab-cdef-0123-456789abcdef

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the tunnel

Example: gateway-service

gatewayLocalPeerAddressDetailsResponse

Details about the local peer address for the tunnel

Example: {"name":"gateway-service"}

gatewayRemotePeerAddressDetailsResponse

Details about the remote peer address for the tunnel

Example: {"address":"203.0.113.10"}

gatewayIpsecDetailsResponse

Details about the IPsec configuration

Example: {"ike_lifetime":0,"rekey_time":0,"child_rekey_time":0,"dpd_delay":0,"dpd_timeout":0}

gatewayBgpDetailsResponse

Details about the BGP configuration

Example: {"local_address":"203.0.113.10","local_asn":0,"remote_address":"203.0.113.10","remote_asn":0}

gatewayTunnelInternalIpDetailsResponse

Response schema for gwaas tunnel internal IP details.

Example: {"hasParseError":true}

internal_peer_ping_interval

integer · int64 · min: 0

Internal peer ping interval in seconds

Example: 0

operational_state

gatewayTunnelOperationalState · enum

Tunnel operational state

Enum values:

idle

connecting

established

destroying

unknown

Example: idle

created_at

string · date-time

Timestamp of when the connection was created.

Example: 2025-03-26T12:34:56Z

updated_at

string · date-time

Timestamp of when the connection was last updated.

Example: 2025-03-26T12:34:56Z

tunnel_up

boolean

Indicates whether the tunnel is up

Example: true

tunnel_healthy

boolean

Indicates whether the tunnel is healthy

Example: true

gatewayLocalPeerAddressDetailsResponse

Details about the local peer address for the tunnel

name

string · minLength: 1 · maxLength: 64

Name of the local peer

Example: gateway-service

gatewayRemotePeerAddressDetailsResponse

Details about the remote peer address for the tunnel

address

string · ip-address

Remote peer address

Example: 203.0.113.10

gatewayIpsecDetailsResponse

Details about the IPsec configuration

gatewayAuthenticationDetailsResponse

Authentication details

Example: {"authentication":"psk"}

phase1_algorithms

gatewaySupportedProposalAlgorithms · enum

List of supported IPsec proposal algorithms

Enum values:

aes128gcm16

aes128gcm128

aes192gcm16

aes192gcm128

aes256gcm16

aes256gcm128

aes128

aes192

Example: aes128gcm16

phase2_algorithms

gatewaySupportedProposalAlgorithms · enum

List of supported IPsec proposal algorithms

Enum values:

aes128gcm16

aes128gcm128

aes192gcm16

aes192gcm128

aes256gcm16

aes256gcm128

aes128

aes192

Example: aes128gcm16

phase1_integrity_algorithms

gatewaySupportedIntegrityAlgorithms · enum

List of supported IPsec integrity algorithms

Enum values:

aes128gmac

aes256gmac

sha1

sha256

sha384

sha512

Example: sha1

phase2_integrity_algorithms

gatewaySupportedIntegrityAlgorithms · enum

List of supported IPsec integrity algorithms

Enum values:

aes128gmac

aes256gmac

sha1

sha256

sha384

sha512

Example: sha1

ike_lifetime

integer · int64

IKE lifetime in seconds

Example: 0

rekey_time

integer · int64

Rekey time in seconds

Example: 0

child_rekey_time

integer · int64

Child SA rekey time in seconds

Example: 0

dpd_delay

integer · int64

DPD delay in seconds

Example: 0

dpd_timeout

integer · int64

DPD timeout in seconds

Example: 0

phase1_dh_group_numbers

gatewayDiffieHellmanGroupNumber · enum · int64

Diffie-Hellman group number

Enum values:

Example: 2

phase2_dh_group_numbers

gatewayDiffieHellmanGroupNumber · enum · int64

Diffie-Hellman group number

Enum values:

Example: 2

gatewayAuthenticationDetailsResponse

Authentication details

authentication

gatewayIpsecAuthenticationType · enum

Ipsec authentication type

Enum values:

psk

Example: psk

gatewayBgpDetailsResponse

Details about the BGP configuration

local_address

string

Local BGP address

Example: 203.0.113.10

local_asn

integer · int64

Local BGP ASN

Example: 0

remote_address

string

Remote BGP address

Example: 203.0.113.10

remote_asn

integer · int64

Remote BGP ASN

Example: 0

gatewayTunnelInternalIpDetailsResponse

Response schema for gwaas tunnel internal IP details.

gatewayAddress

hasParseError

boolean

Indicates if there is a parse error with the tunnel internal IP

Example: true

gatewayAddress

addr

integer · int64

Address

Example: 0

gatewayTunnelOperationalState

string · enum

Enum values:

idle

connecting

established

destroying

unknown

Tunnel operational state

Example: idle

gatewayServiceOperationalState

string · enum

Enum values:

pending

setup-agent

setup-link-network

setup-service

setup-network

setup-gw

checkup

setup-dns

Service operational state

Example: pending

gatewayLabelDetailsResponse

UpCloud gateway Label

key

string · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E… · required

Key

Example: environment

value

string · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p… · required

Value

Example: production

gatewayConnectionListResponse

gatewayConnectionDetailsResponse[]

Response schema for a list of gwaas connections.

Example: []

Response schema for gwaas connection details.

gatewayConnectionDetailsResponse

uuid

gatewayUuid · uuid

The unique identifier for the resource.

Example: 01234567-89ab-cdef-0123-456789abcdef

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the connection

Example: gateway-service

type

gatewayConnectionType · enum

Connection type

Enum values:

ipsec

Example: ipsec

Local routes for the connection

Example: []

gatewayTunnelDetailsResponse[]

Remote routes for the connection

Example: []

created_at

string · date-time

Timestamp of when the connection was created.

Example: 2025-03-26T12:34:56Z

updated_at

string · date-time

Timestamp of when the connection was last updated.

Example: 2025-03-26T12:34:56Z

gatewayTunnelListResponse

gatewayTunnelDetailsResponse[]

Response schema for a list of gwaas tunnels.

Example: []

Response schema for gwaas tunnel details.

gatewayTunnelDetailsResponse

uuid

gatewayUuid · uuid

The unique identifier for the resource.

Example: 01234567-89ab-cdef-0123-456789abcdef

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the tunnel

Example: gateway-service

gatewayLocalPeerAddressDetailsResponse

Details about the local peer address for the tunnel

Example: {"name":"gateway-service"}

gatewayRemotePeerAddressDetailsResponse

Details about the remote peer address for the tunnel

Example: {"address":"203.0.113.10"}

gatewayIpsecDetailsResponse

Details about the IPsec configuration

Example: {"ike_lifetime":0,"rekey_time":0,"child_rekey_time":0,"dpd_delay":0,"dpd_timeout":0}

gatewayBgpDetailsResponse

Details about the BGP configuration

Example: {"local_address":"203.0.113.10","local_asn":0,"remote_address":"203.0.113.10","remote_asn":0}

gatewayTunnelInternalIpDetailsResponse

Response schema for gwaas tunnel internal IP details.

Example: {"hasParseError":true}

internal_peer_ping_interval

integer · int64 · min: 0

Internal peer ping interval in seconds

Example: 0

operational_state

gatewayTunnelOperationalState · enum

Tunnel operational state

Enum values:

idle

connecting

established

destroying

unknown

Example: idle

created_at

string · date-time

Timestamp of when the connection was created.

Example: 2025-03-26T12:34:56Z

updated_at

string · date-time

Timestamp of when the connection was last updated.

Example: 2025-03-26T12:34:56Z

tunnel_up

boolean

Indicates whether the tunnel is up

Example: true

tunnel_healthy

boolean

Indicates whether the tunnel is healthy

Example: true

gatewayServiceLabelListResponse

gatewayLabelDetailsResponse[]

Response schema for a list of service labels.

Example: []

UpCloud gateway Label

gatewayLabelDetailsResponse

key

string · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E… · required

Key

Example: environment

value

string · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p… · required

Value

Example: production

gatewayAddressListResponse

gatewayAddressDetailsResponse[]

Response schema for a list of gwaas addresses.

Example: []

Details about a specific address

gatewayAddressDetailsResponse

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the address

Example: gateway-service

address

string · ip-address

VPN address

Example: 203.0.113.10

gatewayServiceMetricsResponse

Response schema for a service metrics.

gatewayMetricsDetailsResponse[]

gatewayIpsecMetricsDetailsResponse

Response schema for IPsec Ike Sa metrics details response.

Example: {"ike_sas":[]}

gatewayIpsecMetricsDetailsResponse

Response schema for IPsec Ike Sa metrics details response.

array | null

List of IKE SAs

Example: []

gatewayIpsecMetricsIkeSaDetailsResponse

Response schema for IPsec metrics ike sa details response.

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the plan

Example: gateway-service

tunnel_id

integer · int64

ID of the tunnel

Example: 0

unique_id

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Unique ID of the IKE SA

Example: gateway-service

version

integer · int64

Version of the IKE SA

Example: 0

operational_state

string · enum

Operational state of the IKE SA

Enum values:

idle

connecting

established

destroying

unknown

Example: idle

internal_state

string · enum

Internal state of the IKE SA

Enum values:

uninitialized

created

connecting

established

passive

rekeying

rekeyed

deleting

Example: uninitialized

initator

boolean

Whether the local gateway is the initiator of the IKE SA

Example: true

established

integer · int64

rekey_time

integer · int64

reauth_time

integer · int64

object[]

local_host

string · ip-address

Local host IP address

Example: 203.0.113.10

remote_host

string · ip-address

Local host IP address

Example: 203.0.113.10

local_id

string · ip-address

Local host IP address

Example: 203.0.113.10

remote_id

string · ip-address

Local host IP address

Example: 203.0.113.10

object

Heuristic state of the IKE SA

created_at

string · date-time

Timestamp of when the plan was created.

Example: 2025-03-26T12:34:56Z

updated_at

string · date-time

Timestamp of when the plan was last updated.

Example: 2025-03-26T12:34:56Z

gatewayServiceLogSessionCreateResponse

Response for creating a new log session for a service

gatewayServiceLogSessionDetailsResponse[] · required

List of service sessions created.

gatewayServiceLogSessionDetailsResponse

Response schema for details of a service log session.

session_id

gatewayUuid · uuid · required

The unique identifier for the resource.

Example: 01234567-89ab-cdef-0123-456789abcdef

token

gatewayUuid · uuid · required

The unique identifier for the resource.

Example: 01234567-89ab-cdef-0123-456789abcdef

loadBalancerLimitParameter

integer · int32 · min: 0 · max: 100

Number of entries to receive at most.

Example: 10

Default: 10

loadBalancerOffsetParameter

integer · int32 · min: 0

Offset for retrieved results.

Example: 0

Default: 0

loadBalancerSortServicesParameter

string · enum

Enum values:

created_at

-created_at

name

-name

uuid

-uuid

Sort services by field. Prefix with '-' for descending order.

Example: -created_at

loadBalancerLabelFilterParameter

string[]

Filter resources by label. Can be provided multiple times for multiple labels. Format: 'key=value' for exact match or 'key' for existence check.

Example: ["env=staging"]

loadBalancerServiceParameter

string · uuid

The UUID of the service.

Example: 01234567-89ab-cdef-0123-456789abcdef

loadBalancerFrontendParameter

string

The name of the frontend.

Example: example-frontend-1

loadBalancerTlsConfigParameter

string

The name of the TLS configuration.

Example: example-tls-config-1

loadBalancerRuleParameter

string

The name of the rule.

Example: example-rule-1

loadBalancerBackendParameter

string

The name of the backend.

Example: backend-infra

loadBalancerMemberParameter

string

The name of the member.

Example: dev-member

loadBalancerNetworkParameter

string

The name of the network.

Example: example-network-1

loadBalancerIpAddressParameter

string

The IP address parameter.

Example: 192.168.1.1

loadBalancerResolverParameter

string

The name of the resolver.

Example: example-resolver-1

loadBalancerLabelParameter

string

The label key parameter.

Example: example-key-1

loadBalancerMetricsSortParameter

string · enum

Enum values:

start_at

-start_at

Sort metrics by field. Prefix with '-' for descending order.

Example: start_at

loadBalancerCertificateBundleParameter

string · uuid

The UUID of the certificate bundle.

Example: 01234567-89ab-cdef-0123-456789abcdef

loadBalancerPlanParameter

string

The name of the plan.

Example: example-plan-1

loadBalancerServiceCreate

Load Balancer Service

name

string · minLength: 1 · maxLength: 64 · required

Name of the service

zone

string · pattern: ^[a-z]{2}-[a-z]{3}\d… · required

Zone

plan

string · required

Plan

configured_status

loadBalancerServiceConfiguredStatus · enum · required

Service configured status

Enum values:

started

stopped

loadBalancerFrontendCreate[] · required

Service frontends

Example: []

loadBalancerBackendCreate[]

Service backends

Example: []

loadBalancerResolverCreate[]

Service resolvers

Example: []

network_uuid

string · uuid

Private Network UUID

loadBalancerNetworkCreate[]

Service networks

Example: []

loadBalancerLabelCreate[] · maxItems: 255

Labels

Example: []

maintenance_dow

loadBalancerMaintenanceDayOfWeek · enum

Day of week

Enum values:

sunday

monday

tuesday

wednesday

thursday

friday

saturday

maintenance_time

loadBalancerMaintenanceTime · pattern: ^(0[0-9]|1[0-9]|2[0-…

Maintenance time

loadBalancerIpAddressCreate[]

List of IP addresses for the network

Example: []

loadBalancerServiceConfiguredStatus

string · enum

Enum values:

started

stopped

Service configured status

loadBalancerFrontendCreate

Load Balancer Frontend

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Name of the frontend

port

integer · int32 · min: 1 · max: 65535 · required

Port to listen

mode

loadBalancerFrontendMode · enum · required

Mode

Enum values:

http

tcp

default_backend

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Default backend

loadBalancerFrontendNetworkCreate[]

Network names

array | null

TLS Configs

array | null

Rules

loadBalancerFrontendPropertiesCreate

Frontend Properties

loadBalancerFrontendMode

string · enum

Enum values:

http

tcp

Mode

loadBalancerFrontendNetworkCreate

Load Balancer Network

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Name of the Network

loadBalancerTlsConfigCreate

Load Balancer TLS Config

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Name of the config

certificate_bundle_uuid

string · uuid · required

Certificate Bundle UUID

loadBalancerRuleCreate

Load Balancer Forwarding Rule

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Name of the rule

priority

integer · int32 · min: 0 · max: 100 · required

Priority

matchers

array | null · maxItems: 40 · required

Rule matchers

Example: []

loadBalancerActionCreate[] · minItems: 1 · maxItems: 40 · required

Rule actions

Example: [{"type":"use_backend","action_use_backend":{"backend":"backend-1"}}]

matching_condition

loadBalancerMatchingCondition · enum

Defines how multiple matching criteria are combined to evaluate a condition.

Enum values:

and

Example: and

loadBalancerMatchingCondition

string · enum

Enum values:

and

Defines how multiple matching criteria are combined to evaluate a condition.

Example: and

loadBalancerMatcherCreate

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	requires: type, match_src_ip
	requires: type, match_src_port
	requires: type, match_body_size
	requires: type, match_cookie
	requires: type, match_header
	requires: type, match_url_param
	requires: type, match_http_method
	requires: type, match_path
	requires: type, match_url
	requires: type, match_host
	requires: type, match_url_query
	requires: type, match_num_members_up
	requires: type, match_request_header
	requires: type, match_response_header
	requires: type, match_http_status

Properties for Variant 1:

type

const · required

Const value: src_ip

loadBalancerMatcherIpCreate · required

Forwarding rule IP matcher for matching source IP addresses. Accepts IPv4, IPv6 addresses or CIDR notation.

inverse

boolean

Inverse rule

loadBalancerMatcherIpCreate

Forwarding rule IP matcher for matching source IP addresses. Accepts IPv4, IPv6 addresses or CIDR notation.

value

string · required

IP address or CIDR to match against. Accepts IPv4 (e.g., 192.168.1.1), IPv6 (e.g., 2001:db8::1), or CIDR notation (e.g., 192.168.1.0/24).

loadBalancerMatcherIntCreate

Forwarding rule integer matcher

method

loadBalancerRuleMatcherIntMethod · enum · required

Method

Enum values:

range

equal

greater_or_equal

greater

less_or_equal

less

value

integer · int32

Value

range_start

integer · int32

Value

range_end

integer · int32

Value

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	requires: method, range_start, range_end
	requires: method, value

Properties for Range matcher:

value

null

loadBalancerRuleMatcherIntMethod

string · enum

Enum values:

range

equal

greater_or_equal

greater

less_or_equal

less

Method

loadBalancerMatcherStringArgCreate

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	requires: method, name, value
	requires: method, name

Properties for Variant 1:

method

loadBalancerStringMatcherMethods · enum · required

String matcher methods

Enum values:

exact

substring

regexp

starts

ends

domain

Example: exact

name

string · required

Name of the parameter

value

string · required

Value

ignore_case

boolean

Ignore case

loadBalancerStringMatcherMethods

string · enum

Enum values:

exact

substring

regexp

starts

ends

domain

String matcher methods

Example: exact

loadBalancerStringMatcherMethodsNoValue

string · enum

Enum values:

exists

String matcher methods (no value)

Example: exists

loadBalancerMatcherHttpMethodCreate

Forwarding rule HTTP method matcher

value

loadBalancerHttpMethods · enum · required

HTTP methods

Enum values:

GET

HEAD

POST

PUT

PATCH

DELETE

CONNECT

OPTIONS

loadBalancerHttpMethods

string · enum

Enum values:

GET

HEAD

POST

PUT

PATCH

DELETE

CONNECT

OPTIONS

HTTP methods

loadBalancerMatcherStringCreate

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	requires: method, value
	requires: method

Properties for Variant 1:

method

loadBalancerStringMatcherMethods · enum · required

String matcher methods

Enum values:

exact

substring

regexp

starts

ends

domain

Example: exact

value

string · required

Value

ignore_case

boolean

Ignore case

loadBalancerMatcherHostCreate

Forwarding rule host matcher

value

string · hostname · required

Value

loadBalancerMatcherBackendCreate

Forwarding rule backend matcher

backend

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the backend

method

loadBalancerRuleMatcherIntMethod · enum

Method

Enum values:

range

equal

greater_or_equal

greater

less_or_equal

less

value

integer · int32 · min: 0 · max: 100

Value

range_start

integer · int32 · min: 0 · max: 100

Value

range_end

integer · int32 · min: 0 · max: 100

Value

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	requires: backend, method, range_start +1 more
	requires: backend, method, value

Properties for Range matcher:

value

null

loadBalancerActionCreate

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	requires: type, action_use_backend
	requires: type, action_http_return
	requires: type, action_http_redirect
	requires: type, action_tcp_reject
	requires: type, action_set_forwarded_headers
	requires: type, action_set_request_header
	requires: type, action_set_response_header
	requires: type, action_http_rewrite_path
	requires: type, action_http_rewrite_uri

Properties for Variant 1:

type

const · required

Const value: use_backend

loadBalancerActionUseBackendCreate · required

Forwarding rule use backend action

Example: {"backend":"backend-1"}

loadBalancerActionUseBackendCreate

Forwarding rule use backend action

backend

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Name of the backend

loadBalancerActionHttpReturnCreate

Forwarding rule HTTP Return action

status

integer · int32 · min: 100 · max: 599 · required

HTTP Status code

content_type

loadBalancerContentTypes · enum · required

Content types

Enum values:

text/plain

text/html

application/javascript

application/json

payload

string · base64 · minLength: 1 · maxLength: 4096 · required

Response body content to return to the client.

loadBalancerContentTypes

string · enum

Enum values:

text/plain

text/html

application/javascript

application/json

Content types

loadBalancerActionHttpRedirectCreate

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: location
	type = object · requires: scheme

Properties for Variant 1:

location

string · uri-reference · minLength: 1 · maxLength: 255 · required

Value

status

integer · enum · int32

HTTP Status code

Enum values:

301

302

303

307

308

loadBalancerActionTcpRejectCreate

Forwarding rule TCP reject action

loadBalancerActionSetForwardedHeaders

Forwarding rule Set forwarded headers

loadBalancerActionSetHeaderCreate

Forwarding rule HTTP set header action

header

string · minLength: 1 · maxLength: 256 · required

Name of the HTTP header to set or modify in the request or response.

value

string · maxLength: 256

Value to assign to the specified HTTP header.

loadBalancerActionHttpRewritePathCreate

Rewrite HTTP request path using regex pattern

match_pattern

string · required

Regex pattern to match against the path. Use empty string "" to match the entire path (defaults to ^(.*)$)

Example: ^(.*/)$

rewrite_to

string · minLength: 1 · required

Replacement pattern (can use capture groups like \1 if match_pattern is provided)

Example: \1index.html

loadBalancerActionHttpRewriteUriCreate

Rewrite HTTP request URI using regex pattern

match_pattern

string · required

Regex pattern to match against the full URI. Use empty string "" to match the entire URI (defaults to ^(.*)$)

Example: ^(.*)\?(.*)$

rewrite_to

string · minLength: 1 · required

Replacement pattern (can use capture groups like \1 if match_pattern is provided)

Example: /v2/\1

loadBalancerFrontendPropertiesCreate

Frontend Properties

timeout_client

integer · int32 · min: 1 · max: 86400

Client timeout

inbound_proxy_protocol

boolean

Enable or disable inbound proxy protocol support

http2_enabled

boolean

Allows for HTTP2 connection via ALPN

loadBalancerBackendCreate

Load Balancer Backend

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Name of the backend

array | null · required

Backend members

array | null

TLS Configs

Resolver reference

loadBalancerBackendPropertiesCreate

Backend Properties

loadBalancerMemberCreate

Load Balancer backend member

name

string · domainname

Name of the member

server_uuid

string · uuid

Target server UUID

weight

integer · int32 · min: 0 · max: 100

Target weight

Example: 100

max_sessions

integer · int32 · min: 0 · max: 500000

Maximum number of sessions before queueing

Example: 1000

type

loadBalancerMemberType · enum

Member type

Enum values:

static

dynamic

Example: dynamic

enabled

boolean

Is member enabled

backup

boolean

Is backup member

ip

string | null

IP address of the backend member server. Depending on the member type, this can be an IPv4 address, IPv6 address, or a domain name for dynamic members.

port

integer | null

Port number on which the backend member server listens.

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	requires: name, ip, port +4 more
	requires: name, weight, max_sessions +2 more

Properties for Static member:

type

const · required

Const value: static

string · ip · required

Target IP address (IPv4 or IPv6)

port

integer · int32 · min: 1 · max: 65535 · required

Target Port

loadBalancerMemberType

string · enum

Enum values:

static

dynamic

Member type

Example: dynamic

loadBalancerBackendPropertiesCreate

Backend Properties

timeout_server

integer · int32 · min: 1 · max: 2145600

Server timeout

timeout_tunnel

integer · int32 · min: 1 · max: 2145600

Tunnel timeout

outbound_proxy_protocol

loadBalancerProxyProtocolVersionOrDisabled · enum

Empty string means disabled

Enum values:

health_check_type

loadBalancerHealthCheckType · enum

Health check type

Enum values:

tcp

http

health_check_interval

integer · int32 · min: 1 · max: 86400

Interval between health checks

health_check_fall

integer · int32 · min: 1 · max: 100

Sets how many failed health checks are allowed

health_check_rise

integer · int32 · min: 1 · max: 100

Sets how many passing checks there must be before returning server to the rotation

health_check_url

string · minLength: 1 · maxLength: 255

Target url for health check HTTP GET requests

health_check_expected_status

integer · int32 · min: 100 · max: 599

Expected HTTP status code returned by the customer application to mark server as healthy

health_check_on_down

loadBalancerChecksOnDown · enum

Checks on down category

Enum values:

shutdown-sessions

health_check_tls_verify

boolean

Allows health check CA verification on TLS connections

sticky_session_cookie_name

string | null · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]*$

Sets sticky session cookie name. Empty string disables sticky session.

Controls additional cookie attributes appended to sticky session cookies. Supports combinations of: SameSite=Strict|Lax|None, Secure, HttpOnly, Partitioned (semicolon-separated). Note: SameSite=None and Partitioned require Secure.

tls_enabled

boolean

Enables TLS between LB backend and member servers

tls_verify

boolean

Enables CA verification on TLS backend connections

tls_use_system_ca

boolean

Force Load Balancer to verify member certificates against system CA bundle

http2_enabled

boolean

Allows for HTTP2 connection via ALPN

loadBalancerProxyProtocolVersionOrDisabled

string | null · enum

Enum values:

Empty string means disabled

loadBalancerHealthCheckType

string · enum

Enum values:

tcp

http

Health check type

loadBalancerChecksOnDown

string · enum

Enum values:

shutdown-sessions

Checks on down category

loadBalancerResolverCreate

Load Balancer Resolver

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Name of the resolver

nameservers

string[] · minItems: 1 · maxItems: 10 · required

Nameservers

retries

integer · int32 · min: 1 · max: 10 · required

Number of retries on failure

timeout

integer · int32 · min: 1 · max: 60 · required

Timeout for the query in seconds

timeout_retry

integer · int32 · min: 1 · max: 60 · required

Timeout for the query retries in seconds

cache_valid

integer · int32 · min: 1 · max: 86400 · required

Time in seconds to cache valid results

cache_invalid

integer · int32 · min: 1 · max: 86400 · required

Time in seconds to cache invalid results

loadBalancerNetworkCreate

Load Balancer Network.

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Name of the network

type

loadBalancerNetworkType · enum · required

Network type

Enum values:

public

private

family

loadBalancerNetworkFamily · enum · required

Network family

Enum values:

IPv4

IPv6

uuid

string · uuid

Network UUID

loadBalancerNetworkType

string · enum

Enum values:

public

private

Network type

loadBalancerNetworkFamily

string · enum

Enum values:

IPv4

IPv6

Network family

loadBalancerLabelCreate

Load Balancer Label

key

string · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E… · required

Key

value

string | null · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p… · required

Value

loadBalancerMaintenanceDayOfWeek

string · enum

Enum values:

sunday

monday

tuesday

wednesday

thursday

friday

saturday

Day of week

loadBalancerMaintenanceTime

string · pattern: ^(0[0-9]|1[0-9]|2[0-…

Maintenance time

loadBalancerIpAddressCreate

IP address object

address

string · ipv4 · required

IP address

network_name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the target network

loadBalancerServiceReplace

Load Balancer Service.

name

string · minLength: 1 · maxLength: 64 · required

Name of the service

Example: my-loadbalancer

plan

string · required

Plan

Example: production

configured_status

loadBalancerServiceConfiguredStatus · enum · required

Service configured status

Enum values:

started

stopped

loadBalancerFrontendCreate[]

Service frontends

loadBalancerBackendCreate[]

Service backends

loadBalancerResolverCreate[]

Service resolvers

loadBalancerLabelCreate[] · maxItems: 255

Labels

maintenance_dow

loadBalancerMaintenanceDayOfWeek · enum

Day of week

Enum values:

sunday

monday

tuesday

wednesday

thursday

friday

saturday

maintenance_time

loadBalancerMaintenanceTime · pattern: ^(0[0-9]|1[0-9]|2[0-…

Maintenance time

loadBalancerIpAddressCreate[]

List of IP addresses for the network

loadBalancerServiceModify

Load Balancer Service

name

string · minLength: 1 · maxLength: 64

Name of the service

plan

string

Plan

configured_status

loadBalancerServiceConfiguredStatus · enum

Service configured status

Enum values:

started

stopped

array | null

Service frontends

array | null

Service backends

array | null

Service resolvers

array | null · maxItems: 255

Labels

maintenance_dow

loadBalancerMaintenanceDayOfWeek · enum

Day of week

Enum values:

sunday

monday

tuesday

wednesday

thursday

friday

saturday

maintenance_time

loadBalancerMaintenanceTime · pattern: ^(0[0-9]|1[0-9]|2[0-…

Maintenance time

loadBalancerIpAddressCreate[]

List of IP addresses for the network

loadBalancerFrontendModify

Load Balancer Frontend

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the frontend

port

integer · int32 · min: 1 · max: 65535

Port to listen

mode

loadBalancerFrontendMode · enum

Mode

Enum values:

http

tcp

default_backend

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Default backend

loadBalancerFrontendPropertiesCreate

Frontend Properties

loadBalancerFrontendNetworkCreate[]

Network names

array | null

TLS Configs

array | null

Rules

loadBalancerTlsConfigModify

Load Balancer TLS Config

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the config

certificate_bundle_uuid

string · uuid

Certificate Bundle UUID

loadBalancerRuleModify

Load Balancer Forwarding Rule

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the rule

priority

integer · int32 · min: 0 · max: 100

Priority

matching_condition

loadBalancerMatchingCondition · enum

Defines how multiple matching criteria are combined to evaluate a condition.

Enum values:

and

Example: and

matchers

array | null · maxItems: 40

Rule matchers

loadBalancerActionCreate[] · minItems: 1 · maxItems: 40

Rule actions

loadBalancerBackendModify

Load Balancer Backend

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the backend

array | null

Backend members

array | null

TLS Configs

Resolver reference

loadBalancerBackendPropertiesCreate

Backend Properties

loadBalancerMemberModify

Load Balancer backend member

name

string · domainname

Name of the member

server_uuid

string · uuid

Target server UUID

weight

integer · int32 · min: 0 · max: 100

Target weight

max_sessions

integer · int32 · min: 0 · max: 500000

Maximum number of sessions before queueing

type

loadBalancerMemberType · enum

Member type

Enum values:

static

dynamic

Example: dynamic

enabled

boolean

Is member enabled

backup

boolean

Is backup member

ip

string | null

IP address of the backend member server. Depending on the member type, this can be an IPv4 address, IPv6 address, or a domain name for dynamic members.

port

integer | null

Port number on which the backend member server listens.

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	No specific criteria
	requires: type

Properties for Static member:

type

const

Const value: static

string · ip

Target IP address (IPv4 or IPv6)

port

integer · int32 · min: 1 · max: 65535

Target Port

loadBalancerNetworkModify

Load Balancer Network

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the network

loadBalancerResolverModify

Load Balancer Resolver

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the resolver

nameservers

string[] · minItems: 1 · maxItems: 10

Nameservers

retries

integer · int32 · min: 1 · max: 10

Number of retries on failure

timeout

integer · int32 · min: 1 · max: 60

Timeout for the query in seconds

timeout_retry

integer · int32 · min: 1 · max: 60

Timeout for the query retries in seconds

cache_valid

integer · int32 · min: 1 · max: 86400

Time in seconds to cache valid results

cache_invalid

integer · int32 · min: 1 · max: 86400

Time in seconds to cache invalid results

loadBalancerLabelModify

Load Balancer Label

key

string · minLength: 2 · maxLength: 32 · pattern: ^[\x20-\x5E\x60-\x7E…

Key

value

string | null · maxLength: 255 · pattern: \A[\p{L}\p{N}\p{P}\p…

Value

loadBalancerCertificateBundleCreate

Load Balancer certificate bundle

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$ · required

Name of the bundle

type

string · enum · required

Certificate bundle type

Enum values:

manual

dynamic

authority

hostnames

string[] · minItems: 1 · maxItems: 100

Array of hostnames

certificate

string | null · certificate

Certificate

intermediates

string | null · multiple-certificates

Intermediate certificates

private_key

string | null · private-key

Private key

challenge_key

string · minLength: 1 · maxLength: 64

Unique key used for ACME DNS challenge validation when obtaining certificates dynamically.

key_type

string · enum

Private key type

Enum values:

rsa

ecdsa

loadBalancerLabelCreate[] · maxItems: 255

Labels

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	requires: name, type, certificate +1 more
	requires: name, type, hostnames +1 more
	requires: name, type, certificate

Properties for Manual bundle:

type

const · required

Const value: manual

hostnames

null

key_type

null

loadBalancerCertificateBundleModify

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object
	type = object

Properties for Certificate Bundle Manual Modify:

Load Balancer certificate bundle manual type

loadBalancerCertificateBundleManualModify

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the bundle

certificate

string | null · certificate

Certificate

intermediates

string | null · multiple-certificates

Intermediate certificates

private_key

string | null · private-key

Private key

loadBalancerLabelCreate[] · maxItems: 255

Labels

loadBalancerCertificateBundleManualModify

Load Balancer certificate bundle manual type

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the bundle

certificate

string | null · certificate

Certificate

intermediates

string | null · multiple-certificates

Intermediate certificates

private_key

string | null · private-key

Private key

loadBalancerLabelCreate[] · maxItems: 255

Labels

loadBalancerCertificateBundleDynamicModify

Load Balancer certificate bundle dynamic type

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the bundle

hostnames

string[] · minItems: 1 · maxItems: 1000

Array of hostnames

loadBalancerLabelCreate[] · maxItems: 255

Labels

challenge_key

string · minLength: 1 · maxLength: 64

Unique key used for ACME DNS challenge validation when obtaining certificates dynamically.

loadBalancerCertificateBundleAuthorityModify

Load Balancer certificate bundle dynamic type

name

string · minLength: 1 · maxLength: 64 · pattern: ^[a-zA-Z0-9_-]+$

Name of the bundle

certificate

string · certificate

Certificate

loadBalancerLabelCreate[] · maxItems: 255

Labels

loadBalancerServicesResponse

loadBalancerService[]

Response schema for a list of services.

Represents a load balancer service instance that groups together frontends, backends, and related agents. It defines the service plan, network configuration, and operational state across all nodes.

loadBalancerService

uuid

string · uuid · required

Unique identifier of the service.

name

string · required

Human-readable name assigned to the service.

zone

string · required

UpCloud zone where the service is deployed.

plan

string · required

Selected load balancer plan defining node size, performance, and pricing tier.

configured_status

string · required

Configuration status of the service (e.g., whether all components are correctly provisioned).

created_at

string · date-time · required

Timestamp when the service was created.

Example: 2025-11-06T08:00:00.000Z

updated_at

string · date-time · required

Timestamp when the service was last updated.

Example: 2025-11-06T09:15:00.000Z

operational_state

string · enum

Current operational state of the service, describing its runtime behavior and availability.

Enum values:

pending

running

failing

stopped

degraded

loadBalancerFrontend[]

List of frontend configurations associated with the service.

Example: []

loadBalancerBackend[]

List of backend configurations linked to this service.

Example: []

loadBalancerResolver[]

DNS resolvers available for this service.

Example: []

loadBalancerNetwork[]

Networks attached to this service.

Example: []

loadBalancerIpAddress[]

IP addresses assigned to this service.

Example: []

Labels associated with the service for metadata tagging and identification.

Example: []

maintenance_dow

string · enum

Day of week scheduled for maintenance operations.

Enum values:

monday

tuesday

wednesday

thursday

friday

saturday

sunday

maintenance_time

string · time

Time of day (in UTC) scheduled for maintenance operations.

Example: 2025-11-06T08:00:00.000Z

network_uuid

string

Deprecated: old field replaced by the networks array.

dns_name

string

Deprecated: legacy DNS field replaced by service-level IP addressing.

loadBalancerService

Represents a load balancer service instance that groups together frontends, backends, and related agents. It defines the service plan, network configuration, and operational state across all nodes.

uuid

string · uuid · required

Unique identifier of the service.

name

string · required

Human-readable name assigned to the service.

zone

string · required

UpCloud zone where the service is deployed.

plan

string · required

Selected load balancer plan defining node size, performance, and pricing tier.

configured_status

string · required

Configuration status of the service (e.g., whether all components are correctly provisioned).

created_at

string · date-time · required

Timestamp when the service was created.

Example: 2025-11-06T08:00:00.000Z

updated_at

string · date-time · required

Timestamp when the service was last updated.

Example: 2025-11-06T09:15:00.000Z

operational_state

string · enum

Current operational state of the service, describing its runtime behavior and availability.

Enum values:

pending

running

failing

stopped

degraded

loadBalancerFrontend[]

List of frontend configurations associated with the service.

Example: []

loadBalancerBackend[]

List of backend configurations linked to this service.

Example: []

loadBalancerResolver[]

DNS resolvers available for this service.

Example: []

loadBalancerNetwork[]

Networks attached to this service.

Example: []

loadBalancerIpAddress[]

IP addresses assigned to this service.

Example: []

Labels associated with the service for metadata tagging and identification.

Example: []

maintenance_dow

string · enum

Day of week scheduled for maintenance operations.

Enum values:

monday

tuesday

wednesday

thursday

friday

saturday

sunday

maintenance_time

string · time

Time of day (in UTC) scheduled for maintenance operations.

Example: 2025-11-06T08:00:00.000Z

network_uuid

string

Deprecated: old field replaced by the networks array.

dns_name

string

Deprecated: legacy DNS field replaced by service-level IP addressing.

loadBalancerFrontend

Represents a frontend configuration in the load balancer service, defining how client connections are received, the listening port and protocol, TLS settings, routing rules, and default backend association.

name

string · required

Human-readable name assigned to the frontend.

port

integer · int32 · required

Port number on which the frontend listens for incoming connections.

mode

string · enum · required

Operating mode defining the protocol layer at which the frontend operates.

Enum values:

http

tcp

default_backend

string · required

Name of the backend used when no routing rules match the incoming request.

loadBalancerTlsConfig[] · required

Represents a list of TLS configuration for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.

loadBalancerRule[] · required

Represents a list of load balancer rules that define how incoming requests are matched and processed, including conditions, actions, and backend target associations.

loadBalancerFrontendPropertiesResponse · required

Defines configurable properties for a frontend, such as client timeout settings, protocol options, and linkage to its parent frontend resource.

object[] · required

created_at

string · date-time · required

Timestamp when the frontend was created (RFC 3339 format).

Example: 2025-11-06T09:00:00.000Z

updated_at

string · date-time · required

Timestamp when the frontend was last updated (RFC 3339 format).

Example: 2025-12-06T09:00:00.000Z

loadBalancerTlsConfigsResponse

loadBalancerMatchIpResponse

Represents a list of TLS configuration for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.

Represents a TLS configuration for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.

loadBalancerTlsConfig

name

string · required

Human-readable name assigned to the TLS configuration.

certificate_bundle_uuid

string · uuid · required

UUID of the certificate bundle used for TLS encryption.

created_at

string · date-time · required

Timestamp when the TLS configuration was created (RFC 3339 format).

Example: 2025-11-06T10:15:00.000Z

updated_at

string · date-time · required

Timestamp when the TLS configuration was last updated (RFC 3339 format).

Example: 2025-11-06T11:00:00.000Z

loadBalancerTlsConfig

Represents a TLS configuration for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.

name

string · required

Human-readable name assigned to the TLS configuration.

certificate_bundle_uuid

string · uuid · required

UUID of the certificate bundle used for TLS encryption.

created_at

string · date-time · required

Timestamp when the TLS configuration was created (RFC 3339 format).

Example: 2025-11-06T10:15:00.000Z

updated_at

string · date-time · required

Timestamp when the TLS configuration was last updated (RFC 3339 format).

Example: 2025-11-06T11:00:00.000Z

loadBalancerRulesResponse

loadBalancerRule[]

Represents a list of load balancer rules that define how incoming requests are matched and processed, including conditions, actions, and backend target associations.

Represents a load balancer rule that defines how incoming traffic is matched and processed by a frontend, including priority, matching conditions, and actions to perform.

loadBalancerRule

name

string · required

Human-readable name assigned to the routing rule.

priority

integer · int32 · required

Priority order for rule evaluation, where lower values indicate higher priority.

matching_condition

string · enum · required

Logical operator determining how multiple matchers are combined (and/or).

Enum values:

and

loadBalancerMatcherResponse[] · required

List of conditions that incoming requests must satisfy for this rule to apply.

loadBalancerActionResponse[] · required

List of actions to execute when the rule matches an incoming request.

created_at

string · date-time · required

Timestamp when the rule was created (RFC 3339 format).

Example: 2025-11-06T09:00:00.000Z

updated_at

string · date-time · required

Timestamp when the rule was last updated (RFC 3339 format).

Example: 2025-12-06T09:00:00.000Z

loadBalancerRule

Represents a load balancer rule that defines how incoming traffic is matched and processed by a frontend, including priority, matching conditions, and actions to perform.

name

string · required

Human-readable name assigned to the routing rule.

priority

integer · int32 · required

Priority order for rule evaluation, where lower values indicate higher priority.

matching_condition

string · enum · required

Logical operator determining how multiple matchers are combined (and/or).

Enum values:

and

loadBalancerMatcherResponse[] · required

List of conditions that incoming requests must satisfy for this rule to apply.

loadBalancerActionResponse[] · required

List of actions to execute when the rule matches an incoming request.

created_at

string · date-time · required

Timestamp when the rule was created (RFC 3339 format).

Example: 2025-11-06T09:00:00.000Z

updated_at

string · date-time · required

Timestamp when the rule was last updated (RFC 3339 format).

Example: 2025-12-06T09:00:00.000Z

loadBalancerMatcherResponse

Defines a matcher used to evaluate specific conditions in requests or responses.

type

string · enum · required

Type of matcher defining which aspect of the request or response to evaluate.

Enum values:

src_ip

src_port

body_size

header

url_param

request_header

response_header

inverse

boolean · required

Indicates whether to invert the match result (true) or use it as-is (false).

Defines a match condition based on the source IP address or subnet. Used when the matcher type is 'src_ip'.

loadBalancerMatchIntResponse

Defines integer matching criteria for requests or responses.

loadBalancerMatchIntResponse

Defines integer matching criteria for requests or responses.

Extends MatchString with an additional 'name' parameter, used for matchers that require a key-value pair (e.g., matching headers, cookies, or URL parameters).

Extends MatchString with an additional 'name' parameter, used for matchers that require a key-value pair (e.g., matching headers, cookies, or URL parameters).

Extends MatchString with an additional 'name' parameter, used for matchers that require a key-value pair (e.g., matching headers, cookies, or URL parameters).

Extends MatchString with an additional 'name' parameter, used for matchers that require a key-value pair (e.g., matching headers, cookies, or URL parameters).

loadBalancerMatchIntResponse

Extends MatchString with an additional 'name' parameter, used for matchers that require a key-value pair (e.g., matching headers, cookies, or URL parameters).

Defines integer matching criteria for requests or responses.

Defines a string-based match condition, used for matching values such as paths, headers, URLs, or hostnames.

Defines a string-based match condition, used for matching values such as paths, headers, URLs, or hostnames.

Defines a string-based match condition, used for matching values such as paths, headers, URLs, or hostnames.

Defines a string-based match condition, used for matching values such as paths, headers, URLs, or hostnames.

loadBalancerMatchBackendResponse

Defines a string-based match condition, used for matching values such as paths, headers, URLs, or hostnames.

Defines a backend health matcher used to compare the number of healthy (up) members in a specific backend against a threshold value. Used when the matcher type is 'num_members_up'.

loadBalancerMatchIpResponse

Defines a match condition based on the source IP address or subnet. Used when the matcher type is 'src_ip'.

value

string · required

IP address or CIDR subnet to match against the source IP. Accepts IPv4, IPv6, or CIDR notation.

loadBalancerMatchIntResponse

Defines integer matching criteria for requests or responses.

method

string · enum · required

Comparison method used to evaluate the integer value.

Enum values:

equal

greater_or_equal

greater

less_or_equal

less

value

integer · int32 · min: 0 · required

Integer value to compare against using the specified comparison method.

range_start

integer · int32

Starting value of the range for range-based integer matching.

range_end

integer · int32

Ending value of the range for range-based integer matching.

loadBalancerMatchStringWithArgResponse

Extends MatchString with an additional 'name' parameter, used for matchers that require a key-value pair (e.g., matching headers, cookies, or URL parameters).

name

string · required

method

string · enum

String comparison method used to evaluate the match condition.

Enum values:

equal

contains

starts_with

ends_with

regex

value

string

String value or pattern to match against using the specified comparison method.

ignore_case

boolean

Indicates whether the string comparison should be case-insensitive.

loadBalancerMatchStringResponse

Defines a string-based match condition, used for matching values such as paths, headers, URLs, or hostnames.

method

string · enum

String comparison method used to evaluate the match condition.

Enum values:

equal

contains

starts_with

ends_with

regex

value

string

String value or pattern to match against using the specified comparison method.

ignore_case

boolean

Indicates whether the string comparison should be case-insensitive.

loadBalancerMatchBackendResponse

Defines a backend health matcher used to compare the number of healthy (up) members in a specific backend against a threshold value. Used when the matcher type is 'num_members_up'.

method

string · enum · required

Comparison method used to evaluate the integer value.

Enum values:

equal

greater_or_equal

greater

less_or_equal

less

value

integer · int32 · min: 0 · required

Integer value to compare against using the specified comparison method.

backend

string · required

range_start

integer · int32

Starting value of the range for range-based integer matching.

range_end

integer · int32

Ending value of the range for range-based integer matching.

loadBalancerActionResponse

Represents a rule action that defines how matched traffic should be processed or modified within the load balancer. Each action type includes a corresponding configuration object.

type

string · enum · required

Type of action defining how matched requests should be processed or modified.

Enum values:

use_backend

http_return

http_redirect

tcp_reject

set_forwarded_headers

set_request_header

set_response_header

http_rewrite_path

loadBalancerActionUseBackendResponse

Defines the backend target to which the request should be routed when the rule matches. Used when the action type is 'use_backend'.

loadBalancerActionHttpReturnResponse

Defines a custom HTTP response returned to the client when a rule matches. Used when the action type is 'http_return'.

loadBalancerActionHttpRedirectResponse

Defines an HTTP redirection action used to redirect incoming requests to a specified URL with a given HTTP status code. Used when the action type is 'http_redirect'.

action_tcp_reject

loadBalancerActionTcpRejectResponse

Defines a TCP rejection action that immediately closes incoming connections when a rule matches. Used when the action type is 'tcp_reject'.

action_set_forwarded_headers

loadBalancerActionSetForwardedHeadersResponse

Defines an action that automatically adds standard X-Forwarded-* headers (such as X-Forwarded-For and X-Forwarded-Proto) to requests before forwarding them to the backend. Used when the action type is 'set_forwarded_headers'.

loadBalancerActionSetHeaderResponse

Defines an action that adds or modifies an HTTP header in a request or response. Used when the action type is 'set_request_header' or 'set_response_header'.

loadBalancerActionSetHeaderResponse

Defines an action that adds or modifies an HTTP header in a request or response. Used when the action type is 'set_request_header' or 'set_response_header'.

loadBalancerActionHttpRewritePathResponse

Defines an action that rewrites the HTTP request path using a regex pattern.

loadBalancerActionHttpRewriteUriResponse

Defines an action that rewrites the HTTP request URI using a regex pattern.

loadBalancerActionUseBackendResponse

Defines the backend target to which the request should be routed when the rule matches. Used when the action type is 'use_backend'.

backend

string · required

Name of the backend to which the request should be routed when this action executes.

loadBalancerActionHttpReturnResponse

Defines a custom HTTP response returned to the client when a rule matches. Used when the action type is 'http_return'.

status

integer · int32 · min: 100 · max: 599 · required

HTTP status code to return.

content_type

string · required

MIME type of the response body.

payload

string · required

Base64-encoded payload returned as the response body.

loadBalancerActionHttpRedirectResponse

Defines an HTTP redirection action used to redirect incoming requests to a specified URL with a given HTTP status code. Used when the action type is 'http_redirect'.

location

string · required

Absolute or relative URL to which requests are redirected.

status

integer · int32 · required

HTTP status code for the redirection. Common values are 301 (permanent) or 302 (temporary).

loadBalancerActionTcpRejectResponse

Defines a TCP rejection action that immediately closes incoming connections when a rule matches. Used when the action type is 'tcp_reject'.

loadBalancerActionSetForwardedHeadersResponse

loadBalancerActionSetHeaderResponse

Defines an action that adds or modifies an HTTP header in a request or response. Used when the action type is 'set_request_header' or 'set_response_header'.

header

string · required

Name of the HTTP header to add or modify.

value

string · required

Value to assign to the specified header.

loadBalancerActionHttpRewritePathResponse

Defines an action that rewrites the HTTP request path using a regex pattern.

match_pattern

string · required

Regex pattern to match against the path.

rewrite_to

string · required

Replacement pattern (can use capture groups like \1).

loadBalancerActionHttpRewriteUriResponse

Defines an action that rewrites the HTTP request URI using a regex pattern.

match_pattern

string · required

Regex pattern to match against the full URI.

rewrite_to

string · required

Replacement pattern (can use capture groups like \1).

loadBalancerFrontendPropertiesResponse

Defines configurable properties for a frontend, such as client timeout settings, protocol options, and linkage to its parent frontend resource.

timeout_client

integer · int32 · required

Maximum inactivity timeout for a client connection, in milliseconds. Determines how long a client connection can remain idle before being closed.

frontend_id

integer · int32 · required

Identifier linking these properties to the parent frontend configuration.

inbound_proxy_protocol

boolean

Enables or disables support for the Proxy Protocol on inbound connections, allowing client IP addresses to be forwarded to the backend.

http2_enabled

boolean

Indicates whether HTTP/2 protocol support is enabled for this frontend.

loadBalancerBackend

Represents a backend configuration in the load balancer service, containing backend members, resolver settings, TLS configurations, and backend-specific properties such as timeouts and health checks.

name

string · required

Human-readable name of the backend

loadBalancerMember[] · required

List of backend member servers (nodes) participating in this backend configuration.

loadBalancerTlsConfig[] · required

TLS configurations associated with this backend, specifying certificate bundles and identifiers.

loadBalancerBackendPropertiesResponse · required

Properties of a backend configuration.

created_at

string · date-time · required

Timestamp when the backend was created (RFC 3339 format).

Example: 2025-11-06T09:00:00.000Z

updated_at

string · date-time · required

Timestamp when the backend was last updated (RFC 3339 format).

Example: 2025-11-06T11:30:00.000Z

resolver

string | null

Optional outbound DNS resolver reference used by this backend. Null when not set.

loadBalancerMember

Represents a single backend member (server node) participating in a load balancer backend configuration.

name

string · required

Human-readable name assigned to the backend member.

ip

string · ipv4 · required

IP address of the backend member server.

port

integer · int32 · min: 1 · max: 65535 · required

Port number on which the backend member server listens.

weight

integer · int32 · required

Relative weight for load balancing, determining the proportion of requests sent to this member.

max_sessions

integer · int32 · required

Maximum number of concurrent connections allowed to this backend member.

type

string · enum · required

Type of backend configuration. Allowed values are 'static' and 'dynamic'.

Enum values:

static

dynamic

enabled

boolean · required

Indicates whether the backend member is actively participating in load balancing.

backup

boolean · required

Indicates whether this member serves as a backup, only receiving traffic when all primary members are unavailable.

created_at

string · date-time · required

Timestamp when the backend member was created (RFC 3339 format).

Example: 2023-01-01T00:00:00.000Z

updated_at

string · date-time · required

Timestamp when the backend member was last updated (RFC 3339 format).

Example: 2023-01-02T00:00:00.000Z

loadBalancerBackendPropertiesResponse

Properties of a backend configuration.

backend_id

integer · int32 · required

Identifier of the backend.

timeout_server

integer · int32 · required

Server timeout in milliseconds.

timeout_tunnel

integer · int32 · required

Tunnel timeout in milliseconds.

health_check_type

string · required

Type of health check.

health_check_interval

integer · int32 · required

Interval between health checks in seconds.

health_check_fall

integer · int32 · required

Number of failed checks before marking as unhealthy.

health_check_rise

integer · int32 · required

Number of successful checks before marking as healthy.

health_check_url

string · required

URL for HTTP health checks.

health_check_expected_status

integer · int32 · required

Expected HTTP status code from health check.

health_check_tls_verify

boolean · required

Whether to verify TLS in health check.

health_check_on_down

string · required

Action to take when backend is down.

tls_enabled

boolean · required

Whether TLS is enabled.

tls_verify

boolean · required

Whether to verify backend TLS certificate.

tls_use_system_ca

boolean · required

Whether to use system CA for backend TLS.

http2_enabled

boolean · required

Whether HTTP/2 is enabled for the backend.

outbound_proxy_protocol

loadBalancerProxyProtocolVersionOrDisabled · enum

Empty string means disabled

Enum values:

sticky_session_cookie_name

string | null

Name of the sticky session cookie.

sticky_session_cookie_attributes

string | null

Additional cookie attributes appended to sticky session cookies. Supports combinations of: SameSite=Strict|Lax|None, Secure, HttpOnly, Partitioned (semicolon-separated).

loadBalancerResolver

Represents a DNS resolver configuration for a load balancer service, defining the nameservers, retry behavior, and caching rules used to resolve backend hostnames.

name

string · required

Human-readable name assigned to the DNS resolver.

nameservers

string[] · required

List of DNS nameserver addresses (with optional port) used to resolve backend member hostnames.

retries

integer · int32 · required

Number of retry attempts for failed DNS queries.

timeout

integer · int32 · required

Initial timeout in milliseconds for DNS query responses.

timeout_retry

integer · int32 · required

Timeout in milliseconds for DNS query retry attempts.

cache_valid

integer · int32 · required

Time in seconds to cache valid (successful) DNS responses.

cache_invalid

integer · int32 · required

Time in seconds to cache invalid (failed) DNS responses.

created_at

string · date-time · required

Timestamp when the DNS resolver was created (RFC 3339 format).

Example: 2025-11-06T09:00:00.000Z

updated_at

string · date-time · required

Timestamp when the DNS resolver was last updated (RFC 3339 format).

Example: 2025-12-06T09:00:00.000Z

loadBalancerNetwork

Represent a network from where traffic is consumed and routed.

name

string · required

Human-readable name assigned to the network.

uuid

string · required

UUID represented as a string

type

string · required

Network type indicating the visibility scope (public or private).

family

string · required

IP address family used by this network (IPv4 or IPv6).

created_at

string · date-time · required

Timestamp when the network was created (RFC 3339 format).

Example: 2025-11-06T09:00:00.000Z

updated_at

string · date-time · required

Timestamp when the network was last updated (RFC 3339 format).

Example: 2025-11-06T09:30:00.000Z

dns_name

string

Fully qualified domain name (FQDN) for accessing the load balancer through this network.

loadBalancerIpAddress

Represents an IP address associated with a network interface of the load balancer service, including addressing details and provisioning information.

address

string · required

IP address assigned to the load balancer service on this network.

network_name

string · required

Name of the network to which this IP address belongs.

created_at

string · date-time · required

Timestamp when the IP address was created (RFC 3339 format).

Example: 2025-11-06T09:00:00.000Z

updated_at

string · date-time · required

Timestamp when the IP address was last updated (RFC 3339 format).

Example: 2025-11-06T11:15:00.000Z

loadBalancerLabelResponse

Represents a key-value label associated with the load balancer service

key

string · required

Label key used for identification and filtering.

value

string | null

The value of the label (optional).

loadBalancerErrorResponse

Schema for error responses from the API.

object

Error details containing the error message and code.

Example: {"error_message":"Authentication credentials wrong","error_code":"401"}

loadBalancerFrontendsResponse

loadBalancerFrontend[]

An array of frontend configurations for a load balancer service.

loadBalancerFrontend

name

string · required

Human-readable name assigned to the frontend.

port

integer · int32 · required

Port number on which the frontend listens for incoming connections.

mode

string · enum · required

Operating mode defining the protocol layer at which the frontend operates.

Enum values:

http

tcp

default_backend

string · required

Name of the backend used when no routing rules match the incoming request.

loadBalancerTlsConfig[] · required

Represents a list of TLS configuration for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.

loadBalancerRule[] · required

Represents a list of load balancer rules that define how incoming requests are matched and processed, including conditions, actions, and backend target associations.

loadBalancerFrontendPropertiesResponse · required

Defines configurable properties for a frontend, such as client timeout settings, protocol options, and linkage to its parent frontend resource.

object[] · required

created_at

string · date-time · required

Timestamp when the frontend was created (RFC 3339 format).

Example: 2025-11-06T09:00:00.000Z

updated_at

string · date-time · required

Timestamp when the frontend was last updated (RFC 3339 format).

Example: 2025-12-06T09:00:00.000Z

loadBalancerFrontendTlsConfigsResponse

Represents a list of TLS configurations for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.

Represents a TLS configuration for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.

loadBalancerTlsConfig

name

string · required

Human-readable name assigned to the TLS configuration.

certificate_bundle_uuid

string · uuid · required

UUID of the certificate bundle used for TLS encryption.

created_at

string · date-time · required

Timestamp when the TLS configuration was created (RFC 3339 format).

Example: 2025-11-06T10:15:00.000Z

updated_at

string · date-time · required

Timestamp when the TLS configuration was last updated (RFC 3339 format).

Example: 2025-11-06T11:00:00.000Z

loadBalancerBackendsResponse

loadBalancerBackend[]

Response schema for a list of backends.

Represents a backend configuration in the load balancer service, containing backend members, resolver settings, TLS configurations, and backend-specific properties such as timeouts and health checks.

loadBalancerBackend

name

string · required

Human-readable name of the backend

loadBalancerMember[] · required

List of backend member servers (nodes) participating in this backend configuration.

loadBalancerTlsConfig[] · required

TLS configurations associated with this backend, specifying certificate bundles and identifiers.

loadBalancerBackendPropertiesResponse · required

Properties of a backend configuration.

created_at

string · date-time · required

Timestamp when the backend was created (RFC 3339 format).

Example: 2025-11-06T09:00:00.000Z

updated_at

string · date-time · required

Timestamp when the backend was last updated (RFC 3339 format).

Example: 2025-11-06T11:30:00.000Z

resolver

string | null

Optional outbound DNS resolver reference used by this backend. Null when not set.

loadBalancerMembersResponse

loadBalancerMember[]

Response schema for a list of members.

Represents a single backend member (server node) participating in a load balancer backend configuration.

loadBalancerMember

name

string · required

Human-readable name assigned to the backend member.

ip

string · ipv4 · required

IP address of the backend member server.

port

integer · int32 · min: 1 · max: 65535 · required

Port number on which the backend member server listens.

weight

integer · int32 · required

Relative weight for load balancing, determining the proportion of requests sent to this member.

max_sessions

integer · int32 · required

Maximum number of concurrent connections allowed to this backend member.

type

string · enum · required

Type of backend configuration. Allowed values are 'static' and 'dynamic'.

Enum values:

static

dynamic

enabled

boolean · required

Indicates whether the backend member is actively participating in load balancing.

backup

boolean · required

Indicates whether this member serves as a backup, only receiving traffic when all primary members are unavailable.

created_at

string · date-time · required

Timestamp when the backend member was created (RFC 3339 format).

Example: 2023-01-01T00:00:00.000Z

updated_at

string · date-time · required

Timestamp when the backend member was last updated (RFC 3339 format).

Example: 2023-01-02T00:00:00.000Z

loadBalancerIpAddressesResponse

loadBalancerIpAddress[]

A list of floating public IPv4 addresses attached to the load balancer service, each including its network interface metadata.

Represents an IP address associated with a network interface of the load balancer service, including addressing details and provisioning information.

loadBalancerIpAddress

address

string · required

IP address assigned to the load balancer service on this network.

network_name

string · required

Name of the network to which this IP address belongs.

created_at

string · date-time · required

Timestamp when the IP address was created (RFC 3339 format).

Example: 2025-11-06T09:00:00.000Z

updated_at

string · date-time · required

Timestamp when the IP address was last updated (RFC 3339 format).

Example: 2025-11-06T11:15:00.000Z

loadBalancerResolversResponse

loadBalancerResolver[]

Represents a list of DNS resolver configurations for a load balancer service.

Represents a DNS resolver configuration for a load balancer service, defining the nameservers, retry behavior, and caching rules used to resolve backend hostnames.

loadBalancerResolver

name

string · required

Human-readable name assigned to the DNS resolver.

nameservers

string[] · required

List of DNS nameserver addresses (with optional port) used to resolve backend member hostnames.

retries

integer · int32 · required

Number of retry attempts for failed DNS queries.

timeout

integer · int32 · required

Initial timeout in milliseconds for DNS query responses.

timeout_retry

integer · int32 · required

Timeout in milliseconds for DNS query retry attempts.

cache_valid

integer · int32 · required

Time in seconds to cache valid (successful) DNS responses.

cache_invalid

integer · int32 · required

Time in seconds to cache invalid (failed) DNS responses.

created_at

string · date-time · required

Timestamp when the DNS resolver was created (RFC 3339 format).

Example: 2025-11-06T09:00:00.000Z

updated_at

string · date-time · required

Timestamp when the DNS resolver was last updated (RFC 3339 format).

Example: 2025-12-06T09:00:00.000Z

loadBalancerServiceLabelsResponse

loadBalancerLabelResponse

Represents a list of key-value label associated with the load balancer service

Represents a key-value label associated with the load balancer service

key

string · required

Label key used for identification and filtering.

value

string | null

The value of the label (optional).

loadBalancerMetrics

Represents a snapshot of load balancer metrics collected by the monitoring agent, including frontend and backend statistics for a given service at a specific timestamp.

loadBalancerFrontendMetricsResponse[] · required

List of frontend metrics.

Example: []

loadBalancerBackendMetricsResponse[] · required

List of backend metrics.

Example: []

loadBalancerFrontendMetricsResponse

Represents aggregated performance and traffic metrics for a load balancer frontend, including connection statistics, HTTP response counts, and per-second request rates. Combines general metrics, request-specific metrics, and creation timestamps for observability and monitoring purposes.

loadBalancerCommonMetricsResponse

Represents general traffic and session statistics collected for a load balancer frontend or backend, including request and response byte counts, HTTP status distribution, and session activity metrics.

total_request_bytes

integer · int64 · required

Total number of request bytes processed.

total_response_bytes

integer · int64 · required

Total number of response bytes processed.

total_denied_responses

integer · int32 · required

Total number of denied responses.

total_http_responses_1xx

integer · int32 · required

Total number of HTTP 1xx informational responses.

total_http_responses_2xx

integer · int32 · required

Total number of HTTP 2xx successful responses.

total_http_responses_3xx

integer · int32 · required

Total number of HTTP 3xx redirection responses.

total_http_responses_4xx

integer · int32 · required

Total number of HTTP 4xx client error responses.

total_http_responses_5xx

integer · int32 · required

Total number of HTTP 5xx server error responses.

total_http_responses_other

integer · int32 · required

Total number of HTTP responses outside the standard 1xx–5xx range.

total_sessions

integer · int32 · required

Total number of sessions handled.

session_rate

integer · int32 · required

Average rate of sessions per second.

current_sessions

integer · int32 · required

Current number of active sessions.

loadBalancerRequestMetricsResponse

Represents basic HTTP request statistics collected by the load balancer, including the total number of processed, denied, and intercepted requests.

total_http_requests

integer · int32 · required

Total number of HTTP requests processed.

total_denied_requests

integer · int32 · required

Total number of denied HTTP requests.

total_intercepted_requests

integer · int32 · required

Total number of intercepted HTTP requests by internal rules or actions.

loadBalancerBackendMetricsResponse

Represents collected performance, availability, and traffic statistics for a load balancer backend, including member activity, response times, and aggregated server metrics.

loadBalancerServerMetricsResponse

Represents detailed server-level performance and reliability metrics, including connection errors, aborted sessions, and routing statistics for a load balancer backend member.

total_failed_checks_transitions

integer · int32 · required

Total number of times the server transitioned from healthy to failed state due to failed health checks.

total_client_aborted

integer · int32 · required

Total number of sessions aborted by clients before completion.

total_failed_connections

integer · int32 · required

Total number of failed connection attempts to the server.

total_invalid_responses

integer · int32 · required

Total number of invalid responses received from the server.

total_routed_requests

integer · int32 · required

Total number of requests successfully routed to the server.

total_server_aborted

integer · int32 · required

Total number of sessions aborted by the server before completion.

total_server_redispatches

integer · int32 · required

Total number of requests that were redispatched to another server after failure.

total_server_connection_retries

integer · int32 · required

Total number of retries attempted for failed server connections.

connections_waiting

integer · int32 · required

Current number of connections waiting for a server slot.

loadBalancerAvgTimeMetricsResponse

Represents average timing statistics for backend performance, including connection establishment, queuing, server response, and total transaction times, all measured in milliseconds.

avg_connection_time_ms

integer · int32 · required

Average time taken to establish a connection in milliseconds.

avg_queue_time_ms

integer · int32 · required

Average time spent in queue before being processed, in milliseconds.

avg_server_response_time_ms

integer · int32 · required

Average server response time in milliseconds.

avg_total_time_ms

integer · int32 · required

Average total time from connection start to response completion, in milliseconds.

loadBalancerMemberMetricsResponse

Represents detailed performance and health metrics for an individual backend member (server) within a load balancer. Includes operational status, health check results, and aggregated traffic and timing statistics.

loadBalancerMetricsSeriesResponse

loadBalancerMetrics[]

Response schema for a mapping of metric series identifiers to their corresponding metrics data.

Represents a snapshot of load balancer metrics collected by the monitoring agent, including frontend and backend statistics for a given service at a specific timestamp.

loadBalancerMetrics

loadBalancerFrontendMetricsResponse[] · required

List of frontend metrics.

Example: []

loadBalancerBackendMetricsResponse[] · required

List of backend metrics.

Example: []

loadBalancerFrontendMetricsSeriesResponse

loadBalancerFrontendMetricsSeries[]

Response schema for a list of frontend metrics series.

Aggregated time-series metrics for load balancer frontends, representing cumulative statistics between a start and end timestamp across one or more frontend instances.

loadBalancerFrontendMetricsSeries

start_at

string · date-time · required

Timestamp marking the beginning of the metrics aggregation period.

Example: 2025-11-06T09:00:00.000Z

end_at

string · date-time · required

Timestamp marking the end of the metrics aggregation period.

Example: 2025-11-06T09:05:00.000Z

frontends

string[] · required

List of frontend names or identifiers included in the aggregated data.

denied_connections

integer · int32

Total number of denied frontend connections within the time range.

denied_sessions

integer · int32

Total number of denied sessions during the period.

invalid_requests

integer · int32

Number of malformed or invalid HTTP requests received.

request_bytes

integer · int32

Total size of incoming request payloads, in bytes.

response_bytes

integer · int32

Total size of outgoing response payloads, in bytes.

denied_responses

integer · int32

Number of HTTP responses that were denied or rejected.

http_responses_1xx

integer · int32

Count of informational (1xx) HTTP responses.

http_responses_2xx

integer · int32

Count of successful (2xx) HTTP responses.

http_responses_3xx

integer · int32

Count of redirection (3xx) HTTP responses.

http_responses_4xx

integer · int32

Count of client error (4xx) HTTP responses.

http_responses_5xx

integer · int32

Count of server error (5xx) HTTP responses.

http_responses_other

integer · int32

Count of HTTP responses with codes outside the 1xx–5xx range.

sessions

integer · int32

Total number of frontend sessions handled.

http_requests

integer · int32

Total number of HTTP requests processed during the aggregation period.

denied_requests

integer · int32

Total number of HTTP requests denied.

intercepted_requests

integer · int32

Number of requests intercepted before reaching the backend.

loadBalancerFrontendMetricsSeries

Aggregated time-series metrics for load balancer frontends, representing cumulative statistics between a start and end timestamp across one or more frontend instances.

start_at

string · date-time · required

Timestamp marking the beginning of the metrics aggregation period.

Example: 2025-11-06T09:00:00.000Z

end_at

string · date-time · required

Timestamp marking the end of the metrics aggregation period.

Example: 2025-11-06T09:05:00.000Z

frontends

string[] · required

List of frontend names or identifiers included in the aggregated data.

denied_connections

integer · int32

Total number of denied frontend connections within the time range.

denied_sessions

integer · int32

Total number of denied sessions during the period.

invalid_requests

integer · int32

Number of malformed or invalid HTTP requests received.

request_bytes

integer · int32

Total size of incoming request payloads, in bytes.

response_bytes

integer · int32

Total size of outgoing response payloads, in bytes.

denied_responses

integer · int32

Number of HTTP responses that were denied or rejected.

http_responses_1xx

integer · int32

Count of informational (1xx) HTTP responses.

http_responses_2xx

integer · int32

Count of successful (2xx) HTTP responses.

http_responses_3xx

integer · int32

Count of redirection (3xx) HTTP responses.

http_responses_4xx

integer · int32

Count of client error (4xx) HTTP responses.

http_responses_5xx

integer · int32

Count of server error (5xx) HTTP responses.

http_responses_other

integer · int32

Count of HTTP responses with codes outside the 1xx–5xx range.

sessions

integer · int32

Total number of frontend sessions handled.

http_requests

integer · int32

Total number of HTTP requests processed during the aggregation period.

denied_requests

integer · int32

Total number of HTTP requests denied.

intercepted_requests

integer · int32

Number of requests intercepted before reaching the backend.

loadBalancerBackendMetricsSeriesResponse

loadBalancerBackendMetricsSeries[]

Response schema for a list of backend metrics series.

Example: []

Aggregated performance, availability, and traffic statistics for a load balancer backend, including member metrics and average timing metrics.

loadBalancerBackendMetricsSeries

start_at

string · date-time · required

Timestamp marking the start of the metrics collection period.

Example: 2025-11-06T09:00:00.000Z

end_at

string · date-time · required

Timestamp marking the end of the metrics collection period.

Example: 2025-11-06T10:00:00.000Z

backends

string[] · required

List of backend identifiers included in the metrics series.

request_bytes

integer · int64

Total number of request bytes processed.

response_bytes

integer · int64

Total number of response bytes sent.

denied_responses

integer · int32

Total number of denied responses.

http_responses_1xx

integer · int32

Count of HTTP 1xx informational responses.

http_responses_2xx

integer · int32

Count of HTTP 2xx successful responses.

http_responses_3xx

integer · int32

Count of HTTP 3xx redirection responses.

http_responses_4xx

integer · int32

Count of HTTP 4xx client error responses.

http_responses_5xx

integer · int32

Count of HTTP 5xx server error responses.

http_responses_other

integer · int32

Count of HTTP responses outside the 1xx–5xx range.

sessions

integer · int32

Total number of sessions.

downtime

integer · int32

Total downtime in seconds.

failed_checks_transitions

integer · int32

Number of transitions from healthy to failed health checks.

client_aborted

integer · int32

Number of client-aborted connections.

failed_connections

integer · int32

Number of failed connections.

invalid_responses

integer · int32

Number of invalid responses.

routed_requests

integer · int32

Number of routed requests.

server_aborted

integer · int32

Number of server-aborted connections.

server_redispatches

integer · int32

Number of server redispatches.

server_connection_retries

integer · int32

Number of server connection retries.

loadBalancerBackendMetricsSeries

Aggregated performance, availability, and traffic statistics for a load balancer backend, including member metrics and average timing metrics.

start_at

string · date-time · required

Timestamp marking the start of the metrics collection period.

Example: 2025-11-06T09:00:00.000Z

end_at

string · date-time · required

Timestamp marking the end of the metrics collection period.

Example: 2025-11-06T10:00:00.000Z

backends

string[] · required

List of backend identifiers included in the metrics series.

request_bytes

integer · int64

Total number of request bytes processed.

response_bytes

integer · int64

Total number of response bytes sent.

denied_responses

integer · int32

Total number of denied responses.

http_responses_1xx

integer · int32

Count of HTTP 1xx informational responses.

http_responses_2xx

integer · int32

Count of HTTP 2xx successful responses.

http_responses_3xx

integer · int32

Count of HTTP 3xx redirection responses.

http_responses_4xx

integer · int32

Count of HTTP 4xx client error responses.

http_responses_5xx

integer · int32

Count of HTTP 5xx server error responses.

http_responses_other

integer · int32

Count of HTTP responses outside the 1xx–5xx range.

sessions

integer · int32

Total number of sessions.

downtime

integer · int32

Total downtime in seconds.

failed_checks_transitions

integer · int32

Number of transitions from healthy to failed health checks.

client_aborted

integer · int32

Number of client-aborted connections.

failed_connections

integer · int32

Number of failed connections.

invalid_responses

integer · int32

Number of invalid responses.

routed_requests

integer · int32

Number of routed requests.

server_aborted

integer · int32

Number of server-aborted connections.

server_redispatches

integer · int32

Number of server redispatches.

server_connection_retries

integer · int32

Number of server connection retries.

loadBalancerMemberMetricsSeriesResponse

Aggregated time-series metrics for backend members, showing request and response statistics, connection health, and server performance during a given time window.

start_at

string · date-time · required

Timestamp marking the start of the metrics collection period.

Example: 2025-11-06T09:00:00.000Z

end_at

string · date-time · required

Timestamp marking the end of the metrics collection period.

Example: 2025-11-06T10:00:00.000Z

members

string[] · required

List of backend member identifiers included in the metrics series.

request_bytes

integer · int64

Total number of request bytes processed by all members in the series.

response_bytes

integer · int64

Total number of response bytes sent by all members.

denied_responses

integer · int32

Total number of denied responses returned during the period.

http_responses_1xx

integer · int32

Count of HTTP 1xx informational responses.

http_responses_2xx

integer · int32

Count of HTTP 2xx successful responses.

http_responses_3xx

integer · int32

Count of HTTP 3xx redirection responses.

http_responses_4xx

integer · int32

Count of HTTP 4xx client error responses.

http_responses_5xx

integer · int32

Count of HTTP 5xx server error responses.

http_responses_other

integer · int32

Count of HTTP responses outside the 1xx–5xx range.

sessions

integer · int32

Total number of active or completed sessions during the metrics window.

downtime

integer · int32

Total downtime duration in seconds.

failed_checks_transitions

integer · int32

Number of transitions from healthy to failed health checks detected during the period.

client_aborted

integer · int32

Number of connections aborted by the client.

failed_connections

integer · int32

Number of backend connection attempts that failed.

invalid_responses

integer · int32

Number of invalid or malformed responses detected.

routed_requests

integer · int32

Total number of requests successfully routed to the backend members.

server_aborted

integer · int32

Number of connections aborted by the backend server.

server_redispatches

integer · int32

Number of requests redispatched to another backend member after an initial failure.

server_connection_retries

integer · int32

Number of backend connection retry attempts.

failed_checks

integer · int32

Total number of failed health checks for all members combined.

loadBalancerCertificatesBundleResponse

loadBalancerCertificateBundle[]

Response schema for a list of certificate bundles.

Represents a certificate bundle used in a load balancer TLS configuration. A bundle may be manually uploaded, dynamically issued via ACME, or represent an authority certificate. It includes certificate data, challenge details, and metadata about its lifecycle.

loadBalancerCertificateBundle

uuid

string · uuid · required

Unique identifier for the certificate bundle.

name

string · required

Human-readable name assigned to the certificate bundle.

tls_type

string · enum · required

The certificate bundle type. Determines how the certificate is provisioned and managed.

Enum values:

manual

dynamic

authority

operational_state

string · enum · required

Current operational state of the certificate bundle.

Enum values:

pending

setup-challenge

complete-challenge

idle

failed-challenge

created_at

string · date-time · required

Timestamp when this certificate bundle was created.

Example: 2025-11-06T09:00:00.000Z

updated_at

string · date-time · required

Timestamp when this certificate bundle was last updated.

Example: 2025-11-06T11:00:00.000Z

certificate_raw

string · byte

PEM-encoded certificate data (base64).

intermediates_raw

string · byte

PEM-encoded intermediate certificates (base64).

hostnames

string[]

List of hostnames covered by this certificate bundle.

loadBalancerChallengeProblemResponse[]

Problems reported during ACME challenge validation.

key_type

string · enum

Type of private key used for this certificate bundle.

Enum values:

rsa

ecdsa

loadBalancerEmbeddedServiceResponse[]

List of load balancer services that use this certificate bundle.

not_before

string · date-time

The start date and time of certificate validity.

Example: 2025-11-06T09:00:00.000Z

not_after

string · date-time

The expiration date and time of certificate validity.

Example: 2026-11-06T09:00:00.000Z

loadBalancerChallengeProblemResponse[]

List of labels attached to this certificate bundle.

loadBalancerCertificateBundle

uuid

string · uuid · required

Unique identifier for the certificate bundle.

name

string · required

Human-readable name assigned to the certificate bundle.

tls_type

string · enum · required

The certificate bundle type. Determines how the certificate is provisioned and managed.

Enum values:

manual

dynamic

authority

operational_state

string · enum · required

Current operational state of the certificate bundle.

Enum values:

pending

setup-challenge

complete-challenge

idle

failed-challenge

created_at

string · date-time · required

Timestamp when this certificate bundle was created.

Example: 2025-11-06T09:00:00.000Z

updated_at

string · date-time · required

Timestamp when this certificate bundle was last updated.

Example: 2025-11-06T11:00:00.000Z

certificate_raw

string · byte

PEM-encoded certificate data (base64).

intermediates_raw

string · byte

PEM-encoded intermediate certificates (base64).

hostnames

string[]

List of hostnames covered by this certificate bundle.

Problems reported during ACME challenge validation.

key_type

string · enum

Type of private key used for this certificate bundle.

Enum values:

rsa

ecdsa

loadBalancerEmbeddedServiceResponse[]

List of load balancer services that use this certificate bundle.

not_before

string · date-time

The start date and time of certificate validity.

Example: 2025-11-06T09:00:00.000Z

not_after

string · date-time

The expiration date and time of certificate validity.

Example: 2026-11-06T09:00:00.000Z

loadBalancerProblemInvalidParamResponse[]

List of labels attached to this certificate bundle.

loadBalancerChallengeProblemResponse

Represents a problem encountered during ACME challenge validation for a specific hostname. Includes detailed error information following the Problem Details (RFC7807) format.

hostname

string · required

The hostname for which the ACME challenge validation failed or encountered an error.

loadBalancerProblemResponse · required

Represents an error object following the Problem Details specification (RFC7807). Provides machine-readable and human-readable information about an error that occurred while processing a request.

loadBalancerProblemResponse

Represents an error object following the Problem Details specification (RFC7807). Provides machine-readable and human-readable information about an error that occurred while processing a request.

type

string · uri · required

A URI reference identifying the problem type. When dereferenced, it typically provides human-readable documentation for the error.

title

string · required

A short, human-readable summary of the problem type. This value should not vary between occurrences of the same error type.

status

integer · int64 · required

The HTTP status code generated by the origin server for this occurrence of the problem.

detail

string

A human-readable explanation specific to this occurrence of the problem.

A list of invalid parameters that caused the problem. Used to provide detailed feedback for validation errors.

correlation_id

string · uuid

A unique identifier for this error instance, useful for tracing or debugging requests.

loadBalancerProblemInvalidParamResponse

Provides detailed information about a specific invalid parameter that caused a request to fail validation, as an extension of RFC7807 Problem Details.

name

string · required

The name of the parameter or form field that caused the validation error. It can include structural delimiters to indicate nested fields (e.g., 'data.attributes.email').

reason

string · required

A human-readable message explaining why the parameter value was invalid, either syntactically or semantically.

loadBalancerEmbeddedServiceResponse

Represents a minimal embedded reference to a load balancer service, including its UUID, name, and lists of associated frontends and backends.

uuid

string · uuid · required

Unique identifier for the load balancer service.

name

string · required

Human-readable name of the embedded service.

loadBalancerEmbeddedFrontendResponse[]

List of frontends associated with the service. Each frontend defines how client connections are received.

loadBalancerEmbeddedBackendResponse[]

List of backends associated with the service. Each backend defines how traffic is distributed to target servers.

deleted

boolean

Indicates whether the service has been marked as deleted.

loadBalancerEmbeddedFrontendResponse

Represents a minimal embedded reference to a frontend within a load balancer service, including its name and any associated TLS configurations.

name

string · required

Human-readable name of the embedded frontend within the load balancer service.

List of TLS configuration objects associated with this frontend. Each entry references a certificate bundle used for secure connections.

loadBalancerEmbeddedBackendResponse

Represents a minimal embedded reference to a backend within the load balancer service, including its name and associated TLS configurations.

name

string · required

Human-readable name of the embedded backend within the load balancer service.

List of TLS configuration objects associated with this backend. Each entry defines a certificate bundle used for secure connections to backend servers.

loadBalancerCertificateBundleLabelsResponse