Loo, kontrollida, võimu, suuruse muutmise ja kustutada oma VPS serverid. Servereid identifitseerib nende uudi.
Tagastab serverid konto uusim esimene, 25 lehe kohta. Kustutatavaid servereid ei ole.
Nõutav luba: servers:list
| Parameter | Tüüp | Nõutav | Description |
|---|---|---|---|
page |
integer | No | Lehekülje number, alates 1 |
page_size |
integer | No | Tulemused lehe kohta (vaikimisi 25, maksimaalselt 100) |
curl -X GET "https://admin.vps.org/api/v1/servers/" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
url = "https://admin.vps.org/api/v1/servers/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
response = requests.get(url, headers=headers)
for server in response.json()["results"]:
print(server["uuid"], server["hostname"], server["status"])
const response = await fetch('https://admin.vps.org/api/v1/servers/', {
headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});
const data = await response.json();
console.log(data.results);
$ch = curl_init('https://admin.vps.org/api/v1/servers/');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_API_TOKEN']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
foreach ($data['results'] as $server) {
echo $server['hostname'] . ' ' . $server['status'] . "\n";
}
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"uuid": "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b",
"hostname": "web-01",
"status": "on",
"error_description": null,
"location_name": "New Jersey",
"plan_name": "1 vCPU / 2 GB RAM / 10 GB",
"os_name": "Ubuntu",
"ipv4_addresses": ["203.0.113.10"],
"ipv6_addresses": ["2001:db8:2:dd::f9:6b"],
"created_at": "2026-07-30T03:54:14.914364Z",
"deployed": true
},
{
"uuid": "2d7e9b40-6c1a-4f3e-8b5d-9a0c1e2f3b4d",
"hostname": "db-01",
"status": "queue",
"error_description": null,
"location_name": "New Jersey",
"os_name": "Debian",
"ipv4_addresses": [],
"ipv6_addresses": [],
"created_at": "2026-09-14T19:33:49.426508Z",
"deployed": false
}
]
}
| Väli | Tüüp | Description |
|---|---|---|
uuid |
string | Serveri identifikaator, mida kasutatakse igas muus serveri tulemusnäitajas |
hostname |
string | Serveri loomisel valitud masinanimi |
status |
string | Aktiivne olek. Vaata allpool serveri oleku väärtusi. |
error_description |
string | null | Viimase vea üksikasjad oleku vea korral, vastasel juhul null |
location_name |
string | Name of the location the server runs in |
os_name |
string | Operatsioonisüsteemi nimi ilma versioonita |
plan_name |
string | Lugetav plaani kokkuvõte, näiteks 1 vCPU / 2 GB RAM / 10 GB |
ipv4_addresses |
array | IPv4 aadressid stringidena. Tühi kuni serveri käivitamiseni ja plaanideni ilma IPv4. |
ipv6_addresses |
array | IPv6 aadressid stringidena. Tühi, kuni server on kasutusel. |
created_at |
datetime | Loomisaeg (ISO 8601, UTC) |
deployed |
boolean | Tõsi, kui abi on tehtud |
| 200 | Serverite loend edukalt alla laaditud |
| 403 | Puuduv või vigane API märgis või märgil puudub nõutav luba |
Seab uue serveri sisse ja tagastab selle kohe olekujärjekorras. Eeldused jätkuvad taustal: vaatleb oleku tulemusnäitajat kuni on tõene. Kui server on valmis, saadetakse sisselogimise üksikasjad konto omanikule.
Sinu konto vajab salvestatud makse meetodit. Sõltuvalt konto ajaloost võib enne serveri loomist asetada kaardile ajutise eelloa, mis sisaldab umbes ühte nädalakest plaani hinnast (vähemalt 1 USD).
Nõutav luba: servers:create
| Parameter | Tüüp | Nõutav | Description |
|---|---|---|---|
hostname |
string | Jah | Vähemalt 3 tähemärki. Ainult kirjad, numbrid, sidekriipsud ja perioodid. |
location_id |
integer | Jah | Aktiivse asukoha ID asukohtade API- st |
plan_uuid |
string | Jah | Planeeringute API aktiivse plaani uudi |
operating_system_version_uuid |
string | Jah | Operatsioonisüsteemi versioonide nimekirja aktiivse kirje uid |
ssh_key_uuids |
array | No | SSH võtmete UUDID SSH võtmete installimiseks serverisse |
ssh_key_ids |
array | No | SSH võtmete täis ID- d on alternatiivina ssh_ key_ uids' ile. Kui mõlemad on saadetud, kasutatakse ssh_ key_ ids. |
ssh_key_uuid, ssh_key_id |
string, integer | No | Ühe SSH võtme kiirklahv |
auth_method |
string | No | parool, ssh_key või mõlemad. Vaikimisi parool või mõlemad, kui SSH võtmed on saadaval. |
curl -X POST "https://admin.vps.org/api/v1/servers/" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"hostname": "web-01",
"location_id": 1,
"plan_uuid": "3bc2faf6-8f8b-4978-b62d-b52ed3f858e9",
"operating_system_version_uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
"ssh_key_uuids": ["YOUR_SSH_KEY_UUID"]
}'
import requests
url = "https://admin.vps.org/api/v1/servers/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
data = {
"hostname": "web-01",
"location_id": 1,
"plan_uuid": "3bc2faf6-8f8b-4978-b62d-b52ed3f858e9",
"operating_system_version_uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
"ssh_key_uuids": ["YOUR_SSH_KEY_UUID"],
}
response = requests.post(url, headers=headers, json=data)
server = response.json()
print(response.status_code, server["uuid"], server["status"])
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({
hostname: 'web-01',
location_id: 1,
plan_uuid: '3bc2faf6-8f8b-4978-b62d-b52ed3f858e9',
operating_system_version_uuid: 'c3418f90-80a0-4e00-a7e1-d0ab1822b941',
ssh_key_uuids: ['YOUR_SSH_KEY_UUID']
})
});
const server = await response.json();
console.log(server.uuid, server.status);
$data = [
'hostname' => 'web-01',
'location_id' => 1,
'plan_uuid' => '3bc2faf6-8f8b-4978-b62d-b52ed3f858e9',
'operating_system_version_uuid' => 'c3418f90-80a0-4e00-a7e1-d0ab1822b941',
'ssh_key_uuids' => ['YOUR_SSH_KEY_UUID']
];
$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);
$server = json_decode(curl_exec($ch), true);
curl_close($ch);
201 Loodud täisserveri objektiga, mida on kirjeldatud all Hangi serveri andmed. Aadressid ja vmid on täidetud pärast kasutuselevõttu.
{
"uuid": "5f0c8e2a-6b1d-4c3e-9a7f-2d4b6c8e0a1f",
"hostname": "web-01",
"vmid": null,
"status": "queue",
"error_description": null,
"location": {
"id": 1,
"name": "New Jersey",
"country_name": "United States",
"is_active": true
},
"plan": {
"uuid": "3bc2faf6-8f8b-4978-b62d-b52ed3f858e9",
"cpu": 1,
"ram": 2,
"ram_unit": "GB",
"disk_space": 10,
"disk_space_total": 10240,
"transfer": 500,
"price": "3.50",
"cpu_type_name": "Shared",
"is_active": true,
"hourly_price": "0.005",
"monthly_price": "3.50",
"is_gpu": false,
"gpu_count": 0,
"gpu_model": ""
},
"operating_system": {
"id": 1,
"name": "Ubuntu",
"svg_icon": "<svg ...>",
"versions": [ ... ]
},
"operating_system_version": {
"uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
"name": "24.04 LTS x64",
"os_name": "Ubuntu",
"os_svg_icon": "<svg ...>",
"is_active": true
},
"ipv4_addresses": [],
"ipv6_addresses": [],
"deployed": false,
"created_at": "2026-09-14T21:02:11.402113Z",
"recent_actions": []
}
| 201 | Server loodud ja järjekorda pandud kasutamiseks |
| 400 | Valideerimisviga, näiteks mitteaktiivne asukoht, plaan või operatsioonisüsteemi versioon |
| 402 | Failis ei ole makseviisi, maksmata arveid ega kaardi eelluba ei keeldutud |
| 403 | Puuduv või vigane API märgis või märgil puudub nõutav luba |
| 429 | Sinu konto on jõudnud serveri loomise piirini |
Tagastab ühe serveri asukoha, plaani, operatsioonisüsteemi, IP-aadresside ja viie viimase toiminguga.
Nõutav luba: servers:list
curl -X GET "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/" \
-H "Authorization: Bearer YOUR_API_TOKEN"
{
"uuid": "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b",
"hostname": "web-01",
"vmid": 1042,
"status": "on",
"error_description": null,
"location": {
"id": 1,
"name": "New Jersey",
"country_name": "United States",
"is_active": true
},
"plan": {
"uuid": "14186969-fbaf-43e1-9ab2-b1f1aeb66674",
"cpu": 1,
"ram": 2,
"ram_unit": "GB",
"disk_space": 25,
"disk_space_total": 25600,
"transfer": 1,
"price": "5.00",
"cpu_type_name": "Shared",
"is_active": true,
"hourly_price": "0.007",
"monthly_price": "5.00",
"is_gpu": false,
"gpu_count": 0,
"gpu_model": ""
},
"operating_system": {
"id": 1,
"name": "Ubuntu",
"svg_icon": "<svg ...>",
"versions": [ ... ]
},
"operating_system_version": {
"uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
"name": "24.04 LTS x64",
"os_name": "Ubuntu",
"os_svg_icon": "<svg ...>",
"is_active": true
},
"ipv4_addresses": [
{
"ip": "203.0.113.10",
"gateway": "203.0.113.1",
"subnet": "203.0.113.0",
"rdns": "web-01.example.com"
}
],
"ipv6_addresses": [
{
"ip": "2001:db8:2:dd::f9:6b",
"gateway": "2001:db8:2:dd::f9:1",
"subnet": "2001:db8:2:dd::f9:0",
"rdns": "web-01.example.com"
}
],
"deployed": true,
"created_at": "2026-07-30T03:54:14.914364Z",
"recent_actions": [
{
"id": 17028,
"action": "create",
"action_display": "Create",
"description": "Server deployed with VMID 1042",
"user_email": "you@example.com",
"created_at": "2026-07-30T03:54:32.860854Z"
}
]
}
SVG ikooni märgistus ja versioonide nimekiri on siin lühendatud.
| Väli | Tüüp | Description |
|---|---|---|
vmid |
integer | null | Virtuaalne masinanumber, mis on määratud kasutuselevõtu ajal |
location |
object | Asukoht objekt kui tagastas asukohad API |
plan |
object | Plaani objekt, nagu on tagasi plaanid API |
operating_system, operating_system_version |
object | Operatsioonisüsteem ja paigaldatud versioon, nagu tagastas operatsioonisüsteemide API |
ipv4_addresses, ipv6_addresses |
array | Üks objekt aadressi kohta ip, värav, subnet ja rdns (pöörde DNS masinanimi) |
recent_actions |
array | Kuni viis viimast meedet: ID, toiming, toiming_display, kirjeldus, kasutaja_ email, creation_at |
| 200 | Serveri andmed on edukalt alla laaditud |
| 404 | Ei leitud või kuulub teisele kontole |
Kerge kõne küsitluste pärast luua, võimu või suuruse muutmine server.
curl -X GET "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/status/" \
-H "Authorization: Bearer YOUR_API_TOKEN"
{
"status": "on",
"deployed": true,
"resizing": false
}
| Väärtus | Description |
|---|---|
queue |
Toimingud (töötamine, võimsus, suuruse muutmine, taastamine) on järjekorras või käimas |
deploying |
Serverid, mis on loodud juhtpaneelist, kasutavad seda olekut; serverid, mis on loodud API kaudu, jäävad järjekorda, kuni nad on valmis. |
on |
Töötab |
off |
Välja lülitatud |
error |
Viimane toiming nurjus. Vaata vea_ kirjeldust. |
suspended_payment |
Peatatud maksmata arvete tõttu |
Järjestab võimsuse toimingu. Serveri olek muutub järjekorda, kuni toiming lõpeb.
Nõutav luba: servers:power
| Parameter | Tüüp | Nõutav | Description |
|---|---|---|---|
action |
string | Jah |
start: jõulshutdown: Graatsiline väljalülitamine, väljasurumine, kui külaline ei peaturestart: kõva võimsustsükkel (stop, seejärel start)stop: parajasti sooritab sama võimsustsüklit kui taaskäivitamine. Serveri välja jätmiseks kasuta seiskamist.
|
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/power/" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"action": "restart"}'
import requests
server_uuid = "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b"
url = f"https://admin.vps.org/api/v1/servers/{server_uuid}/power/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
response = requests.post(url, headers=headers, json={"action": "restart"})
print(response.json())
{
"message": "Server restart queued"
}
| 200 | Toiming järjekorda pandi |
| 400 | Puuduv või toetamata toiming |
| 402 | konto on tasustamata arved |
| 404 | Ei leitud või kuulub teisele kontole |
Liigutab serveri teise aktiivse plaani. Uuel plaanil ei saa olla vähem kettaruumi kui aktiivsel ja taotluse korral peab asutus lisama toimingu, mis määrab uue plaani suuruse muutmise. Uue plaani hüpervisori mahtu kontrollitakse enne järjekorda, nii et keeldutud päring jätab serveri muutmata.
Server suletakse suuruse muutmisel ja käivitatakse pärast seda uuesti. Kui suuruse muutmine nurjub, pannakse server tagasi eelmisesse plaani ja käivitatakse uuesti, kui see töötab. Ketta kasvu ei saa tagasi võtta.
Nõutav luba: servers:resize
| Parameter | Tüüp | Nõutav | Description |
|---|---|---|---|
action |
string | Jah | Peab olema suuruse muutmine. |
new_plan_uuid |
string | Jah | The uuid of the plan to move to |
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/resize/" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"action": "resize", "new_plan_uuid": "5e26a4a6-bd0c-467c-abca-da036c811c3f"}'
{
"message": "Resize queued successfully"
}
Näide suuruse muutmisest keeldumise kohta (409):
{
"error": "Not enough hypervisor capacity for the selected plan; the server was not changed"
}
| 200 | Toiming järjekorda pandi |
| 400 | Puuduv toiming või uus_plan_uid, vigane või mitteaktiivne plaan, vähem kettaruumiga plaan või GPU plaan (GPU plaane ei saa API kaudu muuta) |
| 404 | Ei leitud või kuulub teisele kontole |
| 409 | Suuruse või ladustamise muutus on juba käimas või uue plaani jaoks ei ole piisavalt hüpervisori võimsust |
| 503 | Mahukust ei saa praegu kontrollida. Serverit ei muudetud, proovi hiljem uuesti. |
Loob uue juurparooli, tagastab vastuse ja seab serveris järjekorda muudatuse. Uus parool on ka meili teel. Server tuleb kasutusele võtta. Nõudeid ei ole vaja.
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/reset-password/" \
-H "Authorization: Bearer YOUR_API_TOKEN"
{
"message": "Password reset queued. New password will also be emailed to you.",
"password": "generated-password",
"job_id": "b6f1c7e2-3a4d-4f5e-8b9c-0d1e2f3a4b5c"
}
| 200 | Toiming järjekorda pandi |
| 400 | Serverit pole veel kasutusele võetud |
| 404 | Ei leitud või kuulub teisele kontole |
GET loetleb serveris iga IPv4 ja IPv6 aadressi vastupidise DNS- i masinanime. Post määrab selle ühe aadressi jaoks. Tühja masinanime saatmine lähtestab aadressi vaikimisi DNS- i nime.
Nõutav luba: servers:update
| Parameter | Tüüp | Nõutav | Description |
|---|---|---|---|
ip |
string | Jah | Sellele serverile määratud IPv4 või IPv6 aadress |
hostname |
string | No | PTR masinanimi. Vaikimisi lähtestamiseks jäetakse tühjaks. |
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/rdns/" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"ip": "203.0.113.10", "hostname": "mail.example.com"}'
{
"message": "Reverse DNS for 203.0.113.10 set to mail.example.com",
"ip": "203.0.113.10",
"hostname": "mail.example.com"
}
GET vastus:
{
"rdns": [
{"ip": "203.0.113.10", "hostname": "mail.example.com"},
{"ip": "2001:db8:2:dd::f9:6b", "hostname": "mail.example.com"}
]
}
| 400 | ip puudub või masinanime pole võimalik määrata |
| 404 | IP- aadressi ei määrata sellele serverile |
Käivitab shellikäsu serveris QEMU külalisagendi kaudu ja ootab selle lõpetamist. Server peab olema sisse lülitatud ja töökorras ning qemu-guest- agent peab olema paigaldatud ja töötama külalises.
Nõutav luba: servers:exec
| Parameter | Tüüp | Nõutav | Description |
|---|---|---|---|
command |
string | Jah | Käsurida töötab /bin/sh - c, kuni 2000 tähemärki |
timeout |
integer | No | Sekundid käsu ootamiseks, 1 kuni 300 (vaikimisi 30) |
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/exec/" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"command": "uptime", "timeout": 30}'
{
"stdout": " 21:14:03 up 46 days, 2:10, 0 users, load average: 0.08, 0.03, 0.01\n",
"stderr": "",
"exit_code": 0,
"timed_out": false
}
Kui käsk töötab ikka veel ajapiirangu lõppemisel, on vastus ajastatud_out seatud tõeseks ja väljumiskoodiks null.
| 200 | Käsk lõpetatud või aegunud |
| 400 | Server ei tööta või töötab või on vigane |
| 409 | QEMU külalisagent ei tööta serveris |
| 503 | Proovi uuesti pärast uuesti proovimist. |
Seab serverit püsivaks kustutamiseks järjekorda. Server kaob nimekirjast kohe ja seda ei saa taastada.
Nõutav luba: servers:delete
curl -X DELETE "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/" \
-H "Authorization: Bearer YOUR_API_TOKEN"
{
"message": "Server deletion queued"
}
| 202 | Vastu võetud: taotlus oli järjekorras |
| 404 | Ei leitud või kuulub teisele kontole |
Salvesta oma kontole avalikud SSH võtmed, seejärel edasta oma uudid kui ssh_key_ uids kui sa lood serveri. SAADA oma võtmed (25 leheküljel); POST lisab ühe.
Nõutav luba: ssh-keys:list (GET), ssh-keys:create (POST)
| Parameter | Tüüp | Nõutav | Description |
|---|---|---|---|
name |
string | Jah | Võtme äratundmise nimi kuni 100 tähemärgi järgi |
public_key |
string | Jah | OpenSSH-formaadis avalik võti, näiteks id_ed25519.pub |
curl -X POST "https://admin.vps.org/api/v1/ssh-keys/" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "laptop", "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAI... you@laptop"}'
import requests
url = "https://admin.vps.org/api/v1/ssh-keys/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
with open("/home/you/.ssh/id_ed25519.pub") as f:
data = {"name": "laptop", "public_key": f.read().strip()}
response = requests.post(url, headers=headers, json=data)
print(response.status_code, response.json()["uuid"])
{
"id": 19,
"uuid": "6e1b9c52-3f8a-4d7e-a2c4-5b9d0e1f2a3c",
"name": "laptop",
"public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAI... you@laptop",
"fingerprint": "0b:4c:9b:48:76:e7:1d:07:b9:ac:71:90:70:f7:9a:69",
"created_at": "2026-08-23T19:16:11.547183Z",
"last_used_at": null
}
| Väli | Tüüp | Description |
|---|---|---|
id, uuid |
integer, string | Võtme identifikaatorid. Kasuta uudid ssh_key_ uids ja allolevas URL- is; id toimib ssh_ key_ idis. |
fingerprint |
string | MD5 võtme sõrmejälg, arvutatud platvormi abil |
last_used_at |
datetime | null | Kui võti oli viimati paigaldatud uude serverisse |
| 201 | Lisatud võti |
| 400 | Puudub nimi või avalik võti ei ole korrektne SSH avalik võti |
GET tagastab ühe võtme väljadega ülal. DELET eemaldab selle sinu kontolt ja tagastab 204 ilma kehata. Võtme kustutamine ei eemalda seda serveritest, kuhu see juba paigaldatud on. Võtmeid ei saa muuta: kustuta ja lisa uuesti.
Nõutav luba: ssh-keys:list (GET), ssh-keys:delete (DELETE)
curl -X DELETE "https://admin.vps.org/api/v1/ssh-keys/6e1b9c52-3f8a-4d7e-a2c4-5b9d0e1f2a3c/" \
-H "Authorization: Bearer YOUR_API_TOKEN"
Varukoopia või pildi loomine on ka serveri toiming:
POST /api/v1/servers/{uuid}/backup/: Varunduste APIGET/PATCH /api/v1/servers/{uuid}/backup-settings/: Varunduste APIPOST /api/v1/servers/{uuid}/snapshot/: Hetktõmmiste API