APIs for Developers

Deploy and manage your cloud from your code.

Display account informations:

GET /account
Request
curl -s --header 'Content-Type: application/json' --request GET -H 'Authorization: Basic API_KEY' 'https://api.virtua.host/account'
Response
{
"balance":"93.6425",
"currency":"EUR",
"monthly_cloud_usage":"6.4590",
"monthly_cloud_usage_estimate":"37.5633",
"timezone":"Europe\/Paris",
"today_cloud_usage":"1.0714",
"cloud_servers_limit":"8"
}

Display cloud ressources usage and limits:

GET /cloud/limits
Request
curl -s --header 'Content-Type: application/json' --request GET -H 'Authorization: Basic API_KEY' 'https://api.virtua.host/cloud/limits'
Response
{
"success":true,
"usage":
{
"cloud_servers":5,
"vcpus":"10",
"memory_size":"18944",
"root_space":"120",
"ip_address_v4":"5",
"ip_address_v6":"3"
},
"limits":
{
"cloud_servers":"8",
"smtp_enabled":"1"
}
}

List all active Cloud Servers:

GET /cloud-server
Request
curl -s --header 'Content-Type: application/json' --request GET -H 'Authorization: Basic API_KEY' 'https://api.virtua.host/cloud-server'
Response
{
"success":true,
"cloud_servers":[
{
"uuid":"4768103d-7e0b-46c8-8f65-360bcd7b3322",
"name":"vs4023.par01fr.vsys.cloud",
"label":null,
"offer":
{
"uuid":"vcs-2-win-ryzen",
"category":"vcs-win",
"name":"vCS-2-WIN",
"price_month":"12.00",
"price_hour":"0.0164"
},
"start_time":"2020-02-10 13:53:53",
"end_time":"2020-02-10 22:05:01",
"monthly_usage":"0.134243111111080000000000000000",
"short_description":null,
"is_suspended":"0",
"suspension_reason":null,
"cloud_zone":
{
"country_code":"FR",
"country_name":"France",
"city_name":"Paris",
"datacenter_name":"Iliad DC2",
"timezone":"Europe\/Paris"
},
"vcpus":"2",
"vcpus_used":"1",
"memory_size":"4096",
"memory_size_used":"3597",
"root_space":"40",
"root_disk_type":"nvme",
"status":"running",
"is_error":"0",
"is_setup":"1",
"system":
{
"uuid":"win2k19-std-fr-64",
"name":"Windows Server 2019 Standard (64 bits)"
},
"uptime":"14624",
"vm_type":"qemu",
"setup_step":null,
"netboot_on":null,
"netboot_is_setup":"1",
"is_smtp_allowed":"1",
"hostname":null,
"is_setup_at":"2020-02-10 13:53:53",
"is_ipv6_enabled":"1",
"is_processing":"0",
"ssh_keys":null,
"keyboard":"fr"
}
]
}

Display a particular cloud server:

GET /cloud-server/UUID
Request
curl -s --header 'Content-Type: application/json' --request GET -H 'Authorization: Basic API_KEY' 'https://api.virtua.host/cloud-server/UUID'
Response
{
"success":true,
"uuid":"4768103d-7e0b-46c8-8f65-360bcd7b3322",
"name":"vs4023.par01fr.vsys.cloud",
"label":null,
"offer":
{
"uuid":"vcs-2-win-ryzen",
"category":"vcs-win",
"name":"vCS-2-WIN",
"price_month":"12.00",
"price_hour":"0.0164"
},
"start_time":"2020-02-10 13:53:53",
"end_time":"2020-02-10 22:05:01",
"monthly_usage":"0.134243111111080000000000000000",
"short_description":null,
"is_suspended":"0",
"suspension_reason":null,
"cloud_zone":
{
"country_code":"FR",
"country_name":"France",
"city_name":"Paris",
"datacenter_name":"Iliad DC2",
"timezone":"Europe\/Paris"
},
"vcpus":"2",
"vcpus_used":"1",
"memory_size":"4096",
"memory_size_used":"3597",
"root_space":"40",
"root_disk_type":"nvme",
"status":"running",
"is_error":"0",
"is_setup":"1",
"system":
{
"uuid":"win2k19-std-fr-64",
"name":"Windows Server 2019 Standard (64 bits)"
},
"uptime":"14624",
"vm_type":"qemu",
"setup_step":null,
"netboot_on":null,
"netboot_is_setup":"1",
"is_smtp_allowed":"1",
"hostname":null,
"is_setup_at":"2020-02-10 13:53:53",
"is_ipv6_enabled":"1",
"is_processing":"0",
"ssh_keys":null,
"keyboard":"fr"
}

Start an Cloud Server:

POST /cloud-server/UUID/start
Request
curl -s --header 'Content-Type: application/json' --request POST -H 'Authorization: Basic API_KEY' 'https://api.virtua.host/cloud-server/UUID/start'
Response
{
"success":true,
"uuid":"UUID",
"messages":[
{
"content":"Start in progress...",
"type":"notice"
}
]
}

Stop an Cloud Server:

POST /cloud-server/UUID/stop
Request
curl -s --header 'Content-Type: application/json' --request POST -H 'Authorization: Basic API_KEY' 'https://api.virtua.host/cloud-server/UUID/stop'
Response
{
"success":true,
"uuid":"UUID",
"messages":[
{
"content":"Stop in progress...",
"type":"notice"
}
]
}

Restart an Cloud Server:

POST /cloud-server/UUID/restart
Request
curl -s --header 'Content-Type: application/json' --request POST -H 'Authorization: Basic API_KEY' 'https://api.virtua.host/cloud-server/UUID/restart'
Response
{
"success":true,
"uuid":"UUID",
"messages":[
{
"content":"Start in progress...",
"type":"notice"
}
]
}

Resize an Cloud Server:

POST /cloud-server/UUID/resize
Parameters
  • offer: The new Offer UUID
  • resize_disk: Boolean, 1 upgrade the disk size, 0 keep the disk size unchanged
  • Request
    curl -s --header 'Content-Type: application/json' --request POST -H 'Authorization: Basic API_KEY' 'https://api.virtua.host/cloud-server/UUID/resize' --data 'offer=NEW_OFFER_UUID' -d 'resize_disk=1'
    Response
    {
    "success":true,
    "uuid":"UUID",
    "messages":[
    {
    "content":"Update in progress...",
    "type":"notice"
    }
    ]
    }

    Destroy an Cloud Server:

    DELETE /cloud-server/UUID
    Request
    curl -s --header 'Content-Type: application/json' --request DELETE -H 'Authorization: Basic API_KEY' 'https://api.virtua.host/cloud-server/UUID'
    Response
    {
    "success":true,
    "uuid":"UUID",
    "messages":[
    {
    "content":"Server destroyed.",
    "type":"notice"
    }
    ]
    }

    Deploy a new Cloud Server:

    POST /cloud/order
    Parameters
  • offer: The Offer UUID
  • system: The System UUID
  • ipv6_enabled: Boolean, 1 enable and addign a IPv6, 0 disable IPv6 and no IPv6 assignation
  • hostname: Custom hostname
  • project: The Project UUID
  • Request
    curl -s --header 'Content-Type: application/json' --request POST -H 'Authorization: Basic API_KEY' 'https://api.virtua.host/cloud/order' --data 'offer=OFFER_UUID' -d 'system=SYSTEM_UUID' -d 'ipv6_enable=0' -d 'hostname=my.server.cloud' -d 'project=PROJECT_UUID'
    Response
    {
    "success":true,
    "uuid":"UUID",
    }

    Do you have questions about our services or do you need help?

    You can reach us by email, we are always happy to help.

    Contact us

    VISA Mastercard Maestro AMEX Apple Pay Google Pay PayPal Bitcoin Bancontact/MisterCash iDEAL SOFORT AliPay AliPay WeChat