Skip to main content
POST
/
project
/
{project_id}
/
location
/
{location}
/
machine-image
/
{machine_image_reference}
Create a machine image from a stopped VM
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
}
'
{
  "id": "m1n30gjk1d1e2jj34v9x0dq4rp",
  "name": "my-image",
  "location": "eu-central-h1",
  "created_at": "2023-11-07T05:31:56Z",
  "latest_version": "<string>"
}

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

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