Filesystem snapshots

A filesystem snapshot captures the whole appliance before a risky change, so it can be rolled back.

Filesystem snapshots

GET /{applianceId}/lvmsnapshots

Get LVM Snapshot info

Path parameters

applianceId string Required: The id of the cluster node the request is for.

curl

curl -X GET "https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots" \
  -H "Authorization: Bearer $TOKEN"

PHP

<?php

$url = 'https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots';
$headers = [
    'Authorization: Bearer ' . $token,
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

Python

import requests

headers = {"Authorization": f"Bearer {token}"}

response = requests.get("https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots", headers=headers)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();

Response

{
  "status": "success",
  "message": "LVM Snapshot",
  "data": {
    "created": "2021-03-02 11:04:32 +0000",
    "status": "available",
    "size": "500.00 MiB",
    "used": "0.02 %"
  }
}

POST /{applianceId}/lvmsnapshots

Create a new LVM Snapshot

This change is staged. Send PUT /services/apply to apply it.

Path parameters

applianceId string Required: The id of the cluster node the request is for.

curl

curl -X POST "https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots" \
  -H "Authorization: Bearer $TOKEN"

PHP

<?php

$url = 'https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots';
$headers = [
    'Authorization: Bearer ' . $token,
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

Python

import requests

headers = {"Authorization": f"Bearer {token}"}

response = requests.post("https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots", headers=headers)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();

Response

{
  "status": "success",
  "message": "LVM Snapshot created"
}

PUT /{applianceId}/lvmsnapshots

Restore a LVM Snapshot

This change is staged. Send PUT /services/apply to apply it.

Path parameters

applianceId string Required: The id of the cluster node the request is for.

Body parameters

reboot boolean default: "true": set to false to manually reboot system

curl

curl -X PUT "https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "reboot": "true"
}'

PHP

<?php

$url = 'https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots';
$headers = [
    'Authorization: Bearer ' . $token,
    'Content-Type: application/json',
];

$payload = [
    'reboot' => 'true',
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS => json_encode($payload),
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

Python

import requests

headers = {"Authorization": f"Bearer {token}"}
payload = {
    "reboot": "true"
}

response = requests.put("https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots", headers=headers, json=payload)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "reboot": "true"
}),
});

const data = await response.json();

Response

{
  "status": "success",
  "message": "success",
  "data": []
}

DELETE /{applianceId}/lvmsnapshots

Delete a LVM Snapshot

This change is staged. Send PUT /services/apply to apply it.

Path parameters

applianceId string Required: The id of the cluster node the request is for.

curl

curl -X DELETE "https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots" \
  -H "Authorization: Bearer $TOKEN"

PHP

<?php

$url = 'https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots';
$headers = [
    'Authorization: Bearer ' . $token,
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

Python

import requests

headers = {"Authorization": f"Bearer {token}"}

response = requests.delete("https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots", headers=headers)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://appliance.example.com/api/v1/{applianceId}/lvmsnapshots', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();

Response

{
  "status": "success",
  "message": "LVM Snapshot deleted"
}