Save VM disk as custom image
curl --request POST \
--url https://api.rafftechnologies.com/api/v1/vms/{id}/save-image \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'X-Project-ID: <x-project-id>' \
--data '
{
"name": "web-server-baseline",
"description": "<string>",
"disk_id": 0,
"snapshot_id": -1
}
'import requests
url = "https://api.rafftechnologies.com/api/v1/vms/{id}/save-image"
payload = {
"name": "web-server-baseline",
"description": "<string>",
"disk_id": 0,
"snapshot_id": -1
}
headers = {
"X-Project-ID": "<x-project-id>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Project-ID': '<x-project-id>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'web-server-baseline',
description: '<string>',
disk_id: 0,
snapshot_id: -1
})
};
fetch('https://api.rafftechnologies.com/api/v1/vms/{id}/save-image', 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.rafftechnologies.com/api/v1/vms/{id}/save-image",
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([
'name' => 'web-server-baseline',
'description' => '<string>',
'disk_id' => 0,
'snapshot_id' => -1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>",
"X-Project-ID: <x-project-id>"
],
]);
$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.rafftechnologies.com/api/v1/vms/{id}/save-image"
payload := strings.NewReader("{\n \"name\": \"web-server-baseline\",\n \"description\": \"<string>\",\n \"disk_id\": 0,\n \"snapshot_id\": -1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Project-ID", "<x-project-id>")
req.Header.Add("X-API-Key", "<api-key>")
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.rafftechnologies.com/api/v1/vms/{id}/save-image")
.header("X-Project-ID", "<x-project-id>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"web-server-baseline\",\n \"description\": \"<string>\",\n \"disk_id\": 0,\n \"snapshot_id\": -1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rafftechnologies.com/api/v1/vms/{id}/save-image")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Project-ID"] = '<x-project-id>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"web-server-baseline\",\n \"description\": \"<string>\",\n \"disk_id\": 0,\n \"snapshot_id\": -1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"region": "us-east",
"version": "<string>",
"description": "<string>",
"os_type": "<string>",
"is_windows": true,
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Resize & images
Save VM disk as custom image
Save a VM’s disk (live state or a snapshot) as a reusable custom OS image. The new image becomes available alongside the public OS templates and can be passed as template_id when creating a new VM.
Sources
Pick what to capture with disk_id and snapshot_id:
disk_id: 0— the OS diskdisk_id: 1+— an attached volumesnapshot_id: -1— capture the current live disk state (stop the VM first for a consistent image)snapshot_id: <id>— capture from a specific saved snapshot
POST
/
api
/
v1
/
vms
/
{id}
/
save-image
Save VM disk as custom image
curl --request POST \
--url https://api.rafftechnologies.com/api/v1/vms/{id}/save-image \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'X-Project-ID: <x-project-id>' \
--data '
{
"name": "web-server-baseline",
"description": "<string>",
"disk_id": 0,
"snapshot_id": -1
}
'import requests
url = "https://api.rafftechnologies.com/api/v1/vms/{id}/save-image"
payload = {
"name": "web-server-baseline",
"description": "<string>",
"disk_id": 0,
"snapshot_id": -1
}
headers = {
"X-Project-ID": "<x-project-id>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Project-ID': '<x-project-id>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'web-server-baseline',
description: '<string>',
disk_id: 0,
snapshot_id: -1
})
};
fetch('https://api.rafftechnologies.com/api/v1/vms/{id}/save-image', 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.rafftechnologies.com/api/v1/vms/{id}/save-image",
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([
'name' => 'web-server-baseline',
'description' => '<string>',
'disk_id' => 0,
'snapshot_id' => -1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>",
"X-Project-ID: <x-project-id>"
],
]);
$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.rafftechnologies.com/api/v1/vms/{id}/save-image"
payload := strings.NewReader("{\n \"name\": \"web-server-baseline\",\n \"description\": \"<string>\",\n \"disk_id\": 0,\n \"snapshot_id\": -1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Project-ID", "<x-project-id>")
req.Header.Add("X-API-Key", "<api-key>")
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.rafftechnologies.com/api/v1/vms/{id}/save-image")
.header("X-Project-ID", "<x-project-id>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"web-server-baseline\",\n \"description\": \"<string>\",\n \"disk_id\": 0,\n \"snapshot_id\": -1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rafftechnologies.com/api/v1/vms/{id}/save-image")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Project-ID"] = '<x-project-id>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"web-server-baseline\",\n \"description\": \"<string>\",\n \"disk_id\": 0,\n \"snapshot_id\": -1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"region": "us-east",
"version": "<string>",
"description": "<string>",
"os_type": "<string>",
"is_windows": true,
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Updated May 8, 2026
Authorizations
API key for authentication. Each key is bound to a specific account.
Headers
Project ID. Required for all mutating operations (create, delete, power actions, resize).
Path Parameters
VM ID (UUID)
Body
application/json
Custom image name.
Required string length:
1 - 128Example:
"web-server-baseline"
Optional description for the saved image.
Which disk to capture. 0 for the OS disk, 1+ for attached volumes.
Source for the image. -1 captures the current live disk state. Pass a snapshot ID to capture from a saved snapshot.
Last modified on May 8, 2026