Create a snapshot

POST/compute/{connection_id}/snapshot

Parameters

Payload

idstring

Unique identifier for the snapshot

created_atdate-time

When the snapshot was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate-time

When the snapshot was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

Display name of the snapshot

instance_idstring

The instance the snapshot was taken from

volume_idstring

The volume the snapshot was taken from

type enum

Valid values:

"MEMORY"

"DISK"

"OTHER"

Whether memory state is included

status enum

Valid values:

"CREATING"

"READY"

"FAILED"

"DELETING"

"OTHER"

Normalized snapshot status

size_mbnumber

Snapshot size in MiB

expires_atdate-time

When the snapshot will be deleted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

metadata array

Vendor labels, tags and metadata

raw

Raw data from integration

Returns

ComputeSnapshot

Response field	Type	Required	Description
`id`	string	No	Unique identifier for the snapshot
`created_at`	string (date-time)	No	When the snapshot was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	When the snapshot was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`name`	string	No	Display name of the snapshot
`instance_id`	string	No	The instance the snapshot was taken from
`volume_id`	string	No	The volume the snapshot was taken from
`type`	enum	No	Whether memory state is included Values: `MEMORY`, `DISK`, `OTHER`
`status`	enum	No	Normalized snapshot status Values: `CREATING`, `READY`, `FAILED`, `DELETING`, `OTHER`
`size_mb`	number	No	Snapshot size in MiB
`expires_at`	string (date-time)	No	When the snapshot will be deleted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`metadata`	ComputeMetadata[]	No	Vendor labels, tags and metadata
`metadata[].id`	string	No
`metadata[].slug`	string	No	The label, tag or metadata key
`metadata[].value`	object	No	The label, tag or metadata value
`metadata[].namespace`	string	No	The origin of the value (eg. labels, tags, metadata)
`metadata[].format`	enum	No	The data type of the value Values: `TEXT`, `NUMBER`, `DATE`, `BOOLEAN`, `ARRAY`, `OBJECT`
`metadata[].extra_data`	object	No

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'POST',
  url: 'https://api.unified.to/compute/5de520f96e439b002043d8dc/snapshot',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const results = await sdk.compute.createComputeSnapshot({ connectionId, computeSnapshot: { }, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'POST',
  url: 'https://api.unified.to/compute/5de520f96e439b002043d8dc/snapshot',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("POST", "https://api.unified.to/compute/5de520f96e439b002043d8dc/snapshot?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/compute/5de520f96e439b002043d8dc/snapshot?fields=&raw=

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

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/compute/5de520f96e439b002043d8dc/snapshot?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

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

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/compute/5de520f96e439b002043d8dc/snapshot?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/compute/5de520f96e439b002043d8dc/snapshot?fields=&raw=")

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

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

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

cURL

curl --request POST \
  --url 'https://api.unified.to/compute/5de520f96e439b002043d8dc/snapshot?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?