Servers API - VPS.org

ZÍSKAŤ /api/v1/servers/

Zoznam všetkých serverov

Získajte zoznam všetkých serverov vo vašom účte.

Parametre dopytu

Parameter	Typ	Povinné	Popis
`status`	reťazec	Nie	Filtrovať podľa stavu servera: aktívny, zastavený, pozastavený
`location`	reťazec	Nie	Filtrovať podľa umiestnenia dátového centra

Príklad žiadosti

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);

Príklad odpovede

{
  "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"
    }
  ]
}

Kódy stavu odpovede

200	Zoznam serverov bol úspešne načítaný
401	Neoprávnené – neplatný alebo chýbajúci token API

POŠTA /api/v1/servers/

Vytvoriť nový server

Nasaďte nový VPS server so zadanou konfiguráciou.

Parametre tela požiadavky

Parameter	Typ	Povinné	Popis
`name`	reťazec	Áno	Názov servera (alfanumerický, povolené sú aj pomlčky)
`plan_id`	celé číslo	Áno	ID VPS plánu
`os_id`	celé číslo	Áno	ID operačného systému
`location`	reťazec	Áno	Kód umiestnenia dátového centra
`hostname`	reťazec	Nie	Názov hostiteľa servera (FQDN)
`ssh_key_id`	celé číslo	Nie	ID SSH kľúča na inštaláciu
`backups_enabled`	boolovská hodnota	Nie	Povoliť automatické zálohovanie (predvolené: false)

Príklad žiadosti

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);

Príklad odpovede

{
  "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."
}

Kódy stavu odpovede

201	Server bol úspešne vytvorený
400	Neplatná požiadavka – neplatné parametre
401	Neoprávnené – neplatný alebo chýbajúci token API
402	Požadovaná platba - Nedostatočný kredit

ZÍSKAŤ /api/v1/servers/{server_id}/

Získať podrobnosti o serveri

Získajte podrobné informácie o konkrétnom serveri.

Parametre cesty

Parameter	Typ	Povinné	Popis
`server_id`	celé číslo	Áno	Jedinečné ID servera

Príklad žiadosti

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);

Príklad odpovede

{
  "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"
}

Kódy stavu odpovede

200	Údaje o serveri boli úspešne načítané
401	Neoprávnené – neplatný alebo chýbajúci token API
404	Nenájdené - Server neexistuje

VLOŽIŤ /api/v1/servers/{server_id}/

Aktualizačný server

Aktualizovať konfiguráciu servera. Všetky polia sú povinné.

Parametre cesty

Parameter	Type	Required	Description
`server_id`	integer	Yes	Jedinečné ID servera

Parametre tela požiadavky

Parameter	Typ	Povinné	Popis
`name`	reťazec	Áno	Názov servera
`hostname`	reťazec	Áno	Názov hostiteľa servera (FQDN)
`backups_enabled`	boolovská hodnota	Áno	Povoliť/zakázať automatické zálohovanie

Príklad žiadosti

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())

Kódy stavu odpovede

200	Server bol úspešne aktualizovaný
400	Neplatná požiadavka – neplatné parametre
404	Nenájdené - Server neexistuje

NÁPLAŤ /api/v1/servers/{server_id}/

Čiastočne aktualizovať server

Aktualizovať konkrétne polia servera. Aktualizované budú iba zadané polia.

Príklad žiadosti

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())

ODSTRÁNIŤ /api/v1/servers/{server_id}/

Odstrániť server

Trvalo odstrániť server. Túto akciu nie je možné vrátiť späť.

Príklad žiadosti

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)

Kódy stavu odpovede

204	Server bol úspešne odstránený
404	Nenájdené - Server neexistuje

POŠTA /api/v1/servers/{server_id}/start/

Spustiť server

Zapnite zastavený server.

Príklad žiadosti

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);

Príklad odpovede

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

Kódy stavu odpovede

200	Príkaz na spustenie servera bol úspešne odoslaný
400	Nesprávna požiadavka - Server už beží
404	Nenájdené - Server neexistuje

POŠTA /api/v1/servers/{server_id}/stop/

Zastaviť server

Elegantne vypnite bežiaci server.

Príklad žiadosti

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())

Príklad odpovede

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

POŠTA /api/v1/servers/{server_id}/reboot/

Reštartujte server

Elegantne reštartujte spustený server.

Príklad žiadosti

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())

Príklad odpovede

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

Kódy stavu odpovede

200	Príkaz na reštart servera bol úspešne odoslaný
400	Nesprávna požiadavka - Server nie je spustený
404	Nenájdené - Server neexistuje

VPS.org API

API serverov

Zoznam všetkých serverov

Parametre dopytu

Príklad žiadosti

Príklad odpovede

Kódy stavu odpovede

Vytvoriť nový server

Parametre tela požiadavky

Príklad žiadosti

Príklad odpovede

Kódy stavu odpovede

Získať podrobnosti o serveri

Parametre cesty

Príklad žiadosti

Príklad odpovede

Kódy stavu odpovede

Aktualizačný server

Parametre cesty

Parametre tela požiadavky

Príklad žiadosti

Kódy stavu odpovede

Čiastočne aktualizovať server

Príklad žiadosti

Odstrániť server

Príklad žiadosti

Kódy stavu odpovede

Spustiť server

Príklad žiadosti

Príklad odpovede

Kódy stavu odpovede

Zastaviť server

Príklad žiadosti

Príklad odpovede

Reštartujte server

Príklad žiadosti

Príklad odpovede

Kódy stavu odpovede