VPS.org API

Pepa Fa'amaumauga o le REST API

API o 'Au'aunaga

Pulea au 'au'aunaga VPS i le fa'apolokalameina. Fausia, fa'atulaga, pulea, ma mata'ituina au 'au'aunaga tumaoti fa'apitoa.

Fa'ai'uga 9
Ala Autu /api/v1/servers
MAUA /api/v1/servers/

Lisi Uma 'Au'aunaga

Toe aumai se lisi o 'au'aunaga uma i lau teugatupe.

Fa'asologa o Fesili

Fa'atulagaga Ituaiga Mana'omia Fa'amatalaga
status manoa Leai Fa'amama e tusa ai ma le tulaga o le 'au'aunaga: galue, taofi, fa'agata
location manoa Leai Fa'amama e tusa ai ma le nofoaga o le nofoaga autu o fa'amaumauga

Talosaga Fa'ata'ita'i

cURL
Python
JavaScript
PHP
curl -X GET "https://admin.vps.org/api/v1/servers/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const servers = await response.json();
console.log(servers);
$ch = curl_init('https://admin.vps.org/api/v1/servers/');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

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

Tali Fa'ata'ita'i

{
  "count": 2,
  "results": [
    {
      "id": 12345,
      "name": "web-server-01",
      "hostname": "web01.example.com",
      "status": "active",
      "ip_address": "203.0.113.10",
      "location": "us-west",
      "plan": {
        "id": 1,
        "name": "Standard VPS",
        "vcpus": 2,
        "memory": 4096,
        "storage": 80
      },
      "os": {
        "id": 5,
        "name": "Ubuntu 22.04 LTS"
      },
      "created_at": "2025-01-10T14:30:00Z",
      "updated_at": "2025-01-15T10:20:00Z"
    },
    {
      "id": 12346,
      "name": "db-server-01",
      "hostname": "db01.example.com",
      "status": "active",
      "ip_address": "203.0.113.11",
      "location": "us-east",
      "plan": {
        "id": 2,
        "name": "Performance VPS",
        "vcpus": 4,
        "memory": 8192,
        "storage": 160
      },
      "os": {
        "id": 3,
        "name": "Debian 12"
      },
      "created_at": "2025-01-12T09:15:00Z",
      "updated_at": "2025-01-16T08:45:00Z"
    }
  ]
}

Fa'ailoga o Tulaga o Tali

200 Ua manuia le toe maua mai o le lisi o le 'au'aunaga
401 E le'i fa'atagaina - Fa'ailoga API e le aoga pe ua misi
FA'AMATALAGA /api/v1/servers/

Fausia se 'Au'aunaga Fou

Fa'atulaga se 'au'aunaga VPS fou fa'atasi ai ma le fa'atulagaga ua fa'amaoti mai.

Talosaga mo Fa'atulagaga o le Tino

Fa'atulagaga Ituaiga Mana'omia Fa'amatalaga
name manoa Ioe Igoa o le 'au'aunaga (alphanumeric, fa'atagaina hyphens)
plan_id numera atoa Ioe ID o le fuafuaga VPS
os_id numera atoa Ioe ID o le faiga fa'aoga
location manoa Ioe Fa'ailoga o le nofoaga o le nofoaga autu o fa'amaumauga
hostname manoa Leai Igoa o le 'au'aunaga (FQDN)
ssh_key_id numera atoa Leai SSH key ID e fa'apipi'i ai
backups_enabled boolean Leai Fa'agaoioia fa'amaumauga fa'aleoleo otometi (fa'aletonu: sese)

Talosaga Fa'ata'ita'i

cURL
Python
JavaScript
PHP
curl -X POST "https://admin.vps.org/api/v1/servers/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "web-server-02",
    "plan_id": 1,
    "os_id": 5,
    "location": "us-west",
    "hostname": "web02.example.com",
    "backups_enabled": true
  }'
import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "name": "web-server-02",
    "plan_id": 1,
    "os_id": 5,
    "location": "us-west",
    "hostname": "web02.example.com",
    "backups_enabled": True
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'web-server-02',
    plan_id: 1,
    os_id: 5,
    location: 'us-west',
    hostname: 'web02.example.com',
    backups_enabled: true
  })
});

const server = await response.json();
console.log(server);
$data = [
    'name' => 'web-server-02',
    'plan_id' => 1,
    'os_id' => 5,
    'location' => 'us-west',
    'hostname' => 'web02.example.com',
    'backups_enabled' => true
];

$ch = curl_init('https://admin.vps.org/api/v1/servers/');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

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

Tali Fa'ata'ita'i

{
  "id": 12347,
  "name": "web-server-02",
  "hostname": "web02.example.com",
  "status": "provisioning",
  "ip_address": null,
  "location": "us-west",
  "plan": {
    "id": 1,
    "name": "Standard VPS",
    "vcpus": 2,
    "memory": 4096,
    "storage": 80
  },
  "os": {
    "id": 5,
    "name": "Ubuntu 22.04 LTS"
  },
  "backups_enabled": true,
  "created_at": "2025-01-16T15:30:00Z",
  "updated_at": "2025-01-16T15:30:00Z",
  "message": "Server is being provisioned. This may take 2-5 minutes."
}

Fa'ailoga o Tulaga o Tali

201 Ua manuia le fausiaina o le 'au'aunaga
400 Talosaga Leaga - Fa'atulagaga le aoga
401 E le'i fa'atagaina - Fa'ailoga API e le aoga pe ua misi
402 Totogi e Mana'omia - E le lava aitalafu
MAUA /api/v1/servers/{server_id}/

Maua Fa'amatalaga o le 'Au'aunaga

Toe maua faʻamatalaga auiliili e uiga i se server faapitoa.

Fa'asologa o Ala

Fa'atulagaga Ituaiga Mana'omia Fa'amatalaga
server_id numera atoa Ioe ID tulaga ese o le 'au'aunaga

Talosaga Fa'ata'ita'i

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/servers/12345/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())
const serverId = 12345;
const response = await fetch(`https://admin.vps.org/api/v1/servers/${serverId}/`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const server = await response.json();
console.log(server);

Tali Fa'ata'ita'i

{
  "id": 12345,
  "name": "web-server-01",
  "hostname": "web01.example.com",
  "status": "active",
  "ip_address": "203.0.113.10",
  "ipv6_address": "2001:0db8::1",
  "location": "us-west",
  "plan": {
    "id": 1,
    "name": "Standard VPS",
    "vcpus": 2,
    "memory": 4096,
    "storage": 80,
    "bandwidth": 2048
  },
  "os": {
    "id": 5,
    "name": "Ubuntu 22.04 LTS"
  },
  "backups_enabled": true,
  "resource_usage": {
    "cpu_percent": 23.5,
    "memory_used": 2048,
    "disk_used": 35,
    "bandwidth_used": 450
  },
  "created_at": "2025-01-10T14:30:00Z",
  "updated_at": "2025-01-16T15:45:00Z"
}

Fa'ailoga o Tulaga o Tali

200 Ua manuia le toe maua mai o fa'amatalaga o le 'au'aunaga
401 E le'i fa'atagaina - Fa'ailoga API e le aoga pe ua misi
404 E le'i Maua - E leai se 'Au'aunaga
TU'U /api/v1/servers/{server_id}/

Fa'afou le 'Au'aunaga

Fa'afou le fa'atulagaga o le 'au'aunaga. E mana'omia avanoa uma.

Fa'asologa o Ala

Parameter Type Required Description
server_id integer Yes ID tulaga ese o le 'au'aunaga

Talosaga mo Fa'atulagaga o le Tino

Fa'atulagaga Ituaiga Mana'omia Fa'amatalaga
name manoa Ioe Igoa o le 'au'aunaga
hostname manoa Ioe Igoa o le 'au'aunaga (FQDN)
backups_enabled boolean Ioe Fa'agaoioia/fa'agata fa'amaumauga otometi

Talosaga Fa'ata'ita'i

cURL
Python
curl -X PUT "https://admin.vps.org/api/v1/servers/12345/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "web-server-updated",
    "hostname": "web-updated.example.com",
    "backups_enabled": true
  }'
import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "name": "web-server-updated",
    "hostname": "web-updated.example.com",
    "backups_enabled": True
}

response = requests.put(url, headers=headers, json=data)
print(response.json())

Fa'ailoga o Tulaga o Tali

200 Ua manuia le fa'afouina o le 'au'aunaga
400 Talosaga Leaga - Fa'atulagaga le aoga
404 E le'i Maua - E leai se 'Au'aunaga
PAPA'I /api/v1/servers/{server_id}/

Fa'afou Fa'aitiiti le 'Au'aunaga

Fa'afou fanua fa'apitoa o le 'au'aunaga. Na'o fanua ua tu'uina atu o le a fa'afouina.

Talosaga Fa'ata'ita'i

cURL
Python
curl -X PATCH "https://admin.vps.org/api/v1/servers/12345/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "new-server-name"
  }'
import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {"name": "new-server-name"}

response = requests.patch(url, headers=headers, json=data)
print(response.json())
TAPE'E /api/v1/servers/{server_id}/

Tape le 'Au'aunaga

Tape tumau se 'au'aunaga. E le mafai ona toe fa'aleaogaina lenei gaioiga.

Talosaga Fa'ata'ita'i

cURL
Python
curl -X DELETE "https://admin.vps.org/api/v1/servers/12345/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.delete(url, headers=headers)
print(response.status_code)

Fa'ailoga o Tulaga o Tali

204 Ua manuia le tapeina o le 'au'aunaga
404 E le'i Maua - E leai se 'Au'aunaga
FA'AMATALAGA /api/v1/servers/{server_id}/start/

Amata le 'Au'aunaga

Fa'aola le 'au'aunaga ua taofia.

Talosaga Fa'ata'ita'i

cURL
Python
JavaScript
curl -X POST "https://admin.vps.org/api/v1/servers/12345/start/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/start/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers)
print(response.json())
const serverId = 12345;
const response = await fetch(`https://admin.vps.org/api/v1/servers/${serverId}/start/`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const result = await response.json();
console.log(result);

Tali Fa'ata'ita'i

{
  "status": "success",
  "message": "Server is starting",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "starting"
  }
}

Fa'ailoga o Tulaga o Tali

200 Ua manuia le auina atu o le poloaiga e amata ai le 'au'aunaga
400 Talosaga Leaga - Ua uma ona fa'agaoioia le 'Au'aunaga
404 E le'i Maua - E leai se 'Au'aunaga
FA'AMATALAGA /api/v1/servers/{server_id}/stop/

Taofi le 'Au'aunaga

Tapuni ma le agalelei se 'au'aunaga o lo'o fa'agaoioia.

Talosaga Fa'ata'ita'i

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/12345/stop/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/stop/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

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

Tali Fa'ata'ita'i

{
  "status": "success",
  "message": "Server is stopping",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "stopping"
  }
}
FA'AMATALAGA /api/v1/servers/{server_id}/reboot/

Toe amata le 'Au'aunaga

Toe amata ma le agalelei se 'au'aunaga o lo'o tamo'e.

Talosaga Fa'ata'ita'i

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/12345/reboot/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/reboot/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

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

Tali Fa'ata'ita'i

{
  "status": "success",
  "message": "Server is rebooting",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "rebooting"
  }
}

Fa'ailoga o Tulaga o Tali

200 Ua manuia le auina atu o le poloaiga toe amata o le 'au'aunaga
400 Talosaga Leaga - E le o galue le 'Au'aunaga
404 E le'i Maua - E leai se 'Au'aunaga