List

Available for user tokens and project keys

List

GET https://api.suble.io/projects/:projectId/vm

Retrieve a list of all virtual machines in the project.

Path Parameters

Name	Type	Description
projectId	string	Unique id for the project

Headers

Name	Type	Description
Authorization	string	User token or project key

200 Returns an array of virtual machine objects

[
    {
        "_id": ObjectId,
        "project": ObjectId,
        "name": String,
        "status": String ("offline" | "online"),
        "online": Boolean,
        "created": Number, // Datetime Unix
        "network": {
            "ipv4": {
                "public": String,
                "private": {
                    "network": ObjectId,
                    "address": String,
                    "macaddress": String
                }
            },
            "floating": Array
        },
        "package": {
            "name": String,
            "cores": Number,
            "memory": Number, // Defined in MB
            "storage": Number, // Defined in MB,
            "price": Number // Defined as 1 DKK = 100 
        },
        "esxi": Number,
        "datacenter": String, // Example: aad1-dc1
        "node": Number,
        "renew": Number, // Datetime Unix
        "image": {
            "long": String, // linux-ubuntu-20.10
            "short": String, // ubuntu-20.10
            "flavor": String, // ubuntu
            "version": String, // 20.10
            "icon": String, //ubuntu (MDI Icon)
        },
        usage: {
            cpu: Number,
            ram: Number,
            date: Number // Datetime Unix
        }
    }
]4

400 Error can occur if request was made unauthorized or with an invalid project id.

{
    "error": String
}