Create a virtual machine
curl --request POST \
--url https://api.vmarea.com/api/v1/api/public/v1/vms \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"regionId": "<string>",
"osTemplateId": "<string>",
"hostname": "<string>",
"planId": "<string>",
"password": "<string>",
"sshKeyIds": [
"<string>"
],
"name": "<string>",
"dailyBackupEnabled": false,
"network10gEnabled": false,
"isProtected": false,
"firewallIds": [],
"privateNetworkIds": []
}
'import requests
url = "https://api.vmarea.com/api/v1/api/public/v1/vms"
payload = {
"regionId": "<string>",
"osTemplateId": "<string>",
"hostname": "<string>",
"planId": "<string>",
"password": "<string>",
"sshKeyIds": ["<string>"],
"name": "<string>",
"dailyBackupEnabled": False,
"network10gEnabled": False,
"isProtected": False,
"firewallIds": [],
"privateNetworkIds": []
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
regionId: '<string>',
osTemplateId: '<string>',
hostname: '<string>',
planId: '<string>',
password: '<string>',
sshKeyIds: ['<string>'],
name: '<string>',
dailyBackupEnabled: false,
network10gEnabled: false,
isProtected: false,
firewallIds: [],
privateNetworkIds: []
})
};
fetch('https://api.vmarea.com/api/v1/api/public/v1/vms', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vmarea.com/api/v1/api/public/v1/vms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'regionId' => '<string>',
'osTemplateId' => '<string>',
'hostname' => '<string>',
'planId' => '<string>',
'password' => '<string>',
'sshKeyIds' => [
'<string>'
],
'name' => '<string>',
'dailyBackupEnabled' => false,
'network10gEnabled' => false,
'isProtected' => false,
'firewallIds' => [
],
'privateNetworkIds' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vmarea.com/api/v1/api/public/v1/vms"
payload := strings.NewReader("{\n \"regionId\": \"<string>\",\n \"osTemplateId\": \"<string>\",\n \"hostname\": \"<string>\",\n \"planId\": \"<string>\",\n \"password\": \"<string>\",\n \"sshKeyIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"dailyBackupEnabled\": false,\n \"network10gEnabled\": false,\n \"isProtected\": false,\n \"firewallIds\": [],\n \"privateNetworkIds\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vmarea.com/api/v1/api/public/v1/vms")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"regionId\": \"<string>\",\n \"osTemplateId\": \"<string>\",\n \"hostname\": \"<string>\",\n \"planId\": \"<string>\",\n \"password\": \"<string>\",\n \"sshKeyIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"dailyBackupEnabled\": false,\n \"network10gEnabled\": false,\n \"isProtected\": false,\n \"firewallIds\": [],\n \"privateNetworkIds\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vmarea.com/api/v1/api/public/v1/vms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"regionId\": \"<string>\",\n \"osTemplateId\": \"<string>\",\n \"hostname\": \"<string>\",\n \"planId\": \"<string>\",\n \"password\": \"<string>\",\n \"sshKeyIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"dailyBackupEnabled\": false,\n \"network10gEnabled\": false,\n \"isProtected\": false,\n \"firewallIds\": [],\n \"privateNetworkIds\": []\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"vm": {
"id": "<string>",
"name": "<string>",
"hostname": "<string>",
"status": "<string>",
"vcpu": 123,
"ram": 123,
"disk": 123,
"bandwidth": 123,
"networkSpeed": 123,
"network10gEnabled": true,
"dailyBackupEnabled": true,
"isProtected": true,
"ipAddress": "<string>",
"region": {
"slug": "<string>",
"name": "<string>"
},
"plan": {
"slug": "<string>",
"name": "<string>",
"priceMonthly": "<unknown>"
},
"osTemplate": {
"slug": "<string>",
"name": "<string>",
"version": "<string>"
},
"billing": {
"nextRenewalAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"priceMonthly": "<unknown>"
},
"createdAt": "2023-11-07T05:31:56Z",
"bandwidthUsedBytes": 123,
"bandwidthPackBytes": "<string>",
"sshKeys": [
{
"id": "<string>",
"name": "<string>",
"fingerprint": "<string>"
}
],
"firewalls": [
{
"id": "<string>",
"name": "<string>"
}
],
"privateNetworks": [
{
"id": "<string>",
"name": "<string>"
}
],
"updatedAt": "2023-11-07T05:31:56Z"
},
"actionId": "<string>"
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}VMs
Create a virtual machine
Provision a new VM. Charges the user wallet immediately for the first cycle (plus any addons) and enqueues the create action. Returns 202 with the VM detail and the action id to poll. Requires the vms:write scope.
POST
/
api
/
public
/
v1
/
vms
Create a virtual machine
curl --request POST \
--url https://api.vmarea.com/api/v1/api/public/v1/vms \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"regionId": "<string>",
"osTemplateId": "<string>",
"hostname": "<string>",
"planId": "<string>",
"password": "<string>",
"sshKeyIds": [
"<string>"
],
"name": "<string>",
"dailyBackupEnabled": false,
"network10gEnabled": false,
"isProtected": false,
"firewallIds": [],
"privateNetworkIds": []
}
'import requests
url = "https://api.vmarea.com/api/v1/api/public/v1/vms"
payload = {
"regionId": "<string>",
"osTemplateId": "<string>",
"hostname": "<string>",
"planId": "<string>",
"password": "<string>",
"sshKeyIds": ["<string>"],
"name": "<string>",
"dailyBackupEnabled": False,
"network10gEnabled": False,
"isProtected": False,
"firewallIds": [],
"privateNetworkIds": []
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
regionId: '<string>',
osTemplateId: '<string>',
hostname: '<string>',
planId: '<string>',
password: '<string>',
sshKeyIds: ['<string>'],
name: '<string>',
dailyBackupEnabled: false,
network10gEnabled: false,
isProtected: false,
firewallIds: [],
privateNetworkIds: []
})
};
fetch('https://api.vmarea.com/api/v1/api/public/v1/vms', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vmarea.com/api/v1/api/public/v1/vms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'regionId' => '<string>',
'osTemplateId' => '<string>',
'hostname' => '<string>',
'planId' => '<string>',
'password' => '<string>',
'sshKeyIds' => [
'<string>'
],
'name' => '<string>',
'dailyBackupEnabled' => false,
'network10gEnabled' => false,
'isProtected' => false,
'firewallIds' => [
],
'privateNetworkIds' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vmarea.com/api/v1/api/public/v1/vms"
payload := strings.NewReader("{\n \"regionId\": \"<string>\",\n \"osTemplateId\": \"<string>\",\n \"hostname\": \"<string>\",\n \"planId\": \"<string>\",\n \"password\": \"<string>\",\n \"sshKeyIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"dailyBackupEnabled\": false,\n \"network10gEnabled\": false,\n \"isProtected\": false,\n \"firewallIds\": [],\n \"privateNetworkIds\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vmarea.com/api/v1/api/public/v1/vms")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"regionId\": \"<string>\",\n \"osTemplateId\": \"<string>\",\n \"hostname\": \"<string>\",\n \"planId\": \"<string>\",\n \"password\": \"<string>\",\n \"sshKeyIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"dailyBackupEnabled\": false,\n \"network10gEnabled\": false,\n \"isProtected\": false,\n \"firewallIds\": [],\n \"privateNetworkIds\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vmarea.com/api/v1/api/public/v1/vms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"regionId\": \"<string>\",\n \"osTemplateId\": \"<string>\",\n \"hostname\": \"<string>\",\n \"planId\": \"<string>\",\n \"password\": \"<string>\",\n \"sshKeyIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"dailyBackupEnabled\": false,\n \"network10gEnabled\": false,\n \"isProtected\": false,\n \"firewallIds\": [],\n \"privateNetworkIds\": []\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"vm": {
"id": "<string>",
"name": "<string>",
"hostname": "<string>",
"status": "<string>",
"vcpu": 123,
"ram": 123,
"disk": 123,
"bandwidth": 123,
"networkSpeed": 123,
"network10gEnabled": true,
"dailyBackupEnabled": true,
"isProtected": true,
"ipAddress": "<string>",
"region": {
"slug": "<string>",
"name": "<string>"
},
"plan": {
"slug": "<string>",
"name": "<string>",
"priceMonthly": "<unknown>"
},
"osTemplate": {
"slug": "<string>",
"name": "<string>",
"version": "<string>"
},
"billing": {
"nextRenewalAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"priceMonthly": "<unknown>"
},
"createdAt": "2023-11-07T05:31:56Z",
"bandwidthUsedBytes": 123,
"bandwidthPackBytes": "<string>",
"sshKeys": [
{
"id": "<string>",
"name": "<string>",
"fingerprint": "<string>"
}
],
"firewalls": [
{
"id": "<string>",
"name": "<string>"
}
],
"privateNetworks": [
{
"id": "<string>",
"name": "<string>"
}
],
"updatedAt": "2023-11-07T05:31:56Z"
},
"actionId": "<string>"
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Authorizations
Long-lived API token created at https://vmarea.com/dashboard/settings/api-keys. Tokens are scope-restricted; this spec lists the scope each endpoint requires.
Body
application/json
Pattern:
^[cC][^\s-]{8,}$Pattern:
^[cC][^\s-]{8,}$Required string length:
1 - 63Pattern:
^[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?$Pattern:
^[cC][^\s-]{8,}$Show child attributes
Show child attributes
Required string length:
8 - 128Maximum array length:
20Pattern:
^[cC][^\s-]{8,}$Required string length:
1 - 100Maximum array length:
10Pattern:
^[cC][^\s-]{8,}$Maximum array length:
5Pattern:
^[cC][^\s-]{8,}$⌘I