Create a machine image from a stopped VM

POST /project/{project_id}/location/{location}/machine-image/{machine_image_reference}

Create a machine image from a stopped VM

cURL

curl --request POST \
  --url https://api.ubicloud.com/project/{project_id}/location/{location}/machine-image/{machine_image_reference} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vm": "<string>",
  "version": "<string>",
  "destroy_source": true
}
'

import requests

url = "https://api.ubicloud.com/project/{project_id}/location/{location}/machine-image/{machine_image_reference}"

payload = {
    "vm": "<string>",
    "version": "<string>",
    "destroy_source": True
}
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({vm: '<string>', version: '<string>', destroy_source: true})
};

fetch('https://api.ubicloud.com/project/{project_id}/location/{location}/machine-image/{machine_image_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}/machine-image/{machine_image_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([
    'vm' => '<string>',
    'version' => '<string>',
    'destroy_source' => true
  ]),
  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}/machine-image/{machine_image_reference}"

	payload := strings.NewReader("{\n  \"vm\": \"<string>\",\n  \"version\": \"<string>\",\n  \"destroy_source\": true\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}/machine-image/{machine_image_reference}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"vm\": \"<string>\",\n  \"version\": \"<string>\",\n  \"destroy_source\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ubicloud.com/project/{project_id}/location/{location}/machine-image/{machine_image_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  \"vm\": \"<string>\",\n  \"version\": \"<string>\",\n  \"destroy_source\": true\n}"

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

200

{
  "id": "m1n30gjk1d1e2jj34v9x0dq4rp",
  "name": "my-image",
  "location": "eu-central-h1",
  "created_at": "2023-11-07T05:31:56Z",
  "latest_version": "<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

machine_image_reference · string · required

Name for a new machine image (UBID format not allowed)

Pattern: ^(?!m1[0-9a-hj-km-np-tv-z]{24}$)[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

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"

Body

application/json

vm · string · required

UBID of the source VM

version · string

Version label (default is a timestamp)

destroy_source · boolean

Destroy the source VM after capture

Response

200

application/json

A machine image

id · string · required

ID of the machine image

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

Example:

"m1n30gjk1d1e2jj34v9x0dq4rp"

name · string · required

Name of the machine image

Example:

"my-image"

location · string · required

Location of the machine image

Example:

"eu-central-h1"

arch · enum<string> · required

Architecture

Available options: x64, arm64

created_at · string<date-time> · required

Creation timestamp

latest_version · string | null

Latest version label