VPS.org API

REST API skjölun

Netþjónaskil

Búa til, skoða, máttur, breyta stærð og eyða VPS netþjóna. Netþjónar eru auðkennd með uuid þeirra.

Endapunktar 15
Grunnslóð /api/v1/servers
FÁ /api/v1/servers/

Listi yfir alla netþjóna

Sýnir þjónana á reikningnum þínum, nýjustu fyrst, 25 á síðu. Þjónar sem eru eytt eru ekki með.

Nauðsynlegt leyfi: servers:list

Fyrirspurnarbreytur

Breyta Tegund Nauðsynlegt Lýsing
page integer Nei Síðunúmer, byrjar á 1
page_size integer Nei Niðurstöður á síðu (sjálfgefið 25, hámark 100)

Dæmi um beiðni

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

Dæmi um svar

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

Svarsvið

Field Tegund Lýsing
uuid string Auðkenni þjóns notað í öllum öðrum endapunktum þjóns
hostname string Vélarheiti sem þú valdir þegar þú bjóst til miðlarann
status string Núverandi staða. Sjá Stöðugildi þjóns hér að neðan.
error_description string | null Upplýsingar um síðasta bilun þegar staða er villa, annars null
location_name string Heiti staðsetningar þar sem þjónninn keyrir
os_name string Heiti stýrikerfis, án útgáfu
plan_name string Lesanleg áætlun yfirlit, til dæmis 1 vCPU / 2 GB RAM / 10 GB
ipv4_addresses array IPv4 heimilisföng sem strengir. Tómt þar til miðlarinn er dreift, og á áætlunum án IPv4.
ipv6_addresses array IPv6 vistföng sem strengir. Tómt þar til miðlarinn er sendur út.
created_at datetime Sköpunartími (ISO 8601, UTC)
deployed boolean True þegar úthlutun er lokið

Kóðar fyrir svörunarstöðu

200 Listi yfir netþjóna sóttur
403 Vantar eða ógilt API tákn, eða táknið hefur ekki nauðsynleg leyfi
POST /api/v1/servers/

Búa til nýjan netþjón

Býður nýjan þjón í biðröð til að setja upp og skilar honum strax með stöðuböð. Úthlutun heldur áfram í bakgrunni: spyrja stöðuendapunktinn þar til sett upp er satt. Þegar þjónninn er tilbúinn eru innskráningarupplýsingar hans sendar með tölvupósti til eiganda reikningsins.

Reikningurinn þinn þarf að hafa vistaða greiðsluaðferð. Það fer eftir sögu reikningsins þíns hvort tímabundin heimildarbeiðni um u.þ.b. viku af áætlunarverðinu (að minnsta kosti 1 USD) sé sett á kortið þitt áður en miðlarinn er búinn til.

Nauðsynlegt leyfi: servers:create

Færibreytur beiðninnar

Breyta Tegund Nauðsynlegt Lýsing
hostname string Já Að minnsta kosti 3 stafir. Aðeins bókstafir, tölustafir, tengistrengur og punktur.
location_id integer Já Auðkenni virkrar staðsetningar frá Locations API
plan_uuid string Já Uuid virkrar áætlunar frá Plans API
operating_system_version_uuid string Já UID virkrar færslu í útgáfulista stýrikerfis
ssh_key_uuids array Nei UUIDs af SSH lyklum frá SSH Keys API til að setja upp á miðlara
ssh_key_ids array Nei Heiltölu auðkenni SSH lykla, í stað ssh_key_uuids. Ef bæði eru send er ssh_key_ids notað.
ssh_key_uuid, ssh_key_id string, integer Nei Stytting fyrir einn SSH lykil
auth_method string Nei lykilorð, ssh_ lykill eða bæði. Sjálfgefið er lykilorð, eða bæði þegar SSH lyklar eru gefnir.

Dæmi um beiðni

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

Dæmi um svar

201 Búið til með fullu þjónahlutverki sem lýst er í Get Server Details. Heimilisföng og vmid eru fyllt út þegar dreifingu lýkur.

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

Kóðar fyrir svörunarstöðu

201 Þjónn búinn til og í biðröð fyrir útbreiðslu
400 Staðfestingarvilla, til dæmis óvirk staðsetning, áætlun eða útgáfa stýrikerfis
402 Engin greiðslumáti í skrá, ógreiddar reikningar eða heimildarbeiðni var hafnað
403 Vantar eða ógilt API tákn, eða táknið hefur ekki nauðsynleg leyfi
429 Reikningur þín hefur náð sköpunarmörkum þjónsins
FÁ /api/v1/servers/{uuid}/

Fá upplýsingar um netþjón

Sýnir einn netþjón með staðsetningu, áætlun, stýrikerfi, IP-tölur og fimm nýjustu aðgerðir.

Nauðsynlegt leyfi: servers:list

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

Dæmi um svar

{
  "uuid": "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b",
  "hostname": "web-01",
  "vmid": 1042,
  "status": "on",
  "error_description": null,
  "location": {
    "id": 1,
    "name": "New Jersey",
    "country_name": "United States",
    "is_active": true
  },
  "plan": {
    "uuid": "14186969-fbaf-43e1-9ab2-b1f1aeb66674",
    "cpu": 1,
    "ram": 2,
    "ram_unit": "GB",
    "disk_space": 25,
    "disk_space_total": 25600,
    "transfer": 1,
    "price": "5.00",
    "cpu_type_name": "Shared",
    "is_active": true,
    "hourly_price": "0.007",
    "monthly_price": "5.00",
    "is_gpu": false,
    "gpu_count": 0,
    "gpu_model": ""
  },
  "operating_system": {
    "id": 1,
    "name": "Ubuntu",
    "svg_icon": "<svg ...>",
    "versions": [ ... ]
  },
  "operating_system_version": {
    "uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
    "name": "24.04 LTS x64",
    "os_name": "Ubuntu",
    "os_svg_icon": "<svg ...>",
    "is_active": true
  },
  "ipv4_addresses": [
    {
      "ip": "203.0.113.10",
      "gateway": "203.0.113.1",
      "subnet": "203.0.113.0",
      "rdns": "web-01.example.com"
    }
  ],
  "ipv6_addresses": [
    {
      "ip": "2001:db8:2:dd::f9:6b",
      "gateway": "2001:db8:2:dd::f9:1",
      "subnet": "2001:db8:2:dd::f9:0",
      "rdns": "web-01.example.com"
    }
  ],
  "deployed": true,
  "created_at": "2026-07-30T03:54:14.914364Z",
  "recent_actions": [
    {
      "id": 17028,
      "action": "create",
      "action_display": "Create",
      "description": "Server deployed with VMID 1042",
      "user_email": "you@example.com",
      "created_at": "2026-07-30T03:54:32.860854Z"
    }
  ]
}

SVG tákn merking og útgáfa listi eru stytt hér.

Svarsvið

Field Tegund Lýsing
vmid integer | null Sýndarvél númer, sett við dreifingu
location object Staðsetningarhlutur, eins og hann kemur frá staðsetningar API
plan object Plan hlutur, eins og hann kemur frá Plans API
operating_system, operating_system_version object Stýrikerfi og uppsett útgáfa, eins og það birtist í Operating Systems API
ipv4_addresses, ipv6_addresses array Einn hlutur á heimilisfang með IP, gátt, subnet og rdns (hægri DNS hostname)
recent_actions array Allt að fimm nýjustu aðgerðir: id, aðgerð, action_display, lýsing, user_email, created_at

Kóðar fyrir svörunarstöðu

200 Upplýsingar um netþjóninn sóttar
404 Fannst ekki, eða það tilheyrir öðrum reikningi
FÁ /api/v1/servers/{uuid}/status/

Sækja stöðu þjóns

Létt kalla fyrir könnun eftir að þú býrð til, máttur eða breyta stærð miðlara.

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
}

Staða miðlara

Gildi Lýsing
queue An action (deploy, power, resize, restore) is queued or in progress
deploying Þjónar sem eru búnir til úr stjórnborðinu nota þetta ástand; þjónar sem eru búnir til í gegnum API eru í biðröð þar til þeir eru tilbúnir.
on Keyri
off Slökkt
error Síðasta aðgerð mistókst. Sjá error_description.
suspended_payment Hætta vegna ógreiddra reikninga
POST /api/v1/servers/{uuid}/power/

Stjórna máttur þjóns

Býður upp á aðgerð. Staða þjónsins breytist í biðröð þar til aðgerðinni er lokið.

Nauðsynlegt leyfi: servers:power

Færibreytur beiðninnar

Breyta Tegund Nauðsynlegt Lýsing
action string Já start: kveikt
shutdown: tignarlegur lokun, neyddur burt ef gesturinn hættir ekki
restart: harður orku hringrás (stöðva, þá byrja)
stop: framkvæmir nú sömu rafmagns hringrás og endurræsing. Notaðu shutdown til að láta þjóninn vera slökkt.

Dæmi um beiðni

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

Dæmi um svar

{
  "message": "Server restart queued"
}

Kóðar fyrir svörunarstöðu

200 Aðgerðin var sett í biðröð
400 Vantar eða óstudd aðgerð
402 Upphaf hafnað vegna þess að reikningurinn hefur ógreiddar reikninga
404 Fannst ekki, eða það tilheyrir öðrum reikningi
POST /api/v1/servers/{uuid}/resize/

Breyta stærð þjóns

Flytur þjóninn á annað virkt áætlunarsvæði. Nýja áætlunarsvæðið getur ekki haft minna diskpláss en núverandi áætlunarsvæði og beiðnin verður að innihalda aðgerð sem er sett til að breyta stærð. Stærð hýsingarkerfisins fyrir nýja áætlunarsvæðið er athuguð áður en eitthvað er sett í biðröð, þannig að hafnað beiðni skilur þjóninn óbreyttan.

Þjóninum er lokað meðan hann er breyttur og hann ræstur aftur eftir það. Ef stærðarbreytingin mistekst er þjóninum komið aftur á fyrri áætlun og hann ræstur aftur ef hann var í gangi. Ekki er hægt að snúa við vaxandi disk.

Nauðsynlegt leyfi: servers:resize

Færibreytur beiðninnar

Breyta Tegund Nauðsynlegt Lýsing
action string Já Verður að breyta stærð
new_plan_uuid string Já UID áætlunarinnar sem á að færa til
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æmi um hafnað breytingu á stærð (409):

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

Kóðar fyrir svörunarstöðu

200 Aðgerðin var sett í biðröð
400 Vantar aðgerð eða new_plan_uuid, ógilt eða óvirkt áætlun, áætlun með minna diskpláss, eða GPU áætlun (GPU áætlanir geta ekki breytt stærð í gegnum API)
404 Fannst ekki, eða það tilheyrir öðrum reikningi
409 Breyting á stærð eða geymslu er þegar í gangi eða það er ekki nóg hypervisor getu fyrir nýja áætlunina
503 Ekki var hægt að athuga afkastagetu núna. Þjóninum var ekki breytt; reyndu aftur seinna.
POST /api/v1/servers/{uuid}/reset-password/

Endurstilla lykilorð root

Býr til nýtt rótarlykilorð, skilar því í svarinu og setur breytinguna í biðröð á þjóninum. Nýja lykilorðið er einnig sent þér í tölvupósti. Þjóninn verður að vera í notkun. Engin beiðni þarf að vera í beiðninni.

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

Kóðar fyrir svörunarstöðu

200 Aðgerðin var sett í biðröð
400 Þjónninn er ekki ennþá í notkun
404 Fannst ekki, eða það tilheyrir öðrum reikningi
FÁ POST /api/v1/servers/{uuid}/rdns/

Afturvirk DNS (PTR)

GET skráir afturábak DNS hýsingarheiti allra IPv4 og IPv6 vistfanga á þjóninum. POST setur það fyrir eina vistfang. Ef tómt hýsingarheiti er sent er vistfangið endurstillt á sjálfgefið afturábak DNS heiti.

Nauðsynlegt leyfi: servers:update

Færibreytur beiðninnar (POST)

Breyta Tegund Nauðsynlegt Lýsing
ip string Já IPv4 eða IPv6 vistfang úthlutað til þessa miðlara
hostname string Nei PTR vélarheitið. Láttu þetta tómt til að endurstilla sjálfgefið.
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/rdns/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ip": "203.0.113.10", "hostname": "mail.example.com"}'
{
  "message": "Reverse DNS for 203.0.113.10 set to mail.example.com",
  "ip": "203.0.113.10",
  "hostname": "mail.example.com"
}

GET svar:

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

Kóðar fyrir svörunarstöðu

400 IP vantar, eða vélarheitið var ekki hægt að setja
404 IP- heimilisfangið er ekki úthlutað þessum þjóni
POST /api/v1/servers/{uuid}/exec/

Keyra skipun á þjóni

Keyrir skeljarskipun innan þjónsins í gegnum QEMU gestgjafa og bíður eftir að henni ljúki. Þjónninn verður að vera í gangi og qemu- guest- agent verður að vera uppsett og keyra í gestgjafanum.

Nauðsynlegt leyfi: servers:exec

Færibreytur beiðninnar

Breyta Tegund Nauðsynlegt Lýsing
command string Já Skipanalínan keyrir með /bin/sh -c, allt að 2000 stafir
timeout integer Nei Sekúndur til að bíða eftir skipun, 1 til 300 (sjálfgefið 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
}

Ef skipunin er enn í gangi þegar tímamörkin renna út, svarið hefur timed_out sett í True og exit_code sett í null.

Kóðar fyrir svörunarstöðu

200 Skipun lokið eða tímabundið
400 Þjónninn er ekki í notkun eða ekki í gangi, eða ógildar breytur
409 QEMU gestur umboð er ekki í gangi á miðlaranum
503 Tímabundin vandamál í tengingu. Reyndu aftur eftir Retry- After hausinn.
EYÐA /api/v1/servers/{uuid}/

Eyða netþjóni

Býður þjóninn til varanlegrar eyðingar. Þjónninn hverfur strax úr listanum og er ekki hægt að endurheimta hann.

Nauðsynlegt leyfi: 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"
}

Kóðar fyrir svörunarstöðu

202 Samþykkt: beiðnin var sett í biðröð
404 Fannst ekki, eða það tilheyrir öðrum reikningi
FÁ POST /api/v1/ssh-keys/

SSH lyklar

Geymdu opinbera SSH lykla á reikningnum þínum, sendu síðan uuids þeirra sem ssh_key_uuids þegar þú býrð til miðlara. GET listar lyklana þína (25 á síðu); POST bætir við einum.

Nauðsynlegt leyfi: ssh-keys:list (GET), ssh-keys:create (POST)

Færibreytur beiðninnar (POST)

Breyta Tegund Nauðsynlegt Lýsing
name string Já Nafn til að þekkja lykilinn með, allt að 100 stafir
public_key string Já Almenningslykilinn á OpenSSH sniði, til dæmis innihald id_ed25519.pub

Dæmi um beiðni

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

Dæmi um svar

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

Svarsvið

Field Tegund Lýsing
id, uuid integer, string Lyklaauðkenni. Notaðu uuid í ssh_key_uuids og í slóðina hér fyrir neðan; id virkar í ssh_key_ids.
fingerprint string MD5 fingrafar lykilsins, reiknað af vettvangnum
last_used_at datetime | null Hvenær lykilinn var síðast settur upp á nýjum þjóni

Kóðar fyrir svörunarstöðu

201 Lykillinn bætt við
400 Vantar nafn, eða dreifilykill er ekki gild SSH dreifilykill
FÁ EYÐA /api/v1/ssh-keys/{uuid}/

Sækja eða eyða SSH lykli

GET skilar einum lykli með ofangreindum reitum. DELETE fjarlægir hann af reikningnum þínum og skilar 204 án líkama. Ef lykli er eytt er hann ekki fjarlægður af þjónum sem hann var þegar uppsettur á. Lyklum er ekki hægt að breyta: eyða og bæta aftur við.

Nauðsynlegt leyfi: 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"

Afritun og Snapshots

Að búa til öryggisafrit eða myndskeið er einnig miðlaraaðgerð: