Tutorials Getting started with the UpCloud API

Getting started with the UpCloud API

This is a quick introduction to the UpCloud API. Will help you through the first steps of connecting to the API and automating your cloud servers using your favourite programming language. The programmable API is available at https://api.upcloud.com, which encompasses all of the functionality of the UpCloud control panel and then some. If you want to get started on your own, head straight to the full API documentation.

Creating API credentials

The first step in getting started with our API is to create a separate API user. You can do this at the UpCloud control panel using the workspace member accounts. Your API account name and password are very much comparable to an API ID and key pair with the added benefit of being able to set them yourself.

Create a new workspace member for the API access by clicking the Add member button.

Workspace members

Enter the contact details for your API credentials, set the API password, and enable API access in the permissions.

By default, the API account will have full permissions to any resources it creates but no access to existing servers or storages. You can grant additional permissions as needed using the server, storage, and tag access options.

Once done, click the Create subaccount button at the bottom.

Create API account

You can create as many dedicated API accounts as you need. We recommend creating separate API credentials for each application and external service you use.

Note that you should restrict the API subaccount from your other UpCloud services. Take care handling the credentials if you are programming automation against the UpCloud API.

Running basic API requests

Once you have created your API account, let’s try your first request. To quickly test the API, use a tool such as Postman (or any other API toolkit of your choice) to get started. The goal is to have the following dialogue working.

GET /1.2/account
HTTP/1.0 200 OK
{
    "account" : {
        "credits" : "10000",
        "username" : "username"
    }
}

Using a GET request, enter the API address https://api.upcloud.com with the API version number and the desired command to the request URL line, then select the Basic Auth option and set your username and password. When you have filled in the request details, click the Send button to run the query.

Postman GET Account

The reply will be shown in the bottom half of the Postman window under the Body tab.

The authentication method of our API is the HTTP Basic authentication where the Authorization header should contain your API username and password Base64 encoded. More precisely:

# Python3
import base64
base64.b64encode("username:password".encode())
# Node.js
new Buffer("username:password").toString('base64');

In Postman the authorization header line should look as shown below with your Base64 encoded credentials.

Postman Basic Auth header

Using a similar request by just replacing the query target from account to server you can get the full list of servers your API account is allowed to access.

GET /1.2/server
HTTP/1.0 200 OK
{
    "servers": {
        "server": [
            {
                "core_number": "1",
                "hostname": "example.upcloud.com",
                "license": 0,
                "memory_amount": "1024",
                "plan": "1xCPU-1GB",
                "state": "started",
                "tags": {
                    "tag": []
                },
                "title": "Example UpCloud server",
                "uuid": "00e8051f-86af-468b-b932-4fe4ac6c7f08",
                "zone": "fi-hel1"
            }
        ]
    }
}

You should now be able to form similar requests to the ones above using the API. For example, GET /1.2/server/00e8051f-86af-468b-b932-4fe4ac6c7f08, will reply with full details of that specific host when you include the UUID of one of your servers in a query.

Using the API programmatically

The API can be accessed using any language that has proper HTTP libraries. The following snippet shows how you could take advantage of the UpCloud API using Python3.

import http.client
import base64

conn = http.client.HTTPSConnection("api.upcloud.com")
auth = base64.b64encode("username:password".encode())
headers = {"Authorization": "Basic " + auth.decode()}

conn.request("GET", "/1.2/account", None, headers)
res = conn.getresponse()
print( res.read().decode() )

For a bit more sensible approach, the example below shows how you could structure the code for a better approach. The BaseAPI forms a generic API (GET) request that is extended by the Account class to form the same API request as above. Adding additional GET-requests would now be much easier.

import http.client
import base64

class BaseAPI:
    api = "api.upcloud.com"
    api_v = "1.2"
    token = base64.b64encode("username:password".encode())

    '''
    Performs a GET request to a given endpoint in UpCloud's API.
    '''
    def get(self, endpoint):
        conn = http.client.HTTPSConnection(self.api)
        url = "/" + self.api_v + endpoint
        headers = {
            "Authorization": "Basic " + self.token.decode(),
            "Content-Type": "application/json"
        }
        conn.request("GET", url, None, headers)
        res = conn.getresponse()
        self.printresponse(res.read())

    '''
    Prints the response (bytes) as a string to the user
    '''
    def printresponse(self, res):
        data = res.decode(encoding="UTF-8")
        print(data)

class Account(BaseAPI):
    endpoint="/account"

    def do(self):
        self.get(self.endpoint)

if __name__ == "__main__":
    Account().do()

More about the UpCloud API

These are just a couple of the simplest examples of what the UpCloud API allows you to do. Now that you have got the hang of the API usage, continue on to deploying a new server with UpCloud API.

Leave a Reply

Your email address will not be published. Required fields are marked *

Locations

Helsinki (HQ)

In the capital city of Finland, you will find our headquarters, and our first data centre. This is where we handle most of our development and innovation.

London

London was our second office to open, and a important step in introducing UpCloud to the world. Here our amazing staff can help you with both sales and support, in addition to host tons of interesting meetups.

Seattle

Seattle is our 4th and latest office to be opened, and our way to reach out across the pond to our many users in the Americas.

Singapore

Singapore was our 3rd office to be opened, and enjoys one of most engaged and fastest growing user bases we have ever seen.