API Àwọn olupin

GBÀ /api/v1/servers/

Ṣe àkójọ gbogbo àwọn olùpèsè

Returns the servers in your account, newest first, 25 per page. Servers that are being deleted are not included.

Àwọn ìkúndùǹ tí a fẹ́: servers:list

Àwọn Ìbéèrè Pàtàkì

Àwọn Àtòjọ-ẹ̀yàn	Irú	Ti a nilo	Àwọn Àkọlé
`page`	integer	_Kò	Page number, starting at 1
`page_size`	integer	_Kò	Àwọn ìrísí-lẹ́tà fún ojú-ìwé kan (ò̀tọ́ àwọn ìṣàmúlò-ètò 25, ìṣàmúlò-ètò kékeré 100)

Àpẹẹrẹ Ìbéèrè

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

Àpẹẹrẹ Ìdáhù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
    }
  ]
}

Àwọn Ààyè Ìdáhùn

Àwọn Ààyè-iṣẹ́	Irú	Àwọn Àkọlé
`uuid`	string	Àtòjọ-ìṣàfilọ́lẹ̀ àwọn sáà tí a lo nínú àwọn ààtò ìparí sáà ní gbogbo
`hostname`	string	Orúkọ́ àwọn ààtòjútó tí o yàn láti fi àwọn sáà pamọ́
`status`	string	Àwọn ìṣàmúlò-ètò lọ́wọ́lọ́wọ́. Wó Àwọn Àwọn Ìṣàmúlò-ètò Sáà ní ààyè ìsàlẹ̀-ètò.
`error_description`	string \| null	Àwọn ìròyìn ìpàlẹ̀ ìtàtì ìtàtì tí a bá fi àwọn ààtò àìpàlẹ̀ pamọ́, tí a bá jẹ́ àìpàlẹ̀
`location_name`	string	Orúkọ ààyè-iṣẹ́ tí àwọn sáà bá ṣiṣẹ́ nínú rẹ
`os_name`	string	Orúkọ́ ìṣàmúlò-ètò, látì ìṣàmúlò-ètò
`plan_name`	string	Àwọn àwọn àkóónú àwọn ààtò àtòjọ-ẹ̀yàn, bíi àwọn ààtò 1 vCPU / 2 GB RAM / 10 GB
`ipv4_addresses`	array	Àdírẹ̀sì IPv4 bí àwọn àyọkà. Kò ní pàtó tití sáà á fi ṣẹ́dà, àti ní àwọn ìṣàmúlò-ètò àtí IPv4.
`ipv6_addresses`	array	Àdírẹ̀sì IPv6 bí àwọn ìtàn. Àwọ́fẹ́ láti fi sáà pamọ́.
`created_at`	datetime	Creation time (ISO 8601, UTC)
`deployed`	boolean	Àwọn ààyè-iṣẹ́ àwọn ìṣàmúlò-ètò

Àwọn Kóòdù Ipò Ìdáhùn

200	A ṣe àṣeyọrí láti rí àkójọ olupin náà
403	Tokénà API tí kò bá jẹ́ tàbí tí kò bá jẹ́, tàbí tokénà náà kò ní ìṣẹ̀dà tí a fẹ́

Àwọn Àkọlé /api/v1/servers/

Ṣẹ̀dá olupin tuntun

Fi sáà tuntun lọ́wọ́lọ́wọ́ fún ìṣàfihàn àti ìpàlẹ̀ rẹ̀ nígbà kéré nípa àwọn ààtò ìṣàfihàn ìṣàmúlò-ètò. Àwọn ìṣàfihàn náà ń lọ nínú ìsàlẹ̀: àwọn ìṣàfihàn ìsàlẹ̀ ìparí iṣẹ́ nípà ìṣàfihàn nípà òótọ́. Tó bá jẹ́ pé sáà náà tí wọ́n tí ìwé-ìwọlé rẹ̀ lọ́wọ́lọ́wọ́ sí olùbàlú kọ̀ǹpútà.

Your account needs a saved payment method. Depending on your account history, a temporary pre-authorization hold of about one week of the plan price (at least 1 USD) may be placed on your card before the server is created.

Àwọn ìkúndùǹ tí a fẹ́: servers:create

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àwọn Àtòjọ-ẹ̀yàn	Irú	Ti a nilo	Àwọn Àkọlé
`hostname`	string	Bẹ́ẹ̀ni	Àwọn àmì-àṣírí 3 ní pàtó. Àwọn àyọkà, àwọn ìtàn, àwọn ìṣàmúlò-ètò àti àwọn ìtàn ní pàtó.
`location_id`	integer	Bẹ́ẹ̀ni	ID ààyè-iṣẹ́ tí a lo láti inú àwọn ààyè-iṣẹ́ API
`plan_uuid`	string	Bẹ́ẹ̀ni	Uuid tí àtòjọ-ètò láti inú API àtòjọ-ètò
`operating_system_version_uuid`	string	Bẹ́ẹ̀ni	Uuid tí àtòjọ-ẹ̀yàn tí a lò nínú àtòjọ ìṣàmúlò-ètò
`ssh_key_uuids`	array	_Kò	UUIDs àwọn bọ́tìnì SSH láti inú API àwọn bọ́tìnì SSH láti fi ààtòjú sí ààtòjú
`ssh_key_ids`	array	_Kò	Àwọn ID inúrẹ̀tì àwọn bọ́tìnì SSH, bí àwọn ìṣàmúlò-ètò láti ssh_key_uuids. Tó bá jẹ́ pé àwọn mejeeji tí a fi ranṣẹ, a lò ssh_key_ids.
`ssh_key_uuid`, `ssh_key_id`	string, integer	_Kò	Àwọn ìkúndùǹ fún bọ́tìnì SSH kan
`auth_method`	string	_Kò	Àwọn àmì-àṣírí, àwọn bọ́tìnì ssh_key tabi àwọn meji. Àwọn ìpèwọ̀n fún àwọn àmì-àṣírí, àti fún àwọn mejeeji tí àwọn bọ́tìnì SSH tí a fi pamọ́.

Àpẹẹrẹ Ìbéèrè

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

Àpẹẹrẹ Ìdáhùn

201 Created with the full server object described under Get Server Details. Addresses and vmid are filled in once deployment finishes.

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

Àwọn Kóòdù Ipò Ìdáhùn

201	Àwọn ààtò àtòjọ-ẹ̀yàn
400	Àṣìṣe ìṣàfarawé ìṣàmúlò-ètò, bíi ààyè àìṣàmúlò-ètò, àwọn ààyè àìṣàmúlò-ètò tàbí ìṣàfarawé ìṣàmúlò-ètò
402	Kò ní ìṣàmúlò-ètò pàtó nínú fáìlì, àwọn fátìrì tí a kò pà, tàbí ìgbàlẹ̀ ìṣàfarawé kaadì tí a tí ìpàdé
403	Tokénà API tí kò bá jẹ́ tàbí tí kò bá jẹ́, tàbí tokénà náà kò ní ìṣẹ̀dà tí a fẹ́
429	Your account has reached its server creation limit

GBÀ /api/v1/servers/{uuid}/

Gba Awọn alaye olupin

Ń pá àwọn sáà kọ̀ǹpútà kan láti inú ààyè-iṣẹ́ rẹ, àwọn ìṣàmúlò-ètò, àwọn sísèmù ìṣàmúlò-ètò, àwọn àdírẹ̀sì IP àti àwọn ìṣàmúlò-ètò ìtàn.

Àwọn ìkúndùǹ tí a fẹ́: servers:list

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

Àpẹẹrẹ Ìdáhùn

{
  "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̀wọn àmì-ìwé áíkànnù SVG àti àtòjọ ìṣàmúlò-ètò ní pàtó níbẹ̀.

Àwọn Ààyè Ìdáhùn

Àwọn Ààyè-iṣẹ́	Irú	Àwọn Àkọlé
`vmid`	integer \| null	Àwọn ààtò àìṣàmúlò-ètò
`location`	object	Àwọn àwọn ààyè-iṣẹ́ ààyè-iṣẹ́, bí àwọn ààyè-iṣẹ́ API ṣe lágbára
`plan`	object	Àwọn àwọn àkóónú àtòjọ-ẹ̀yàn, bí àwọn àtòjọ-ẹ̀yàn API ṣe gbọ́
`operating_system`, `operating_system_version`	object	Sítàmú ìṣàmúlò-ètò náà àti ìṣàmúlò-ètò ìṣàfarawé, bí àwọn Ìṣàmúlò-ètò API ṣè pàtó
`ipv4_addresses`, `ipv6_addresses`	array	Àwọn àwọn ààyè-iṣẹ́ àwọn ààyè-iṣẹ́ kan nípa IP, ààyè-iṣẹ́, àwọn ààyè-iṣẹ́ àti rdns (àtí àwọn àtíjà DNS)
`recent_actions`	array	Àwọn ìṣàmúlò-ètò ìtàn lọ́wọ́lọ́wọ́: ID, ìṣàmúlò-ètò, ìṣàfihàn_ìṣàmúlò-ètò, ìṣàfihàn, àmì-ìwé_òǹlò, àìṣàfihàn_ní_àtí

Àwọn Kóòdù Ipò Ìdáhùn

200	A ṣe àṣeyọrí rí àwọn àlàyé olupin
404	Kò rí, tàbí ò jẹ́ àwọn

GBÀ /api/v1/servers/{uuid}/status/

Gba Àwọn Àtòjọ-ètò Sáà

Àkọ́gbè àìbálẹ̀ fún ìṣàmúlò-ètò láti sé àwọn ìṣàmúlò-ètò láti inú àwọn ààyè-iṣẹ́.

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
}

Àwọn Àwọn Ìṣàmúlò-ètò Àwọn Sáà

Àwọn	Àwọn Àkọlé
`queue`	Àwọn ìṣàmúlò-ètò (ìṣàmúlò-ètò, ìpéwọ̀n, ìṣàmúlò-ètò, ìṣàmúlò-ètò) tí a fi pamọ́ láti inú àwọn ìṣàmúlò-ètò tàbí láti inú ìṣàmúlò-ètò
`deploying`	Àwọn sáà tí a ṣẹ̀dà láti inú pánẹ́ẹ̀lì ìṣakosó náà ló ìgbà yìí; sáà tí a ṣẹ̀dà láti inú API náà tí wọ́n sí ààtòòtì nígbà tí a bá jẹ́ pé.
`on`	Ńlà ìṣàmúlò-ètò
`off`	Tí a fi pà
`error`	Àwọn ìṣàmúlò-ètò tókàn tí kò bá. Wòye àkóónú àkọ́lé_àpàlẹ̀.
`suspended_payment`	Tí a fi pàtó fún àwọn à

Àwọn Àkọlé /api/v1/servers/{uuid}/power/

Ìṣàmúlò-ètò

Fi àwọn ìṣàmúlò-ètò ìṣàmúlò-ètò pàtó. Àwọn ìṣàmúlò-ètò àwọn sáà yipadà sí àwọn ìṣàmúlò-ètò titi àwọn ìṣàmúlò-ètò náà fi kù.

Àwọn ìkúndùǹ tí a fẹ́: servers:power

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àwọn Àtòjọ-ẹ̀yàn	Irú	Ti a nilo	Àwọn Àkọlé
`action`	string	Bẹ́ẹ̀ni	`start`: Ìpàpọ̀lú `shutdown`: fifọ́ọ̀lù àìpàlẹ̀, tí a fi pamọ́ láti àwọn àgbèwọlé tí a kò bá dẹ́kun `restart`: Ìjánu-ìmúdúró ìbárá (tí a bá dáwọ́, tí a bá bẹrẹ) `stop`: nígbà yìí ń ṣé ìṣàmúlò-ètò agbarà tí a tí ń pàtó bí a tí ń pà. Ló ìpàsẹ́ láti fi sáà pà.

Àpẹẹrẹ Ìbéèrè

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

Àpẹẹrẹ Ìdáhùn

{
  "message": "Server restart queued"
}

Àwọn Kóòdù Ipò Ìdáhùn

200	Àwọn ìṣàmúlò-ètò
400	Àwọn ìṣàmúlò-ètò tí a kò bá
402	Ìṣàfilọ́lẹ̀ tí a dẹ́kun nitorí pé aagójútó náà ní àwọn fátìrì tí a kò pà
404	Kò rí, tàbí ò jẹ́ àwọn

Àwọn Àkọlé /api/v1/servers/{uuid}/resize/

Àwọn Àwọn Ààtòjú ààyè-iṣẹ́

Gbé sáà sí àwọn àtòjọ-ẹ̀yàn tí a tí ṣiṣẹ́. Àtòjọ-ẹ̀yàn tuntun kò lè ni ààyè disiki tí o kù ju àtòjọ-ẹ̀yàn lọ́wọ́lọ́wọ́, àti àwọn ìṣàmúlò-ètò ìṣàmúlò-ètò ní pàtó àwọn ìṣàmúlò-ètò tí a tí ṣe. Àwọn ìṣàmúlò-ètò hypervisor fún àtòjọ-ẹ̀yàn tuntun ní a ṣàyẹwo láti inú àwọn àtòjọ-ẹ̀yàn, láti jẹ́ pé àtòjọ-ẹ̀yàn tí a tí ìpàdé kò lè yipada.

Sáà tí pà nígbà tí a bá pàtó ókùǹdégé àti àtípàdé nígbà tí a bá pàtó. Tó bá jẹ́ pé ìṣàfarawé ìwọ̀n kò bá jẹ́, sáà tí a pàtó ní pàtó àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn ààtò àwọn àa

Àwọn ìkúndùǹ tí a fẹ́: servers:resize

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àwọn Àtòjọ-ẹ̀yàn	Irú	Ti a nilo	Àwọn Àkọlé
`action`	string	Bẹ́ẹ̀ni	Ò yẹ́ ki o yipada ìwọ̀n
`new_plan_uuid`	string	Bẹ́ẹ̀ni	Uuid àtòjọ-ẹ̀yàn láti gbé sí

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

Example of a refused resize (409):

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

Àwọn Kóòdù Ipò Ìdáhùn

200	Àwọn ìṣàmúlò-ètò
400	Àwọn ìṣàmúlò-ètò àti àwọn ààtò àtòjọ-ẹ̀yàn_uuid_tí kò wa, àtòjọ-ẹ̀yàn tí kò bá jẹ́ àìdájú àwọn àtòjọ-ẹ̀yàn, àtòjọ-ẹ̀yàn GPU (a kò lè yipada àwọn àtòjọ-ẹ̀yàn GPU láti inú API)
404	Kò rí, tàbí ò jẹ́ àwọn
409	Àwọn ìṣàfarawé ìwọ̀n tàbí ìṣàfarawé ìpamọ́ tí wa ní ìjánu-ìṣàmúlò-ètò, tàbí àwọn ìṣàmúlò-ètò hypervisor tí kò kù ní àwọn ìṣàmúlò-ètò tuntun
503	Kò lè ṣayẹwo ìgbàráwọ́ nígbà yìí. Àwọn sáà kò yipada; ṣàfihàn lẹ́ẹ̀kaǹ.

Àwọn Àkọlé /api/v1/servers/{uuid}/reset-password/

Ṣàfikún Àmì-àṣírí Rẹ́

Ṣẹ̀dà àmì-àṣírí root tuntun, fi pamọ́ sínú ìṣàfarawégbèyè náà àti ìṣàfarawégbèyè ìyipada náà lórí sáà. Àmì-àṣírí tuntun náà tun tí a fi àkọlé àwòrán ranṣẹ sí ọ. Sáà tó yẹ kí a fi pamọ́. Kò ní àwọn ẹ̀yàn ìtàn tí a fẹ̀.

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

Àwọn Kóòdù Ipò Ìdáhùn

200	Àwọn ìṣàmúlò-ètò
400	Àwọn ààtòjútó àwọn ààtòjútó
404	Kò rí, tàbí ò jẹ́ àwọn

GBÀ Àwọn Àkọlé /api/v1/servers/{uuid}/rdns/

DNS Ìpàlẹ̀ (PTR)

GET ṣàfihàn àwọn àmì-ìwé DNS ìṣàfarawé àwọn àdírẹ̀sì IPv4 àti IPv6 fún gbogbo wọn lórí sáà. POST ń fi àwọn àdírẹ̀sì kan han. Àwọn àmì-ìwé àìpàlẹ̀ àwọn àdírẹ̀sì láti fi àwọn àmì-ìwé DNS ìṣàfarawé àwọn àdírẹ̀sì àìpàlẹ̀ rẹ̀ pamọ́.

Àwọn ìkúndùǹ tí a fẹ́: servers:update

Ìbéèrè fún Àwọn Ìwọ̀n Ara (POST)

Àwọn Àtòjọ-ẹ̀yàn	Irú	Ti a nilo	Àwọn Àkọlé
`ip`	string	Bẹ́ẹ̀ni	Àdírẹ̀sì IPv4 tàbí IPv6 tí a fi pamọ́ fún sáà yìí
`hostname`	string	_Kò	Orúkọ́ àwọn ààtòjú PTR. Fi àwọn ààtòjú pamọ́ láti pàtó àwọn ìpéwọ̀n.

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

Àwọn ìṣàmúlò-ètò

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

Àwọn Kóòdù Ipò Ìdáhùn

400	IP ti kù, tàbí àwọn orúkọ àìṣàmúlò-ètò kò lè àtòjọ
404	Àdírẹ̀sì IP kò wa ní pàtó fún àwọn sáà yìí

Àwọn Àkọlé /api/v1/servers/{uuid}/exec/

Rọ́ọ̀nù Àṣẹ̀ Nínú Sáfíìlì

Rọ́ọ̀nù àṣẹ ìsàlẹ̀-ilà nínú sáà láti inú awáròyìn QEMU àti ìyàǹjú ìparí rẹ̀. Sáà tó yẹ ki o jẹ́ àìṣàfilọ́lẹ̀ àti ìṣàmúlò-ètò, àti àìṣàfilọ́lẹ̀-awáròyìn-qemu-ní yẹ ki o jẹ́ àìṣàfilọ́lẹ̀ àti ìṣàfilọ́lẹ̀ nínú awáròyìn.

Àwọn ìkúndùǹ tí a fẹ́: servers:exec

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àwọn Àtòjọ-ẹ̀yàn	Irú	Ti a nilo	Àwọn Àkọlé
`command`	string	Bẹ́ẹ̀ni	Rọ́ọ̀nù àtòjọ-ẹ̀yàn àtòjọ-ẹ̀yàn láti inú /bin/sh -c, sí àwọn àmì-ìwé 2000
`timeout`	integer	_Kò	Àwọn ìsàlẹ̀-ìwé láti gbá àṣẹ, 1 sí 300 (30 ìṣàmúlò-ìwé)

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
}

Tó bá jẹ́ pé àṣẹ náà tí àkóónú àkójútó náà bá jẹ́ òótọ́, àwọn ìṣàmúlò-ètò náà ní ìṣàmúlò-ètò tí a fi àwọn à

Àwọn Kóòdù Ipò Ìdáhùn

200	Àṣẹ ti kù tabi ti kù nígbà ìtàn
400	Àwọn ààtòjútó àwọn sáà kò wa ní àwọn ààtòjútó àwọn ààtòjútó
409	Àwọn ààyè-iṣẹ́ àgbèwọlé QEMU kò bá ṣiṣẹ́ lórí sáà
503	Temporary connection problem. Retry after the Retry-After header.

PARÍPÁRÁ /api/v1/servers/{uuid}/

Pa olupin rẹ

Fi àwọn sáà pamọ́ sípàtó. Sáà náà kù ní àwọn àtòjọ náà láti inú àwọn àtòjọ náà láti sàyégé.

Àwọn ìkúndùǹ tí a fẹ́: 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"
}

Àwọn Kóòdù Ipò Ìdáhùn

202	A gba: àkóónú náà tí a fi pamọ́
404	Kò rí, tàbí ò jẹ́ àwọn

GBÀ Àwọn Àkọlé /api/v1/ssh-keys/

Àwọn Àmì-ìwé SSH

Store public SSH keys in your account, then pass their uuids as ssh_key_uuids when you create a server. GET lists your keys (25 per page); POST adds one.

Àwọn ìkúndùǹ tí a fẹ́: ssh-keys:list (GET), ssh-keys:create (POST)

Ìbéèrè fún Àwọn Ìwọ̀n Ara (POST)

Àwọn Àtòjọ-ẹ̀yàn	Irú	Ti a nilo	Àwọn Àkọlé
`name`	string	Bẹ́ẹ̀ni	Orúkọ láti mọ́ bọ́tìnì náà, láti inú àwọn àmì-ìwé 100
`public_key`	string	Bẹ́ẹ̀ni	Bọ́tìnì ìjánu-ìjánu nínú ìṣàfarawé OpenSSH, àwọn àkóónú id_ed25519.pub

Àpẹẹrẹ Ìbéèrè

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

Àpẹẹrẹ Ìdáhùn

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

Àwọn Ààyè Ìdáhùn

Àwọn Ààyè-iṣẹ́	Irú	Àwọn Àkọlé
`id`, `uuid`	integer, string	Àwọn ìṣàfihàn bọ́tìnì. Lo uuid nínú ssh_key_uuids àti nínú URL̀ ìsàlẹ̀-ilà; id náà lo nínú ssh_key_ids.
`fingerprint`	string	Àwọn ìṣàmúlò-ètò MD5 tí a tí kọ́ nínú àwọn ààyè-iṣẹ́
`last_used_at`	datetime \| null	Àwọn ìṣàmúlò-ètò àìṣàmúlò-ètò àìpàlẹ̀ àwọn àwọn ààyè-iṣẹ́

Àwọn Kóòdù Ipò Ìdáhùn

201	Àwọn àwọn
400	Orúkọ tí kò wa, tàbí bọ́tìnì ìjánu-ìṣàmúlò-ètò kò jẹ́ bọ́tìnì ìjánu-ìjánu SSH tó lè jẹ́

GBÀ PARÍPÁRÁ /api/v1/ssh-keys/{uuid}/

Gba àti pa bọ́tìnì SSH

GET yi bọ́tìnì kan padà láti inú àwọn ààyè tí o wa ní ààrin. DELETE yìí padà láti inú àwọn ààyè rẹ̀ láti fi 204 padà láti inú àwọn àwọn ààyè. Tí o bà pa bọ́tìnì kan, o kò yà kù nínú àwọn sáà tí a tì fi pamọ́. Kò lè yipada àwọn bọ́tìnì: pà àwọn

Àwọn ìkúndùǹ tí a fẹ́: 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"

Àwọn ìpamọ́ àti àwọn ààyè-iṣẹ́

Ṣẹ̀dà àwọn ààtò àìpamọ́ tàbí àwọn ààtò ìṣàmúlò-ètò ní ìṣàmúlò-ètò sáà:

POST /api/v1/servers/{uuid}/backup/: API Àfikún
POST /api/v1/servers/{uuid}/snapshot/: Àwọn fọ́tò ìfàsẹ́yìn API

VPS.org API

API Àwọn olupin

Ṣe àkójọ gbogbo àwọn olùpèsè

Àwọn Ìbéèrè Pàtàkì

Àpẹẹrẹ Ìbéèrè

Àpẹẹrẹ Ìdáhùn

Àwọn Ààyè Ìdáhùn

Àwọn Kóòdù Ipò Ìdáhùn

Ṣẹ̀dá olupin tuntun

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àpẹẹrẹ Ìbéèrè

Àpẹẹrẹ Ìdáhùn

Àwọn Kóòdù Ipò Ìdáhùn

Gba Awọn alaye olupin

Àpẹẹrẹ Ìdáhùn

Àwọn Ààyè Ìdáhùn

Àwọn Kóòdù Ipò Ìdáhùn

Gba Àwọn Àtòjọ-ètò Sáà

Àwọn Àwọn Ìṣàmúlò-ètò Àwọn Sáà

Ìṣàmúlò-ètò

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àpẹẹrẹ Ìbéèrè

Àpẹẹrẹ Ìdáhùn

Àwọn Kóòdù Ipò Ìdáhùn

Àwọn Àwọn Ààtòjú ààyè-iṣẹ́

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àwọn Kóòdù Ipò Ìdáhùn

Ṣàfikún Àmì-àṣírí Rẹ́

Àwọn Kóòdù Ipò Ìdáhùn

DNS Ìpàlẹ̀ (PTR)

Ìbéèrè fún Àwọn Ìwọ̀n Ara (POST)

Àwọn Kóòdù Ipò Ìdáhùn

Rọ́ọ̀nù Àṣẹ̀ Nínú Sáfíìlì

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àwọn Kóòdù Ipò Ìdáhùn

Pa olupin rẹ

Àwọn Kóòdù Ipò Ìdáhùn

Àwọn Àmì-ìwé SSH

Ìbéèrè fún Àwọn Ìwọ̀n Ara (POST)

Àpẹẹrẹ Ìbéèrè

Àpẹẹrẹ Ìdáhùn

Àwọn Ààyè Ìdáhùn

Àwọn Kóòdù Ipò Ìdáhùn

Gba àti pa bọ́tìnì SSH

Àwọn ìpamọ́ àti àwọn ààyè-iṣẹ́