VM parameters
curl --request GET \
--url https://api.tenbytecloud.com/v1/api/parameters/vm \
--header 'apikey: <api-key>'import requests
url = "https://api.tenbytecloud.com/v1/api/parameters/vm"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://api.tenbytecloud.com/v1/api/parameters/vm', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tenbytecloud.com/v1/api/parameters/vm"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.tenbytecloud.com/v1/api/parameters/vm")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_bodyHttpResponse<String> response = Unirest.get("https://api.tenbytecloud.com/v1/api/parameters/vm")
.header("apikey", "<api-key>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.tenbytecloud.com/v1/api/parameters/vm");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("apikey", "<api-key>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tenbytecloud.com/v1/api/parameters/vm",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}[
{
"constraint": "range",
"description": "Size of main storage in gigabytes.",
"mandatory": true,
"max": 240,
"min": 20,
"parameter": "disks",
"type": "integer"
},
{
"constraint": "regexp",
"description": "Name of the VM",
"expression": "^[0-9a-zA-Z][-0-9a-zA-Z]{2,}[0-9a-zA-Z]$",
"mandatory": true,
"parameter": "name",
"type": "string"
},
{
"constraint": "enum",
"description": "OS name of VM base image.",
"mandatory": true,
"parameter": "os_name",
"type": "string",
"values": [
"centos",
"ubuntu",
"windows",
"debian"
]
},
{
"constraint": "enum",
"description": "OS version of VM base image.",
"limited_by": "os_name",
"mandatory": true,
"parameter": "os_version",
"type": "string"
},
{
"constraint": "regexp",
"description": "Password for logging in to the VM.",
"expression": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d).{8,}$",
"mandatory": true,
"parameter": "password",
"type": "string"
},
{
"constraint": "range",
"description": "Amount of RAM.",
"mandatory": true,
"max": 65536,
"min": 512,
"parameter": "ram",
"type": "integer"
},
{
"constraint": "regexp",
"description": "Username for logging in to the VM.",
"mandatory": true,
"parameter": "username",
"type": "string"
},
{
"constraint": "range",
"description": "Number of CPUs.",
"mandatory": true,
"max": 16,
"min": 1,
"parameter": "vcpu",
"type": "integer"
}
]Parameters
VM parameters
Describes VM creation parameters and their expected and allowed values.
GET
/
api
/
parameters
/
vm
VM parameters
curl --request GET \
--url https://api.tenbytecloud.com/v1/api/parameters/vm \
--header 'apikey: <api-key>'import requests
url = "https://api.tenbytecloud.com/v1/api/parameters/vm"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://api.tenbytecloud.com/v1/api/parameters/vm', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tenbytecloud.com/v1/api/parameters/vm"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.tenbytecloud.com/v1/api/parameters/vm")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_bodyHttpResponse<String> response = Unirest.get("https://api.tenbytecloud.com/v1/api/parameters/vm")
.header("apikey", "<api-key>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.tenbytecloud.com/v1/api/parameters/vm");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("apikey", "<api-key>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tenbytecloud.com/v1/api/parameters/vm",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}[
{
"constraint": "range",
"description": "Size of main storage in gigabytes.",
"mandatory": true,
"max": 240,
"min": 20,
"parameter": "disks",
"type": "integer"
},
{
"constraint": "regexp",
"description": "Name of the VM",
"expression": "^[0-9a-zA-Z][-0-9a-zA-Z]{2,}[0-9a-zA-Z]$",
"mandatory": true,
"parameter": "name",
"type": "string"
},
{
"constraint": "enum",
"description": "OS name of VM base image.",
"mandatory": true,
"parameter": "os_name",
"type": "string",
"values": [
"centos",
"ubuntu",
"windows",
"debian"
]
},
{
"constraint": "enum",
"description": "OS version of VM base image.",
"limited_by": "os_name",
"mandatory": true,
"parameter": "os_version",
"type": "string"
},
{
"constraint": "regexp",
"description": "Password for logging in to the VM.",
"expression": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d).{8,}$",
"mandatory": true,
"parameter": "password",
"type": "string"
},
{
"constraint": "range",
"description": "Amount of RAM.",
"mandatory": true,
"max": 65536,
"min": 512,
"parameter": "ram",
"type": "integer"
},
{
"constraint": "regexp",
"description": "Username for logging in to the VM.",
"mandatory": true,
"parameter": "username",
"type": "string"
},
{
"constraint": "range",
"description": "Number of CPUs.",
"mandatory": true,
"max": 16,
"min": 1,
"parameter": "vcpu",
"type": "integer"
}
]Authorizations
Response
200 - application/json
List of VM parameter constraints
⌘I