Skip to content

upctl

UpCloud command-line interface

upctl provides a command-line interface to UpCloud services. It allows you to control your resources from the command line or any compatible interface.

To be able to manage your UpCloud resources, you need to configure credentials for upctl and enable API access for these credentials. Define the credentials by setting UPCLOUD_USERNAME and UPCLOUD_PASSWORD environment variables. API access can be configured on the Account page of the UpCloud Hub. We recommend you to set up a sub-account specifically for the API usage with its own username and password, as it allows you to assign specific permissions for increased security.

Options

Option Description
--client-timeout, -t Client timeout to use in API calls.
Default: 0s
--config Configuration file path.
--debug Print out more verbose debug logs.
Default: false
--force-colours Force coloured output despite detected terminal support.
--help, -h help for upctl
Default: false
--no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable.
--output, -o Output format (supported: json, yaml and human)
Default: human
Command Description
upctl account Manage accounts
upctl database Manage databases
upctl gateway Manage gateways
upctl host Manage private cloud hosts
upctl ip-address Manage IP addresses
upctl kubernetes Manage Kubernetes clusters
upctl loadbalancer Manage load balancers
upctl network Manage networks
upctl networkpeering Manage network peerings
upctl objectstorage Manage managed object storage services
upctl partner Manage partner resources
upctl router Manage routers
upctl server Manage servers
upctl servergroup Manage server groups
upctl storage Manage storages
upctl version Display software information
upctl zone Display zone information