Command

Run a shell command

PUT /{applianceId}/system/execute

Execute a Shell Command

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

Path parameters

applianceId string Required: .Body parameters

command string Required

curl

curl -X PUT "https://appliance.example.com/api/v1/{applianceId}/system/execute" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "command": "<command>"
}'

PHP

<?php

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

$payload = [
    'command' => '<command>',
];

$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 = {
    "command": "<command>"
}

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

JavaScript

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

const data = await response.json();

Response

{
  "status": "success",
  "message": "Command Has Run Successfully",
  "data": [
    "1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1",
    "    link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00",
    "    inet 127.0.0.1/8 scope host lo",
    "       valid_lft forever preferred_lft forever",
    "    inet6 ::1/128 scope host",
    "       valid_lft forever preferred_lft forever",
    "2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000",
    "    link/ether 00:50:87:ff:00:71 brd ff:ff:ff:ff:ff:ff",
    "    inet 192.168.105.21/18 brd 192.168.127.255 scope global eth0",
    "       valid_lft forever preferred_lft forever",
    "    inet6 fe80::250:87ff:feff:71/64 scope link",
    "       valid_lft forever preferred_lft forever",
    "3: eth1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000",
    "    link/ether 00:50:87:ff:00:94 brd ff:ff:ff:ff:ff:ff",
    "    inet6 fe80::250:87ff:feff:94/64 scope link",
    "       valid_lft forever preferred_lft forever",
    "4: eth2: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000",
    "    link/ether 00:50:87:ff:00:1d brd ff:ff:ff:ff:ff:ff",
    "    inet6 fe80::250:87ff:feff:1d/64 scope link",
    "       valid_lft forever preferred_lft forever",
    "5: eth3: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000",
    "    link/ether 00:50:87:ff:00:81 brd ff:ff:ff:ff:ff:ff",
    "    inet6 fe80::250:87ff:feff:81/64 scope link",
    "       valid_lft forever preferred_lft forever"
  ]
}