VPS.org API

Uxwebhu lwe-REST API

I-API yeeSeva

Dala, khangela, umbane, tshintsha ubungakanani kwaye cime i VPS yakho. Iiseva zichazwa yi uuid yabo.

Iindawo zokugqibela 15
Indlela Esisiseko /api/v1/servers
FUMANA /api/v1/servers/

Dwelisa Zonke Iiseva

Ibuyisela abancedisi kwi akhawunti yakho, abatsha kuqala, 25 kwiphepha ngalinye. Abancedisi abacinywayo abaqukalwanga.

Iimvume ezifunekayo: servers:list

IiParamitha zoMbuzo

Iparamitha Uhlobo Kufuneka Inkcazelo
page integer Akukho nanye Inani lephepha, liqala ku-1
page_size integer Akukho nanye Iziphumo zephepha ngalinye (okwendalo 25, okuphezulu 100)

Isicelo somzekelo

cURL
Python
JavaScript
PHP
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";
}

Impendulo yoMzekelo

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

IiNdawo zeMpendulo

Iindawo Uhlobo Inkcazelo
uuid string Isichazi seseva esisetyenziswa kwindawo yesiphelo seseva nganye
hostname string Igama lomququzeleli okhethileyo xa usenza iseva
status string Iimeko zangoku. Bona Iixabiso zesimo somncedisi ezantsi.
error_description string | null Iinkcukacha zokungaphumeleli kokuphela xa iimeko ziyimposiso, kungenjalo ziyi-null
location_name string Igama lendawo esebenza kuyo umncedisi
os_name string Igama lenkqubo yokusebenza, ngaphandle kohlobo
plan_name string Isishwankathelo senkqubo efundekayo, umzekelo 1 vCPU / 2 GB RAM / 10 GB
ipv4_addresses array Idilesi ze-IPv4 njengemisonto. Akukho nto ikhoyo de kube umncedisi unikezelwe, kwinkqubo ngaphandle kwe-IPv4.
ipv6_addresses array Idilesi ze-IPv6 njengemisonto. Akukho nto de kube ngumncedisi unikezelwe.
created_at datetime Ixesha lokuvelisa (ISO 8601, UTC)
deployed boolean Inyaniso xa unikezelo lugqityiwe

Iikhowudi zeMeko yokuphendula

200 Uluhlu lweseva lufunyenwe ngempumelelo
403 I-API token elahlekile okanye engasebenziyo, okanye i-token ayinazimvumelwano ezifunekayo
I-POST /api/v1/servers/

Yenza iSeva eNtsha

Ifoloka umncedisi omtsha wokudibanisa ibuyisela ngokuzenzekelayo ngenkqubo yofoloka. Unikezelo luqhubeka kwindawo yangasemva: umbuzo kwimeko yendawo esembindini de kube ifakwe ilungile. Xa umncedisi ulungile, iinkcukacha zokungena zithunyelwe nge-imeyili kumnini we-akhawunti.

I-akhawunti yakho ifuna indlela yohlawula egciniweyo. Kuxhomekeke kwimbali ye-akhawunti yakho, ulawulo lwexeshana lwe-pre-authorization olumalunga neveki enye yexabiso lenkqubo (okanye ngaphantsi kwe-1 USD) lunokubekwa kwikhadi lakho phambi kokuba umncedisi udweliswe.

Iimvume ezifunekayo: servers:create

Cela iiParamitha zoMzimba

Iparamitha Uhlobo Kufuneka Inkcazelo
hostname string Ewe At least 3 characters. Letters, digits, hyphens and periods only.
location_id integer Ewe I-id yendawo esebenzayo kwi-API ye-Locations
plan_uuid string Ewe I-uuid yenkqubo esebenzayo kwi-API ye-Plans
operating_system_version_uuid string Ewe I-uuid yongeniso olusebenzayo kuluhlu loguqulelo lwenkqubo yokusebenza
ssh_key_uuids array Akukho nanye I-UUIDs yamaQhosha e-SSH esuka kwi-SSH Keys API efakwe kwisincedisi
ssh_key_ids array Akukho nanye I-IDs zenani elipheleleyo lamaqhosha e-SSH, njengento efana ne-ssh_key_uuids. Ukuba zombini zithunyelwe, i-ssh_key_ids isetyenziswa.
ssh_key_uuid, ssh_key_id string, integer Akukho nanye Iqhosha elinqumlayo le-SSH elingu-1
auth_method string Akukho nanye i-password, i-ssh_key okanye zombini. Okumiselweyo ku-password, okanye kuzo zombini xa i-SSH inikezelwa.

Isicelo somzekelo

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 '{
    "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);

Impendulo yoMzekelo

201 Yenziwe ngomncedisi opheleleyo ochazayo phantsi kwe Get Server Details. Idilesi ne vmid zigqityiwe xa unikezelo lugqibekile.

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

Iikhowudi zeMeko yokuphendula

201 Umncedisi uvule ifayile
400 Imposiso yoqinisekiso, umzekelo indawo engasebenziyo, inkqubo yokusebenza okanye uguqulelo lwenkqubo
402 Akukho ndlela yohlawula kwifayili, iinqununu ezingahlawulwanga, okanye ikhadi eligunyazisiweyo elingaphambili lilahlekile
403 I-API token elahlekile okanye engasebenziyo, okanye i-token ayinazimvumelwano ezifunekayo
429 I-akhawunti yakho ifike kumda wokwenza iseva
FUMANA /api/v1/servers/{uuid}/

Fumana Iinkcukacha zeSeva

Ibuyisela umncedisi omnye ngendawo yayo, inkqubo, indlela yokusebenza, idilesi ye IP kunye nemisebenzi emihlanu ekutsha nje.

Iimvume ezifunekayo: servers:list

curl -X GET "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Impendulo yoMzekelo

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

I-SVG icon markup kunye noluhlu loguqulelo lufutshane apha.

IiNdawo zeMpendulo

Iindawo Uhlobo Inkcazelo
vmid integer | null Inani lekhompyutha ebonakalayo, emiselwe ngexesha lokubekwa
location object Indawo yomsebenzi, njengoko ibuyiselwa yi-Locations API
plan object Injongo yePlanga, njengoko ibuyiselwa yiPlanga API
operating_system, operating_system_version object Inkqubo yokusebenza kunye nohlobo olufakelweyo, njengoko kubuyiselwa yi-Operating Systems API
ipv4_addresses, ipv6_addresses array Into enye kwidilesi nganye ene-ip, i-gateway, umnatha osezantsi kunye ne-rdns (igama lomququzeleli we-DNS elijikelezayo)
recent_actions array Ukufikelela kwintshukumo ezili-5 ezidlulileyo: id, action, action_display, description, user_email, created_at

Iikhowudi zeMeko yokuphendula

200 Iinkcukacha zeseva zifunyenwe ngempumelelo
404 Ayifumanekanga, okanye imalunga ne-akhawunti enye
FUMANA /api/v1/servers/{uuid}/status/

Fumana Isimo Somncedisi

Ubizo olulula lokubuza emva kokuba udale, usebenzise okanye uguqule ubungakanani bomncedisi.

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
}

Ixabiso lesimo somncedisi

Ixabiso Inkcazelo
queue Intshukumo (ukufaka, umbane, ubungakanani kwakhona, ukubuyisela) ifolokhwe okanye iqhubekeka
deploying Unikezelo luyaqhubeka. Amaseva ayenziwe kwiqela lenjongo yolawulo asebenzisa le nto; amaseva ayenziwe nge-API ahlala efolojini de balungiselele.
on Isebenza
off I-Powered Off
error Intshukumo yokugqibela ayiphumelelanga. Bona error_description.
suspended_payment I-Accounting and Finance Division
I-POST /api/v1/servers/{uuid}/power/

Ulawulo Lomandla Lomncedisi

Ifoloza intshukumo yombane. Isimo somncedisi sitshintsha ukuba sifoloze de intshukumo igqibeke.

Iimvume ezifunekayo: servers:power

Cela iiParamitha zoMzimba

Iparamitha Uhlobo Kufuneka Inkcazelo
action string Ewe start: umbane
shutdown: uvalo olunobuhle, luqhutywa ukuba umququzeleli awuyiyeka
restart: umjikelo wokusebenza okunzima (misa, emva koko uqale)
stop: isebenza ngoku isebenzisa umjikelo wombane ofanayo njengeqalisa kwakhona. Sebenzisa ukuvala ushiye umncedisi uvale.

Isicelo somzekelo

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

Impendulo yoMzekelo

{
  "message": "Server restart queued"
}

Iikhowudi zeMeko yokuphendula

200 Intshukumo ifolokhwe
400 Intshukumo elahlekile okanye engaxhaswanga
402 start refused because the account has unpaid invoices
404 Ayifumanekanga, okanye imalunga ne-akhawunti enye
I-POST /api/v1/servers/{uuid}/resize/

Tshintsha ubungakanani beseva

Ishenxisa umncedisi kwinye inkqubo esebenzayo. Inkqubo entsha ayinakuba nethuba elincinci le diski kuneyangoku, kwaye umzimba wesicelo kufuneka uquke intshukumo emiselweyo yokuguqula ubungakanani. Ubungakanani be-Hypervisor yenkqubo entsha ivavanywa phambi kokuba nantoni na ifolokhwe, ngoko ke isicelo esilahlekileyo sishiya umncedisi ungatshintshwanga.

Umncedisi uvalwa ngelixa uguqula ubungakanani kwaye uqalise kwakhona emva koko. Ukuba utshintsho lobungakanani aluphumelelanga, umncedisi ubuyiselwa kwinkqubo yakhe yangaphambili kwaye uqalise kwakhona ukuba yayiqhuba. Ukukhula kwediski akuyi kubuyiselwa.

Iimvume ezifunekayo: servers:resize

Cela iiParamitha zoMzimba

Iparamitha Uhlobo Kufuneka Inkcazelo
action string Ewe Kufuneka kulungiswe
new_plan_uuid string Ewe I-uuid yenkqubo emayihanjiswa kuyo
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"
}

Umzekelo wobungakanani obutsha oburhoxisiweyo (409):

{
  "error": "Not enough hypervisor capacity for the selected plan; the server was not changed"
}

Iikhowudi zeMeko yokuphendula

200 Intshukumo ifolokhwe
400 Intshukumo engekhoyo okanye i-new_plan_uuid, inkqubo engasebenziyo okanye engasebenziyo, inkqubo enesithuba esincinci sediski, okanye inkqubo ye-GPU (inkqubo ye-GPU ayikwazi ukuguqulwa ubungakanani nge-API)
404 Ayifumanekanga, okanye imalunga ne-akhawunti enye
409 Utshintsho lobungakanani okanye ulondolozo sele luqhubekeka, okanye akukho mandla afanelekileyo e-hypervisor elungele inkqubo entsha
503 Ubukhulu abukwazi ukuhlolwa ngoku. Umncedisi akatshintshwanga; zama kwakhona kamva.
I-POST /api/v1/servers/{uuid}/reset-password/

Igama lokugqitha le root

Yenza igama lokugqitha elintsha le root, libuyisela kumyalezo kwaye lifolo itshintsho kumncedisi. Igama lokugqitha elintsha lithunyelwe nge email kuwe. Umncedisi kufuneka unikezelwe. Akukho mzimba wesicelo ofunekayo.

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

Iikhowudi zeMeko yokuphendula

200 Intshukumo ifolokhwe
400 Umncedisi akasebenzisi i-%s
404 Ayifumanekanga, okanye imalunga ne-akhawunti enye
FUMANA I-POST /api/v1/servers/{uuid}/rdns/

DNS Ejikelezayo (PTR)

GET ibonisa igama lomququzeleli we DNS elijikelezayo le IPv4 ne IPv6 idilesi nganye kumncedisi. UTHANDO limisela idilesi enye. Ukuthumela igama lomququzeleli olungasebenziyo libuyisela idilesi kwigama elijikelezayo le DNS elimiselweyo.

Iimvume ezifunekayo: servers:update

Cela iiParamitha zoMzimba (POST)

Iparamitha Uhlobo Kufuneka Inkcazelo
ip string Ewe Idilesi ye-IPv4 okanye i-IPv6 enikezelwe kulo mncedisi
hostname string Akukho nanye Igama lomququzeleli we-PTR. Yishiye engenanto ukubuyisela okumiselweyo.
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"
}

Impendulo ye GET:

{
  "rdns": [
    {"ip": "203.0.113.10", "hostname": "mail.example.com"},
    {"ip": "2001:db8:2:dd::f9:6b", "hostname": "mail.example.com"}
  ]
}

Iikhowudi zeMeko yokuphendula

400 i-ip ilahlekile, okanye igama lomququzeleli alikwazi ukumiselwa
404 Idilesi ye-IP ayinikezelwanga kulo mncedisi
I-POST /api/v1/servers/{uuid}/exec/

Phumeza Umyalelo Kwiseva

Iqhuba umyalelo weqokobhe ngaphakathi kumncedisi ngenye indlela yomququzeleli womntu othandekayo we QEMU kwaye ilinde ukuba iphele. Umncedisi kufuneka unikezelwe kwaye usebenze, kwaye i-qemu-guest-agent kufuneka ifakwe kwaye isebenze kumntu othandekayo.

Iimvume ezifunekayo: servers:exec

Cela iiParamitha zoMzimba

Iparamitha Uhlobo Kufuneka Inkcazelo
command string Ewe Command line run with /bin/sh -c, up to 2000 characters
timeout integer Akukho nanye Imizuzwana yokulinda umyalelo, 1 ukuya ku-300 (okwendalo ngu-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
}

Ukuba umyalelo uqhubeka usebenza xa ixesha lokuphumla liphelelwe lixesha, umyalezo u-timed_out umiselwe kwinyaniso kwaye i-exit_code imiselwe ku-null.

Iikhowudi zeMeko yokuphendula

200 Umyalelo uphelile okanye uphelelwe lixesha
400 Isincedisi asisebenzisi okanye asiqhubi, okanye iparamitha engasebenziyo
409 I-QEMU guest agent ayisebenzi kwiseva
503 Ingxaki yodibaniso lwexeshana. Zama kwakhona emva kwe Retry- After header.
CIMA /api/v1/servers/{uuid}/

Cima iSeva

Ifoloza iseva yokucima okuqhubekayo. Iseva iphela kuluhlu ngokukhawuleza kwaye ayikwazi ukubuyiselwa.

Iimvume ezifunekayo: 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"
}

Iikhowudi zeMeko yokuphendula

202 Ivunyiwe: isicelo sifolonyelwa
404 Ayifumanekanga, okanye imalunga ne-akhawunti enye
FUMANA I-POST /api/v1/ssh-keys/

Isitshixo se-SSH

Gcina izitshixo ze-SSH zabucala kwi-akhawunti yakho, emva koko udlulise ii-uuids zabo njenge-ssh_key_uuids xa usenza iseva. GET iluhluza izitshixo zakho (25 ngaphaya kwephepha); POST idibanisa enye.

Iimvume ezifunekayo: ssh-keys:list (GET), ssh-keys:create (POST)

Cela iiParamitha zoMzimba (POST)

Iparamitha Uhlobo Kufuneka Inkcazelo
name string Ewe Igama lokuqikelela iqhosha, ukuya kuthi ga kumalungu angama-100
public_key string Ewe Isitshixo sasekhaya se-OpenSSH, umzekelo, okuqulethwe yi-id_ed25519.pub

Isicelo somzekelo

cURL
Python
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"])

Impendulo yoMzekelo

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

IiNdawo zeMpendulo

Iindawo Uhlobo Inkcazelo
id, uuid integer, string Iziqinisekiso ezisitshixo. Sebenzisa i-uuid kwi-ssh_key_uuids ne-URL ezantsi; i-id isebenza kwi-ssh_key_ids.
fingerprint string I-MD5 fingerprint yesitshixo, ebalolwe yi-platform
last_used_at datetime | null Xa iqhosha lifakiwe ekupheleni kwiseva entsha

Iikhowudi zeMeko yokuphendula

201 Isitshixo sifakiwe
400 Igama elilahlekileyo, okanye isitshixo sasekhaya asiyiyo isitshixo sasekhaya se-SSH esisebenzayo
FUMANA CIMA /api/v1/ssh-keys/{uuid}/

Fumana okanye Cima Isitshixo se-SSH

GET ibuyisela iqhosha elinye ngemihlaba engaphezulu. Delete isusa kwi-akhawunti yakho kwaye ibuyisela 204 ngaphandle komzimba. Ukucima iqhosha alisuseki kwiseva apho sele ifakwe khona. Iqhosha alikwazi ukuhlela: cima uze uphinde ufake.

Iimvume ezifunekayo: 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"

IiNkqubo zoKhuseleko kunye neSnapshots

Ukwenza ugcino bucala okanye umfanekiso ongumqondiso ngumsebenzi wesincedisi: