I-API Yamaseva

THOLA /api/v1/servers/

Bhala Zonke Iziphakeli

Ibuyisela izisebenzisi kwi-akhawunti yakho, ezisha kuqala, 25 ngakhasi. Izisebenzisi ezisuswayo azibandakanyi.

Igunya elidingekayo: servers:list

Amapharamitha Ombuzo

Amapharamitha	Uhlobo	Kuyadingeka	Incazelo
`page`	integer	Akukho	Inani lekhasi, liqala ku-1
`page_size`	integer	Akukho	Iziphetho ngamakhasi (iphutha 25, okuphezulu 100)

Isicelo Sesibonelo

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 Yesibonelo

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

Izinkambu Zempendulo

Isigaba	Uhlobo	Incazelo
`uuid`	string	Isisebenzisi esiphawula umsebenzisi esisetshenziswa kuwo wonke amaseva amanye
`hostname`	string	Igama lomphathi okhethile uma udala isisebenzisi
`status`	string	Isimo samanje. Bona Amaxabiso Esimo Seseva ngezansi.
`error_description`	string \| null	Imingwane yephutha elidlule uma isimo siyiphutha, uma kungenjalo i-null
`location_name`	string	Igama lendawo lapho isisebenzisi sisebenza khona
`os_name`	string	Igama lesistimu yokusebenza, ngaphandle kohlobo
`plan_name`	string	Isinhlamvu sezinhlelo esifundeka, isibonelo 1 vCPU / 2 GB RAM / 10 GB
`ipv4_addresses`	array	IPv4 amakheli njengezinhlamvu. Ayikho kuze kube isisebenzisi sifakwe, futhi kuzinhlelo ezingaba IPv4.
`ipv6_addresses`	array	IPv6 amakheli njengezinhlamvu. Ayikho kuze kube isisebenzisi sifakwe.
`created_at`	datetime	Isikhathi sokudalwa (ISO 8601, UTC)
`deployed`	boolean	Iqiniso uma ukunikeza kuqediwe

Amakhodi Esimo Sempendulo

200	Uhlu lweseva olubuyiselwe ngempumelelo
403	I-API token elahlekile noma engasebenziyo, noma i-token ayinayo imvume edingekayo

ISITHUTHUKO /api/v1/servers/

Dala iseva entsha

Ivula isisebenzisi esitsha ukuze sifakwe futhi ibuyisela ngokushesha ngesimo sesimo. Ukuhlinzekwa kuqhubeka ezindaweni ezingezansi: hlola isimo sendawo yokuqedela kuze kube sefakwe kuyiqiniso. Xa isisebenzisi silungile, imingwane yokungena ithunyelwe nge-imeyili kumnikazi we-akhawunti.

I-akhawunti yakho idinga indlela yokukhokha egcinwe. Ngokuya ngembali ye-akhawunti yakho, i-pre-authorization engakapheliyo engaphansi kweviki elilodwa lentengo ye-plan (i-USD 1 noma ngaphezulu) ingabekwa kwikhadi lakho ngaphambi kokuba isisebenzisi sidalwa.

Igunya elidingekayo: servers:create

Cela Amapharamitha Omzimba

Amapharamitha	Uhlobo	Kuyadingeka	Incazelo
`hostname`	string	Yebo	At least 3 characters. Letters, digits, hyphens and periods only.
`location_id`	integer	Yebo	I-id yendawo esebenzayo kusuka ku-Locations API
`plan_uuid`	string	Yebo	I-uuid ye-plan esebenzayo kusuka ku-Plans API
`operating_system_version_uuid`	string	Yebo	I-uuid yengeniso esebenzayo kuhlelo lokusebenzela oluhlu lwezinguqulo
`ssh_key_uuids`	array	Akukho	Ama-UUIDs wamathuluzi we-SSH kusuka ku-SSH Keys API afakwe kuseva
`ssh_key_ids`	array	Akukho	Izibalo ezigcwele ze-ids zezinkinobho ze-SSH, njengendlela yokushintsha i-ssh_key_uuids. Uma zombili zithunyelwe, i-ssh_key_ids isetshenziswa.
`ssh_key_uuid`, `ssh_key_id`	string, integer	Akukho	Isinqumo sezinkinobho SSH ezihlukile
`auth_method`	string	Akukho	iphasiwedi, ssh_key noma zombili. Iphutha kuphasiwedi, noma kuzo zombili uma i-SSH inkinobho ihlinzekwa.

Isicelo Sesibonelo

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 Yesibonelo

201 Yakhiwa ngesimo esigcwele somhlinzeki esichazwe ngaphansi kwe Get Server Details. Amakheli ne vmid zigcwele uma ukuthunyelwa kuqediwe.

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

Amakhodi Esimo Sempendulo

201	Isisebenzisi sikhishwe futhi sifakwe ifolokhwe ukuthunyelwa
400	Iphutha lokuqinisekiswa, isibonelo indawo engasebenziyo, iphrojekthi noma uhlelo lokusebenza
402	Akukho ndlela yokukhokha eheleni, amafayela angakhokhwa, noma ikhadi lokugunyaza ngaphambili lilahlekile
403	I-API token elahlekile noma engasebenziyo, noma i-token ayinayo imvume edingekayo
429	I-akhawunti yakho ifinyelele umkhawulo wokwenza isisebenzisi

THOLA /api/v1/servers/{uuid}/

Thola Imingwane Yeseva

Ibuyisela umsekeli ngamunye nendawo yakhe, iphrojekthi, indlela yokusebenza, amakheli we-IP kanye nemisebenzi emihlanu edlule.

Igunya elidingekayo: servers:list

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

Impendulo Yesibonelo

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

Isithombe-skrini se-SVG ne-uhlu lwezinguqulo zisondelene lapha.

Izinkambu Zempendulo

Isigaba	Uhlobo	Incazelo
`vmid`	integer \| null	Inani lemishini ebonakalayo, ibekwe ngesikhathi sokukhishwa
`location`	object	Isitho sendawo, njengoba sibuyiselwa yi-Locations API
`plan`	object	Injongo ye-Plan, njengoba ibuyiselwa yi-Plans API
`operating_system`, `operating_system_version`	object	Isimo sokusebenza kanye nefomethi efakwe, njengoba kubuyiselwa yi-Operating Systems API
`ipv4_addresses`, `ipv6_addresses`	array	Ingxenye eyodwa yekheli ngalinye nge-ip, i-gateway, i-subnet ne-rdns (igama lomnini DNS elishintshayo)
`recent_actions`	array	Kuze kube yizinhlamvu eziyisithupha ezidlule: id, action, action_display, description, user_email, created_at

Amakhodi Esimo Sempendulo

200	Kutholwe ngempumelelo imingwane yeseva
404	Ayitholakali, noma ikhona kwezinye i-akhawunti

THOLA /api/v1/servers/{uuid}/status/

Thola isimo somhlinzeki

Ucingo oluncane lokuvota ngemuva kokwenza, ukulawula noma ukuguqula ubukhulu beseva.

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
}

Amaxabiso esimo somhlinzeki

Ixabiso	Incazelo
`queue`	Insizakalo (ukufaka, amandla, ukuguqula ubukhulu, ukubuyisela) ifakwe ifolokhwe noma iqhubeka
`deploying`	Izisebenzisi ezicutshungulwa kusuka kundawo yokulawula zisebenzisa lesimo; izisebenzisi ezicutshungulwa nge-API zihlala zihamba phambili kuze kube sekulungele.
`on`	Iyasebenza
`off`	I-Powered off
`error`	Umsebenzi wokugcina awuphumelelanga. Bona error_description.
`suspended_payment`	Isuselwe ngenxa yezinkokhelo ezingakhokhwa

ISITHUTHUKO /api/v1/servers/{uuid}/power/

Ukulawula amandla omsekeli

I-filed isinqumo se-power. Isimo somhlinzeki sishintsha ibe yi-filed kuze kube isisinqumo siqediwe.

Igunya elidingekayo: servers:power

Cela Amapharamitha Omzimba

Amapharamitha	Uhlobo	Kuyadingeka	Incazelo
`action`	string	Yebo	`start`: amandla `shutdown`: ukuvala okunethezeka, kucindezelwa uma umngane engayeka `restart`: isikhashana sokusebenza okunzima (yeka, bese uqala) `stop`: manje isebenza ngesimo esifanayo sokusebenza njengeqala kabusha. Sebenzisa ukuvala ukuze ushiye isisebenzisi sivale.

Isicelo Sesibonelo

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 Yesibonelo

{
  "message": "Server restart queued"
}

Amakhodi Esimo Sempendulo

200	Intshukumo ifakwe ebhokisini
400	Umsebenzi ongekho noma ongaxhaswa
402	ukuqala kuvunyelwe ngoba i-akhawunti inezinkokhelo ezingakhokhwa
404	Ayitholakali, noma ikhona kwezinye i-akhawunti

ISITHUTHUKO /api/v1/servers/{uuid}/resize/

Ukuguqula ubukhulu beseva

Ihambisa umsekeli kusinye isilungiselelo esisebenzayo. Isilungiselelo esitsha asikwazi ukuba nendawo encane ku-disk kunesinye esikhona, futhi isifiso sidinga ukufaka umzamo osetshenzisiwe wokushintsha ubukhulu. Ubukhulu be-Hypervisor sesinqumo esitsha kubhekwa ngaphambi kokuba kwenziwe noma yini, ngakho-ke isifiso esilahlekile sishiya isisebenzisi singashintshwa.

Isisebenzisi sivalwa uma sishintsha ubukhulu futhi siqala kabusha ngemuva. Uma ukuguqulwa kobukhulu kuhlulekile, isisebenzisi sibuyiselwa emuva kuhlelo lwayo lwangaphambilini futhi siqala kabusha uma sisebenza. Ukukhula kwediski akukwazi ukubuyiselwa emuva.

Igunya elidingekayo: servers:resize

Cela Amapharamitha Omzimba

Amapharamitha	Uhlobo	Kuyadingeka	Incazelo
`action`	string	Yebo	Kudingeka kushintshwe ubukhulu
`new_plan_uuid`	string	Yebo	I-uuid ye-plan edinga ukuhanjiswa 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"
}

Usibonelo sokuguqula ubukhulu okulahlekile (409):

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

Amakhodi Esimo Sempendulo

200	Intshukumo ifakwe ebhokisini
400	Inketho engekho noma new_plan_uuid, i-plan engasebenziyo noma engasebenziyo, i-plan enesikhala esincane, noma i-GPU plan (i-GPU plan ayikwazi ukushintshwa i-size nge-API)
404	Ayitholakali, noma ikhona kwezinye i-akhawunti
409	Ukushintsha ubukhulu noma ukugcinwa kuqhubeka, noma asikho i-hypervisor encane ekwaziyo ukuphatha i-plan entsha
503	Ikhono alikwazi ukubhekwa manje. Isisebenzisi asishintshiwe; zama futhi ngemuva.

ISITHUTHUKO /api/v1/servers/{uuid}/reset-password/

Buyisela iphasiwedi yomsebenzisi ongumnikazi

Ikhiqiza igama lokungena elitsha, liyibuyisela kuphendula futhi libeke ushintsho emthonjeni. Igama lokungena elitsha lithunyelwe nge-imeyili kuwe. Umthonyi kufanele ufakwe. Akukho ngxenye yesicelo edingekayo.

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

Amakhodi Esimo Sempendulo

200	Intshukumo ifakwe ebhokisini
400	Isisebenzisi asisebenzisi
404	Ayitholakali, noma ikhona kwezinye i-akhawunti

THOLA ISITHUTHUKO /api/v1/servers/{uuid}/rdns/

DNS ebuyiselwe emuva (PTR)

GET ikhombisa igama lomnikazi we-DNS eliguqukayo le-IPv4 ne-IPv6 ngayinye ekhelini le-iseva. POST imisa igama lomnikazi eliguqukayo le-DNS eliguqukayo lekheli. Ukuthunyelwa kwegama lomnikazi elingenalutho libuyisela ikheli kulelo igama elizenzakalelayo le-DNS eliguqukayo.

Igunya elidingekayo: servers:update

Cela Amapharamitha Omzimba (POST)

Amapharamitha	Uhlobo	Kuyadingeka	Incazelo
`ip`	string	Yebo	Ikheli le-IPv4 noma le-IPv6 elinikezelwe kulo msekeli
`hostname`	string	Akukho	Igama lomphathi we PTR. Yishiye ungenanto ukubuyisela kuphutha.

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

Uphendulelo lwe-GET:

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

Amakhodi Esimo Sempendulo

400	i-ip ingekho, noma igama lomnikazi alikwazi ukumiswa
404	Idilesi ye-IP ayinikezelwanga kulo msekeli

ISITHUTHUKO /api/v1/servers/{uuid}/exec/

Sebenzisa umlayezo kuseva

Isebenzisa umlayezo we-shell ngaphakathi kweseva nge-QEMU guest agent futhi ilinde ukuthi iphele. Iseva kumele ifakwe futhi isebenze, futhi qemu-guest-agent kumele ifakwe futhi isebenze ku-guest.

Igunya elidingekayo: servers:exec

Cela Amapharamitha Omzimba

Amapharamitha	Uhlobo	Kuyadingeka	Incazelo
`command`	string	Yebo	Umlayezo welayini usebenza nge /bin/sh -c, kuze kube yizinhlamvu ezingu-2000
`timeout`	integer	Akukho	Amasekondi okulindelwe umlayezo, 1 kuya ku-300 (isimiso 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
}

Uma umlayezo uqhubeka usebenza uma isikhathi siphelile, impendulo i-timed_out isethelwe kuqiniso futhi exit_code isethelwe ku-null.

Amakhodi Esimo Sempendulo

200	Umlayezo uqediwe noma uphelelwe isikhathi
400	Isisebenzisi asisebenzisiwe noma asisebenzi, noma amapharamitha angasebenzi
409	I-QEMU guest agent ayisebenzi ku-server
503	Inkinga yokuxhumana yesikhathi eside. Zama kabusha ngemuva kwe-Retry-After header.

SUSA /api/v1/servers/{uuid}/

Susa Iseva

Ifaka isisebenzisi esingenalutho esingenalutho. Isisebenzisi sizophela kuluhlu ngokushesha futhi ngeke sibuyiselwe.

Igunya elidingekayo: 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"
}

Amakhodi Esimo Sempendulo

202	Ivunyelwe: isicelo sifakwe ebhokisini
404	Ayitholakali, noma ikhona kwezinye i-akhawunti

THOLA ISITHUTHUKO /api/v1/ssh-keys/

Amakinombho we-SSH

Gcina izinkinobho zasekhaya ze-SSH kwi-akhawunti yakho, bese udlulisa i-uuids yabo njenge-ssh_key_uuids uma kwenza umsekeli. GET ikhombisa izinkinobho zakho (25 ngamakhasi); POST ifaka enye.

Igunya elidingekayo: ssh-keys:list (GET), ssh-keys:create (POST)

Cela Amapharamitha Omzimba (POST)

Amapharamitha	Uhlobo	Kuyadingeka	Incazelo
`name`	string	Yebo	Igama lokukwazisa isithonjana, kuze kube ngu-100 amaphawu
`public_key`	string	Yebo	Isitshixo sasekhaya esingenasici se-OpenSSH, isibonelo, okuqukethwe kwe-id_ed25519.pub

Isicelo Sesibonelo

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 Yesibonelo

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

Izinkambu Zempendulo

Isigaba	Uhlobo	Incazelo
`id`, `uuid`	integer, string	Izinkomba zinkinobho. Sebenzisa uuid ku ssh_key_uuids ne ku URL engezansi; id isebenza ku ssh_key_ids.
`fingerprint`	string	I-MD5 fingerprint yesitshixo, ibalwa yi-platform
`last_used_at`	datetime \| null	Lapho isithonjana safakwa kuqala kuseva entsha

Amakhodi Esimo Sempendulo

201	Isithonjana sithengiswa
400	Igama elilahlekile, noma isithonjana sasekhaya asisebenzisi isithonjana sasekhaya se-SSH

THOLA SUSA /api/v1/ssh-keys/{uuid}/

Thola noma susa isithonjana se-SSH

GET ibuyisela inkinobho eyodwa nezindawo eziphezulu. DELETE isusa ku-akhawunti yakho futhi ibuyisela 204 ngaphandle komzimba. Ukususa inkinobho akuyisusa ku-servers lapho ifakwe khona. Izinkinobho azikwazi ukuhlela: ukususa bese ungeza futhi.

Igunya elidingekayo: 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"

Ama-backup nama-snapshots

Ukwenza isipele noma isithonjana siyisinqumo seseva:

POST /api/v1/servers/{uuid}/backup/: I-API Yezipele
POST /api/v1/servers/{uuid}/snapshot/: I-Snapshots API

VPS.org API

Bhala Zonke Iziphakeli

Amapharamitha Ombuzo

Isicelo Sesibonelo

Impendulo Yesibonelo

Izinkambu Zempendulo

Amakhodi Esimo Sempendulo

Dala iseva entsha

Cela Amapharamitha Omzimba

Isicelo Sesibonelo

Impendulo Yesibonelo

Amakhodi Esimo Sempendulo

Thola Imingwane Yeseva

Impendulo Yesibonelo

Izinkambu Zempendulo

Amakhodi Esimo Sempendulo

Thola isimo somhlinzeki

Amaxabiso esimo somhlinzeki

Ukulawula amandla omsekeli

Cela Amapharamitha Omzimba

Isicelo Sesibonelo

Impendulo Yesibonelo

Amakhodi Esimo Sempendulo

Ukuguqula ubukhulu beseva

Cela Amapharamitha Omzimba

Amakhodi Esimo Sempendulo

Buyisela iphasiwedi yomsebenzisi ongumnikazi

Amakhodi Esimo Sempendulo

DNS ebuyiselwe emuva (PTR)

Cela Amapharamitha Omzimba (POST)

Amakhodi Esimo Sempendulo

Sebenzisa umlayezo kuseva

Cela Amapharamitha Omzimba

Amakhodi Esimo Sempendulo

Susa Iseva

Amakhodi Esimo Sempendulo

Amakinombho we-SSH

Cela Amapharamitha Omzimba (POST)

Isicelo Sesibonelo

Impendulo Yesibonelo

Izinkambu Zempendulo

Amakhodi Esimo Sempendulo

Thola noma susa isithonjana se-SSH

Ama-backup nama-snapshots