API sava

Nweta /api/v1/servers/

Depụta sava niile

Na-ezigaghachi sava na akaụntụ gị, nke ọfụụ n'oge mbụ, 25 n'ihuakwụkwọ ọ bụla. Enweghị sava ndị a na-ehichapụ.

Ikikere achọrọ: servers:list

Paịmatị Ajụjụ

Paramita	Ụdị	A chọrọ	Ndesịta ozi ndị ahụ
`page`	integer	Ọ bụghị	Nọmba ihuakwụkwọ, na-amalite na 1
`page_size`	integer	Ọ bụghị	Ihenhọrọ n'ihuakwụkwọ (dìfọ́ọ̀ltụ̀ 25, māksímù 100)

Arịrịọ Ihe Nlereanya

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

Ihe Nlereanya Azịza

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

Ubi Nzaghachi

_Òkè	Ụdị	Ndesịta ozi ndị ahụ
`uuid`	string	Nkọwasaraịlụ a na-eji na ngwụcha saraịlụ ọbụla
`hostname`	string	Aha ónyénwē ịhọrọla mgbe ịkewapụtachara sava ahụ
`status`	string	Oge ọfụụ. Gụọ Valiu Oge Ọrụ n'okpuru.
`error_description`	string \| null	Ndesịta ozi nke mmehie nke ikpeazụ mgbe ọnọdụ bụ ndehie, ọbụla null
`location_name`	string	Aha ebe ahụ sava na-arụ na ya
`os_name`	string	Aha sistem ojieme, na-enweghị ụdị
`plan_name`	string	Nkọwapụta ntọala na-agụ, dịka ọmụmaatụ 1 vCPU / 2 GB RAM / 10 GB
`ipv4_addresses`	array	IPv4 adreesị dịka strings. Ọfụụ ruo mgbe sava ahụ e mepụtara, na na plans na-enweghị IPv4.
`ipv6_addresses`	array	IPv6 adreesị dịka strings. Ọfụụ ruo mgbe sava ahụ a na-edebata.
`created_at`	datetime	Oge mmegharị ahụ (ISO 8601, UTC)
`deployed`	boolean	Ọ bụ eziokwu mgbe mmepe ahụ gasịrị

Koodu Ọnọdụ Nzaghachi

200	Enwetara ndepụta sava nke ọma
403	Ndehie mọọbụ token API adịghị mma, mọọbụ token enweghị ikikembanye achọrọ

ANYỊ /api/v1/servers/

Mepụta sava ọhụrụ

Na-ewere n'ogbe sava ọfụụ maka ịrụnye ma na-eziga ya n'oge na-adịghị anya nakwa na-ewere n'ogbe ọnọdụ. Nhazi ahụ na-aga n'ihu na azụ: pịa n'ogbe ọnọdụ n'ebe nkesa ruo mgbe a na-eweta ya. Mgbe sava ahụ dị njikere, ozi ndị ahụ ejirila na-ebanye na-eziga ozi-e n'aka onye nwe akaụntụ ahụ.

Akaụntụ gị chọrọ ụzọ nkwụ ụgwọ echekwara. N'ihe banyere akụkọ ihe mere eme akaụntụ gị, a ga-etinye oge n'oge gara aga nke n'ihe fọrọ nke nta ka ọ bụrụ izu nke ego ntọala (ọbụla 1 USD) na kaadị gị tupú e mepụtara sava ahụ.

Ikikere achọrọ: servers:create

Rịọ maka paramita ahụ

Paramita	Ụdị	A chọrọ	Ndesịta ozi ndị ahụ
`hostname`	string	Ee	Ótùó 3 nke akara. Akwụkwọ, díjītà, haị̀péèsì nà ákàrà̀.
`location_id`	integer	Ee	Id nke ebe ọfụụ site na ebe API
`plan_uuid`	string	Ee	Uuid nke usoroiheomume na-arụ ọrụ site na API usoroiheomume
`operating_system_version_uuid`	string	Ee	Uuid nke nbanye na-arụ ọrụ na ndesịta nsụgharị sistem ojieme
`ssh_key_uuids`	array	Ọ bụghị	UUIDs nke SSH kii site na SSH Kii API iji wụnye na sava
`ssh_key_ids`	array	Ọ bụghị	Integer ids nke SSH kii, dịka n'ebemkpofuozi maka ssh_key_uuids. Ọ bụrụ na ha abụọ émēela, ssh_key_ids émēela.
`ssh_key_uuid`, `ssh_key_id`	string, integer	Ọ bụghị	Nhazi nke kii SSH ọfụụ
`auth_method`	string	Ọ bụghị	paswọọdụ, ssh_kii mọọbụ ha abụọ. Dìfọ́ọ̀ltụ̀ na paswọọdụ, mọọbụ ha abụọ mgbe SSH kii a na-enye.

Arịrịọ Ihe Nlereanya

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

Ihe Nlereanya Azịza

201 E mepụtara ya na n'ụdị ọrụ zuru ezu nke e gosiri n'okpuru Nweta ozi ndị ọbjektị. Ndesịta adreesị na vmid a na-agbakwunye n'oge ọbụla mgbe mmepe ahụ gachara.

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

Koodu Ọnọdụ Nzaghachi

201	E mepụtara sava ahụ ma wụnye ya
400	Ndehie nkwenye, dịka ọmụmaatụ ebe ọfụụ, usoroiheomume mọọbụ ụdị sistem ojieme
402	Enweghị ụzọ nkwụ ụgwọ na faịlụ, inweta na-enweghị nkwụghachi, mọọbụ ikikembanye kaadị e hapụla
403	Ndehie mọọbụ token API adịghị mma, mọọbụ token enweghị ikikembanye achọrọ
429	Akaụntụ gị ruru n'okporo ụzọ nke mmeghari sava ya

Nweta /api/v1/servers/{uuid}/

Nweta nkọwa nke sava

Na-eziga sava otu na ebe ya, usoroiheomume, sistem ojieme, adreesị IP nakwa ọrụ atọ nke ọfụụ.

Ikikere achọrọ: servers:list

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

Ihe Nlereanya Azịza

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

Aịkọn SVG na ndesịta nke mbido a na-ewepụ n'ebe a.

Ubi Nzaghachi

_Òkè	Ụdị	Ndesịta ozi ndị ahụ
`vmid`	integer \| null	Nọmba nke igwe virga, ahazila mgbe a na-edebata
`location`	object	Ebe ọbjektị, dịka e megharịrị ya site na Ebe API
`plan`	object	Plan object, dịka ejirila Plans API banye
`operating_system`, `operating_system_version`	object	Sistemụ ọrụ na ụdị ébéńchò́chò́nụ̀ ébéńchò́
`ipv4_addresses`, `ipv6_addresses`	array	Ónyénwē otu n'ime adreesị na ip, gateway, subnet na rdns (ónyénwē DNS nke agbanweela)
`recent_actions`	array	Ruo n'ihe omume atọ nke ikpeazụ: id, ihenhọrọ, ihenhọrọ_display, nkọwa, onye ọrụ_imeesị, kewara_na

Koodu Ọnọdụ Nzaghachi

200	Enwetara nkọwa sava nke ọma
404	Agaghị achọpụtara ya, mọọbụ ọ bụ nke ọzọ akaụntụ

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

Nhazi sava

Nnyemaka n'ime n'ime maka polling mgbe ịkewapụtala, ike ma ọ bụ megharịa nha sava.

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
}

Valiu ọnọdụ sava

Valiu	Ndesịta ozi ndị ahụ
`queue`	N'ime usoroiheomume (debata, ike, megharịa nha, weghachi) ébūbùlà ma ọ bụ na-aga n'ihu
`deploying`	Na-echekwa. Sarùbàlụ̀ ndị a haziri site na paneelụ́ nlekọta na-eji ọnọdụ a; saràbàlụ̀ ndị a haziri site na API nọ n'ótù ruo mgbe ha nọ n'ótù.
`on`	Na-arụ ọrụ
`off`	E wepụrụ ike
`error`	Nhazi nke ikpeazụ akwụsịla. Gụọ ndesịta ihenhọrọ_ihenhọrọ.
`suspended_payment`	E wepụrụ n'ihi na inweta ndị a na-akwụghị ụgwọ

ANYỊ /api/v1/servers/{uuid}/power/

Nhazi ọrụ

Na-ewere ọrụ ike n'okporo ụzọ. Ogo sava gbanwere ka ọbụna n'okporo ụzọ ruo mgbe ọrụ ahụ gasịrị.

Ikikere achọrọ: servers:power

Rịọ maka paramita ahụ

Paramita	Ụdị	A chọrọ	Ndesịta ozi ndị ahụ
`action`	string	Ee	`start`: ike `shutdown`: gráìlụ̀ shutdown, ébūbúlà ya ma ọ bụrụ na ọ̀bịa ahụ achọghị ịkwụsị `restart`: Hárịrị iké n'ótú (nkwụsị, mgbe ahụ bido) `stop`: Oge a na-emegharị ike n'ụzọ dị ka ọbụla dịka ịmalitegharịa. Jiri nkwụsịtụ ka ịhapụ sava n'enweghị ike.

Arịrịọ Ihe Nlereanya

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

Ihe Nlereanya Azịza

{
  "message": "Server restart queued"
}

Koodu Ọnọdụ Nzaghachi

200	Nhazi ahụ ébūbúlà
400	Nhazi ahụ enweghị ma ọ bụ a na-akwado ya
402	Nhazi ahụ akwụsịghị n'ihi na akaụntụ ahụ nwere inweta ndị a na-akwụghị ụgwọ
404	Agaghị achọpụtara ya, mọọbụ ọ bụ nke ọzọ akaụntụ

ANYỊ /api/v1/servers/{uuid}/resize/

Weghachi ụhara sava

Kpụga sava na-arụ ọrụ ọzọ. Nhazi ọfụụ ahụ agaghị enwe ebe diski dị obere karịa nke ọfụụ, nakwa a ga-ejikọta ihenhọrọ ahụ n'ihenhọrọ ahụ iji gbanwee nha. Nhazi ọfụụ maka nhazi ọfụụ a hụchara n'ihu ihe ọbụla a na-ewere n'oche, yabụ a ga-ewepụrịrị nhazi ahụ na sava ahụ n'enweghị mgbanwe.

Sarùbàtà ahụ émechiela mgbe a na-agbanwe nha ya nakwa mgbe a na-ebubata ya ọzọ. Ọ bụrụ na mmegharị nha ahụ ébeghị, saràbàtà ahụ a na-ébubata ya n'ihe n'ihu ya nakwa mgbe a na-ebubata ya ọzọ ma ọ bụrụ na ọ na-arụ ọrụ. Agaghị ébubata mmepe diski.

Ikikere achọrọ: servers:resize

Rịọ maka paramita ahụ

Paramita	Ụdị	A chọrọ	Ndesịta ozi ndị ahụ
`action`	string	Ee	Enweghị ike ịgbanwe ụhara
`new_plan_uuid`	string	Ee	Uuid nke usoroiheomume a ga-akpụga na ya

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

Ụdị nke ngbanwe ụhara a hapụghị (409):

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

Koodu Ọnọdụ Nzaghachi

200	Nhazi ahụ ébūbúlà
400	Nhazi na-efu ma ọ bụ new_plan_uuid, n'ezighị ezi mọọbụ n'enweghị mmem, n'ihe n'ime ebe diski, mọọbụ n'ihe n'ime GPU (ihe n'ime GPU agaghị agbanwe ụhara ya site na API)
404	Agaghị achọpụtara ya, mọọbụ ọ bụ nke ọzọ akaụntụ
409	Ngbanwe n'ụhara mọọbụ nchekwa bụ n'obere n'ime usoroiheomume, mọọbụ enweghị ike ịrụ ọrụ n'ihenhọrọ ahụ maka usoroiheomume ọfụụ
503	Agaghị achọtara ike n'oge a. Saru ahụ agbanweghịla; pịa ọzọ mgbe ahụ.

ANYỊ /api/v1/servers/{uuid}/reset-password/

Weghachi okwumbanye nwuo

Na-emegharị okwumbanye ruoti ọfụụ, na-eziga ya n'ime nzaghachi nakwa na-echekwa mgbanwe na sava. A na-ezigakwa okwumbanye ọfụụ n'ime oziimeele ahụ. A ga-ewepụ sava ahụ. Enweghị mkpado n'ihe achọrọ.

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

Koodu Ọnọdụ Nzaghachi

200	Nhazi ahụ ébūbúlà
400	Sarùbàtà ahụ agaghị etinyenwu ya n'ọrụ
404	Agaghị achọpụtara ya, mọọbụ ọ bụ nke ọzọ akaụntụ

Nweta ANYỊ /api/v1/servers/{uuid}/rdns/

DNS n'okporo ụzọ

GET na-egosi ndesịta aha ónyénwē DNS nke IPv4 na IPv6 adreesị niile na sava ahụ. POST na-ehazi ya maka adreesị otu. Itinye aha ónyénwē nke mebiri emebi na-ewepụ adreesị na dìfọ́ọ̀ltụ̀ aha DNS nke ónyénwē ahụ.

Ikikere achọrọ: servers:update

Rịọ maka paramita ahụ (POST)

Paramita	Ụdị	A chọrọ	Ndesịta ozi ndị ahụ
`ip`	string	Ee	IPv4 mọọbụ IPv6 adreesị a haziri maka sava a
`hostname`	string	Ọ bụghị	Aha ónyénwē PTR. Wepụ nke ọfụụ ka ịhazigharịa na dìfọ́ọ̀ltụ̀.

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

Ńgwānụ́ GET:

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

Koodu Ọnọdụ Nzaghachi

400	IP enweghị, mọọbụ aha ọ̀dọ̀ ahụ agaghị ahazi
404	Agaghị egosipụtara adreesị IP na sava a

ANYỊ /api/v1/servers/{uuid}/exec/

Bido iwu na sava

Na-arụ ọrụ iwu shéèlì n'ime sava site n'aka onyeisi ónyénwē QEMU na-echere ka ọ gwụchaa. Ònyénwē ahụ ga-émè ka a wụnye ya na-arụ ọrụ, na qemu-guest-agent ga-émè ka a wụnye ya na-arụ ọrụ na onyeisi ónyénwē ahụ.

Ikikere achọrọ: servers:exec

Rịọ maka paramita ahụ

Paramita	Ụdị	A chọrọ	Ndesịta ozi ndị ahụ
`command`	string	Ee	Bido iwu laịini na /bin/sh -c, ruo akara 2000
`timeout`	integer	Ọ bụghị	Sekọnd iji kwụsị maka iwu, 1 ruo 300 (dìfọ́ọ̀ltụ̀ 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
}

Ọ bụrụ na iwu ahụ na-arụ ọrụ mgbe oge mmechi gachara, nzaghachi ahụ nwere timed_out ehazie ka eziokwu na exit_code ehazie ka null.

Koodu Ọnọdụ Nzaghachi

200	Ndụmọdụ ahụ egwụla ma ọ bụ oge eruola
400	Sarúọ̀lụ̀ a na-ébeghị̀ ma ọ bụ na-ébeghị̀ ọrụ, mọọbụ parámità ndị na-adịghị mma
409	QEMU guest agent anaghị arụ ọrụ na sava
503	Nchegbu n'ịkpọkọ oge ụfọdụ. Nnabata mgbe Retry-After héèdì ahụ.

HICHAPỤ /api/v1/servers/{uuid}/

Hichapụ ihe nkesa

Na-ewere saịvụ n'okporo ụzọ maka ịkpụga n'obere. Saịvụ ahụ na-apụ n'ime ndesịta n'oge na-adịghị anya ma ọ gaghị adịghachi.

Ikikere achọrọ: 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"
}

Koodu Ọnọdụ Nzaghachi

202	Ekwenyere: a hapụrụ arịrịọ ahụ n'ogbe
404	Agaghị achọpụtara ya, mọọbụ ọ bụ nke ọzọ akaụntụ

Nweta ANYỊ /api/v1/ssh-keys/

Kii SSH

Chekwaa kii SSH nke ndị mmadụ na akaụntụ gị, mgbe ahụ banye uruids ha dịka ssh_key_uuids mgbe ịkewapụtala sava. GET na-egosi uruids gị (25 n'ihuakwụkwọ); POST na-egbakwunye otu.

Ikikere achọrọ: ssh-keys:list (GET), ssh-keys:create (POST)

Rịọ maka paramita ahụ (POST)

Paramita	Ụdị	A chọrọ	Ndesịta ozi ndị ahụ
`name`	string	Ee	Aha iji mara kii site na, ruo 100 akara
`public_key`	string	Ee	Kii ndị mmadụ na OpenSSH n'ụdị, dịka ọmụmaatụ ihenhọrọ nke id_ed25519.pub

Arịrịọ Ihe Nlereanya

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

Ihe Nlereanya Azịza

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

Ubi Nzaghachi

_Òkè	Ụdị	Ndesịta ozi ndị ahụ
`id`, `uuid`	integer, string	Kii ngosi. Jiri uuid na ssh_key_uuids na na URL n'okpuru; id na-arụ ọrụ na ssh_key_ids.
`fingerprint`	string	MD5 finger nke kii, echepụtara site na plataǹèmù
`last_used_at`	datetime \| null	Mgbe a haziri kii ahụ na sava ọfụụ

Koodu Ọnọdụ Nzaghachi

201	Ékwàràlà kii
400	Aha e nweghị, mọọbụ kii publọ́ọ̀lụ̀ bụ kii SSH publọ́ọ̀lụ̀ dị́ mma

Nweta HICHAPỤ /api/v1/ssh-keys/{uuid}/

Wepụta mọọbụ wepụ kii SSH

GET na-eziga kii otu na mpaghara ebe n'elu. DELETE na-ewepụ ya n'aka akaụntụ gị na-eziga 204 na enweghị ọbụna ọbụna. Ihichapụ kii na-ewepụ ya site na sava ọbụla. Agaghị edezi kii: ewepụ na gbakwunye ọzọ.

Ikikere achọrọ: 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"

Nchekwa na Snéèpshóòtì

Ọrụ sava bụkwa ịmepụta ebemkpofuozi mọọbụ ngwefoto:

POST /api/v1/servers/{uuid}/backup/: API ndabere
POST /api/v1/servers/{uuid}/snapshot/: Foto API

VPS.org API

Depụta sava niile

Paịmatị Ajụjụ

Arịrịọ Ihe Nlereanya

Ihe Nlereanya Azịza

Ubi Nzaghachi

Koodu Ọnọdụ Nzaghachi

Mepụta sava ọhụrụ

Rịọ maka paramita ahụ

Arịrịọ Ihe Nlereanya

Ihe Nlereanya Azịza

Koodu Ọnọdụ Nzaghachi

Nweta nkọwa nke sava

Ihe Nlereanya Azịza

Ubi Nzaghachi

Koodu Ọnọdụ Nzaghachi

Nhazi sava

Valiu ọnọdụ sava

Nhazi ọrụ

Rịọ maka paramita ahụ

Arịrịọ Ihe Nlereanya

Ihe Nlereanya Azịza

Koodu Ọnọdụ Nzaghachi

Weghachi ụhara sava

Rịọ maka paramita ahụ

Koodu Ọnọdụ Nzaghachi

Weghachi okwumbanye nwuo

Koodu Ọnọdụ Nzaghachi

DNS n'okporo ụzọ

Rịọ maka paramita ahụ (POST)

Koodu Ọnọdụ Nzaghachi

Bido iwu na sava

Rịọ maka paramita ahụ

Koodu Ọnọdụ Nzaghachi

Hichapụ ihe nkesa

Koodu Ọnọdụ Nzaghachi

Kii SSH

Rịọ maka paramita ahụ (POST)

Arịrịọ Ihe Nlereanya

Ihe Nlereanya Azịza

Ubi Nzaghachi

Koodu Ọnọdụ Nzaghachi

Wepụta mọọbụ wepụ kii SSH

Nchekwa na Snéèpshóòtì