Support

Download a support archive

GET /{applianceId}/support/download/file/{filename}

Download the support archive file

Path parameters

applianceId string Required
filename string Required

curl

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

PHP

<?php

$url = 'https://appliance.example.com/api/v1/{applianceId}/support/download/file/{filename}';
$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}/support/download/file/{filename}", headers=headers)
response.raise_for_status()
print(response.json())

JavaScript

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

const data = await response.json();

Response

{
  "status": "success",
  "message": "…",
  "data": {}
}

Create a support archive

GET /{applianceId}/support/download/{option}

Create support archive depending on available space

Path parameters

applianceId string Required
option string Required

curl

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

PHP

<?php

$url = 'https://appliance.example.com/api/v1/{applianceId}/support/download/{option}';
$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}/support/download/{option}", headers=headers)
response.raise_for_status()
print(response.json())

JavaScript

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

const data = await response.json();

Response

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

Get the support archive status

GET /{applianceId}/support/status

Get support status

Path parameters

applianceId string Required

curl

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

PHP

<?php

$url = 'https://appliance.example.com/api/v1/{applianceId}/support/status';
$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}/support/status", headers=headers)
response.raise_for_status()
print(response.json())

JavaScript

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

const data = await response.json();

Response

{
  "status": "success",
  "message": "System status",
  "data": {
    "memory": {
      "total": "1023956",
      "used": "90344",
      "free": "170280"
    },
    "swap": {
      "total": "0",
      "used": "0",
      "free": "0"
    },
    "disks": [
      {
        "filesystem": "/dev/sda1",
        "size": "2.3G",
        "used": "1.3G",
        "avail": "918M",
        "use": "58%",
        "mounted": "/"
      },
      {
        "filesystem": "devtmpfs",
        "size": "494M",
        "used": "0",
        "avail": "494M",
        "use": "0%",
        "mounted": "/dev"
      },
      {
        "filesystem": "tmpfs",
        "size": "500M",
        "used": "0",
        "avail": "500M",
        "use": "0%",
        "mounted": "/dev/shm"
      },
      {
        "filesystem": "tmpfs",
        "size": "500M",
        "used": "0",
        "avail": "500M",
        "use": "0%",
        "mounted": "/sys/fs/cgroup"
      },
      {
        "filesystem": "tmpfs",
        "size": "500M",
        "used": "540K",
        "avail": "500M",
        "use": "1%",
        "mounted": "/run"
      },
      {
        "filesystem": "/dev/sda2",
        "size": "5.5G",
        "used": "173M",
        "avail": "5.0G",
        "use": "4%",
        "mounted": "/var/log"
      }
    ]
  }
}