Skip to main content
POST
/
enterprise
/
v1
/
io-cloud
/
vmaas
/
deploy
Deploy VMs
curl --request POST \
  --url https://api.io.solutions/enterprise/v1/io-cloud/vmaas/deploy \
  --header 'Content-Type: application/json' \
  --data '
{
  "resource_private_name": "<string>",
  "duration_hours": 123,
  "gpus_per_vm": 4,
  "hardware_id": 123,
  "ssh_keys": {},
  "node_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "location_ids": [
    "CA",
    "US"
  ],
  "vms_qty": 123,
  "github_ids": [
    "<string>"
  ],
  "vm_image_type": "general",
  "network_services": {}
}
'
import requests

url = "https://api.io.solutions/enterprise/v1/io-cloud/vmaas/deploy"

payload = {
"resource_private_name": "<string>",
"duration_hours": 123,
"gpus_per_vm": 4,
"hardware_id": 123,
"ssh_keys": {},
"node_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"location_ids": ["CA", "US"],
"vms_qty": 123,
"github_ids": ["<string>"],
"vm_image_type": "general",
"network_services": {}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
resource_private_name: '<string>',
duration_hours: 123,
gpus_per_vm: 4,
hardware_id: 123,
ssh_keys: {},
node_pool_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
location_ids: ['CA', 'US'],
vms_qty: 123,
github_ids: ['<string>'],
vm_image_type: 'general',
network_services: {}
})
};

fetch('https://api.io.solutions/enterprise/v1/io-cloud/vmaas/deploy', 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.io.solutions/enterprise/v1/io-cloud/vmaas/deploy",
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([
'resource_private_name' => '<string>',
'duration_hours' => 123,
'gpus_per_vm' => 4,
'hardware_id' => 123,
'ssh_keys' => [

],
'node_pool_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'location_ids' => [
'CA',
'US'
],
'vms_qty' => 123,
'github_ids' => [
'<string>'
],
'vm_image_type' => 'general',
'network_services' => [

]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$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.io.solutions/enterprise/v1/io-cloud/vmaas/deploy"

payload := strings.NewReader("{\n \"resource_private_name\": \"<string>\",\n \"duration_hours\": 123,\n \"gpus_per_vm\": 4,\n \"hardware_id\": 123,\n \"ssh_keys\": {},\n \"node_pool_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"location_ids\": [\n \"CA\",\n \"US\"\n ],\n \"vms_qty\": 123,\n \"github_ids\": [\n \"<string>\"\n ],\n \"vm_image_type\": \"general\",\n \"network_services\": {}\n}")

req, _ := http.NewRequest("POST", url, payload)

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.io.solutions/enterprise/v1/io-cloud/vmaas/deploy")
.header("Content-Type", "application/json")
.body("{\n \"resource_private_name\": \"<string>\",\n \"duration_hours\": 123,\n \"gpus_per_vm\": 4,\n \"hardware_id\": 123,\n \"ssh_keys\": {},\n \"node_pool_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"location_ids\": [\n \"CA\",\n \"US\"\n ],\n \"vms_qty\": 123,\n \"github_ids\": [\n \"<string>\"\n ],\n \"vm_image_type\": \"general\",\n \"network_services\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.io.solutions/enterprise/v1/io-cloud/vmaas/deploy")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"resource_private_name\": \"<string>\",\n \"duration_hours\": 123,\n \"gpus_per_vm\": 4,\n \"hardware_id\": 123,\n \"ssh_keys\": {},\n \"node_pool_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"location_ids\": [\n \"CA\",\n \"US\"\n ],\n \"vms_qty\": 123,\n \"github_ids\": [\n \"<string>\"\n ],\n \"vm_image_type\": \"general\",\n \"network_services\": {}\n}"

response = http.request(request)
puts response.read_body

Headers

x-api-key
string

io.net provided API Key

Body

application/json
resource_private_name
string
required
duration_hours
integer
required
Required range: x <= 8760
gpus_per_vm
integer
required
Required range: 1 <= x <= 8
hardware_id
required
ssh_keys
SSH Keys · object | null
node_pool_id
string<uuid> | null

ID of private node pool. Can't be used if location_ids are provided.

location_ids
(integer | string)[] | null

Only single locations is supported for now

Required array length: 1 element
Example:
["CA", "US"]
vms_qty
integer | null
deprecated

How many VMs should be deployed. (deprecated)

github_ids
string[] | null
vm_image_type
enum<string>
default:general
Available options:
general,
datascience
network_services
Network Services · object

Response

Successful Response