Get

Available for user tokens and project keys

Get

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

Retrieve information about a virtual machine

Path Parameters

Name	Type	Description
projectId	string	Unique id for the project
vmId	string	Unique id for the virtual machine

Headers

Name	Type	Description
Authorization	string	User token or project key

200

{
    "_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
    }
}