Create a new VM

POST /project/{project_id}/location/{location}/vm/{vm_reference}

Create a new VM

cURL

curl --request POST \
  --url https://api.ubicloud.com/project/{project_id}/location/{location}/vm/{vm_reference} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "public_key": "<string>",
  "boot_image": "<string>",
  "init_script": "<string>",
  "enable_ip4": true,
  "private_subnet_id": "<string>",
  "size": "<string>",
  "storage_size": 123,
  "gpu": "<string>",
  "unix_user": "<string>"
}
'

import requests

url = "https://api.ubicloud.com/project/{project_id}/location/{location}/vm/{vm_reference}"

payload = {
    "public_key": "<string>",
    "boot_image": "<string>",
    "init_script": "<string>",
    "enable_ip4": True,
    "private_subnet_id": "<string>",
    "size": "<string>",
    "storage_size": 123,
    "gpu": "<string>",
    "unix_user": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    public_key: '<string>',
    boot_image: '<string>',
    init_script: '<string>',
    enable_ip4: true,
    private_subnet_id: '<string>',
    size: '<string>',
    storage_size: 123,
    gpu: '<string>',
    unix_user: '<string>'
  })
};

fetch('https://api.ubicloud.com/project/{project_id}/location/{location}/vm/{vm_reference}', 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.ubicloud.com/project/{project_id}/location/{location}/vm/{vm_reference}",
  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([
    'public_key' => '<string>',
    'boot_image' => '<string>',
    'init_script' => '<string>',
    'enable_ip4' => true,
    'private_subnet_id' => '<string>',
    'size' => '<string>',
    'storage_size' => 123,
    'gpu' => '<string>',
    'unix_user' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.ubicloud.com/project/{project_id}/location/{location}/vm/{vm_reference}"

	payload := strings.NewReader("{\n  \"public_key\": \"<string>\",\n  \"boot_image\": \"<string>\",\n  \"init_script\": \"<string>\",\n  \"enable_ip4\": true,\n  \"private_subnet_id\": \"<string>\",\n  \"size\": \"<string>\",\n  \"storage_size\": 123,\n  \"gpu\": \"<string>\",\n  \"unix_user\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.ubicloud.com/project/{project_id}/location/{location}/vm/{vm_reference}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"public_key\": \"<string>\",\n  \"boot_image\": \"<string>\",\n  \"init_script\": \"<string>\",\n  \"enable_ip4\": true,\n  \"private_subnet_id\": \"<string>\",\n  \"size\": \"<string>\",\n  \"storage_size\": 123,\n  \"gpu\": \"<string>\",\n  \"unix_user\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ubicloud.com/project/{project_id}/location/{location}/vm/{vm_reference}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"public_key\": \"<string>\",\n  \"boot_image\": \"<string>\",\n  \"init_script\": \"<string>\",\n  \"enable_ip4\": true,\n  \"private_subnet_id\": \"<string>\",\n  \"size\": \"<string>\",\n  \"storage_size\": 123,\n  \"gpu\": \"<string>\",\n  \"unix_user\": \"<string>\"\n}"

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

200

{
  "boot_image": "<string>",
  "id": "vmhfy8gff8c67hasb0eez2k1pd",
  "ip4": "127.0.0.1",
  "ip4_enabled": true,
  "ip6": "2606:4700:3108::ac42:2835",
  "location": "eu-central-h1",
  "name": "my-vm-name",
  "size": "<string>",
  "state": "<string>",
  "storage_size_gib": 123,
  "unix_user": "<string>",
  "firewalls": [
    {
      "description": "<string>",
      "firewall_rules": [
        {
          "cidr": "<string>",
          "id": "fraz0q3vbrpa7pkg7zbmah9csn",
          "port_range": "<string>",
          "description": "<string>"
        }
      ],
      "id": "fwfg7td83em22qfw9pq5xyfqb7",
      "location": "<string>",
      "name": "<string>"
    }
  ],
  "private_ipv4": "127.0.0.1",
  "private_ipv6": "2606:4700:3108::ac42:2835",
  "subnet": "<string>",
  "gpu": "<string>"
}

{
  "error": {
    "code": 401,
    "message": "There was an error logging in",
    "type": "InvalidCredentials",
    "details": {}
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

project_id · string · required

ID of the project

Pattern: ^pj[0-9a-hj-km-np-tv-z]{24}$

Example:

"pjkkmx0f2vke4h36nk9cm8v8q0"

location · string · required

The Ubicloud location/region

Example:

"eu-central-h1"

vm_reference · string · required

Virtual machine ID or name Resource ID or name

Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

Body

application/json

public_key · string · required

Public SSH key for the VM, or name of registered SSH public key

boot_image · string

Boot image of the VM

init_script · string

VM init script

enable_ip4 · boolean

Enable IPv4

private_subnet_id · string

ID of the private subnet

size · string

Size of the VM

storage_size · integer

Requested storage size in GiB

gpu · string

Requested GPU count and type, in the form of "count:type"

unix_user · string

Unix user of the VM

Response

200

application/json

A VM

boot_image · string · required

Boot image of the VM

id · string · required

ID of the VM

Pattern: ^vm[0-9a-hj-km-np-tv-z]{24}$

Example:

"vmhfy8gff8c67hasb0eez2k1pd"

ip4 · string<ipv4> | null · required

IPv4 address

ip4_enabled · boolean · required

Whether IPv4 is enabled

ip6 · string<ipv6> | null · required

IPv6 address

location · string · required

Location of the VM

Example:

"eu-central-h1"

name · string · required

Name of the VM

Example:

"my-vm-name"

size · string · required

Size of the underlying VM

state · string · required

State of the VM

storage_size_gib · integer · required

Storage size in GiB

unix_user · string · required

Unix user of the VM

firewalls · object[] · required

List of firewalls

Show child attributes

private_ipv4 · string<ipv4> · required

Private IPv4 address

private_ipv6 · string<ipv6> · required

Private IPv6 address

subnet · string · required

Subnet of the VM

gpu · string

GPU configuration