Servers API - VPS.org

SAA /api/v1/servers/

Loetle kõik serverid

Hankige oma konto kõigi serverite loend.

Päringuparameetrid

Parameeter	Tüüp	Nõutav	Kirjeldus
`status`	nöör	Ei	Filtreeri serveri oleku järgi: aktiivne, peatatud, peatatud
`location`	nöör	Ei	Filtreeri andmekeskuse asukoha järgi

Näidistaotlus

cURL

Python

JavaScript

PHP

curl -X GET "https://admin.vps.org/api/v1/servers/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const servers = await response.json();
console.log(servers);

$ch = curl_init('https://admin.vps.org/api/v1/servers/');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$servers = json_decode($response, true);
curl_close($ch);

Näidisvastus

{
  "count": 2,
  "results": [
    {
      "id": 12345,
      "name": "web-server-01",
      "hostname": "web01.example.com",
      "status": "active",
      "ip_address": "203.0.113.10",
      "location": "us-west",
      "plan": {
        "id": 1,
        "name": "Standard VPS",
        "vcpus": 2,
        "memory": 4096,
        "storage": 80
      },
      "os": {
        "id": 5,
        "name": "Ubuntu 22.04 LTS"
      },
      "created_at": "2025-01-10T14:30:00Z",
      "updated_at": "2025-01-15T10:20:00Z"
    },
    {
      "id": 12346,
      "name": "db-server-01",
      "hostname": "db01.example.com",
      "status": "active",
      "ip_address": "203.0.113.11",
      "location": "us-east",
      "plan": {
        "id": 2,
        "name": "Performance VPS",
        "vcpus": 4,
        "memory": 8192,
        "storage": 160
      },
      "os": {
        "id": 3,
        "name": "Debian 12"
      },
      "created_at": "2025-01-12T09:15:00Z",
      "updated_at": "2025-01-16T08:45:00Z"
    }
  ]
}

Vastuse olekukoodid

200	Serverite loend edukalt alla laaditud
401	Volitamata – sobimatu või puuduv API tunnus

POST /api/v1/servers/

Loo uus server

Juuruta uus VPS-server määratud konfiguratsiooniga.

Taotluse sisu parameetrid

Parameeter	Tüüp	Nõutav	Kirjeldus
`name`	nöör	Jah	Serveri nimi (tähtnumbriline, sidekriipsud lubatud)
`plan_id`	täisarv	Jah	VPS-paketi ID
`os_id`	täisarv	Jah	Operatsioonisüsteemi ID
`location`	nöör	Jah	Andmekeskuse asukohakood
`hostname`	nöör	Ei	Serveri hostinimi (FQDN)
`ssh_key_id`	täisarv	Ei	Installimiseks SSH-võtme ID
`backups_enabled`	tõeväärtus	Ei	Luba automaatne varundamine (vaikimisi: väär)

Näidistaotlus

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 '{
    "name": "web-server-02",
    "plan_id": 1,
    "os_id": 5,
    "location": "us-west",
    "hostname": "web02.example.com",
    "backups_enabled": true
  }'

import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "name": "web-server-02",
    "plan_id": 1,
    "os_id": 5,
    "location": "us-west",
    "hostname": "web02.example.com",
    "backups_enabled": True
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

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({
    name: 'web-server-02',
    plan_id: 1,
    os_id: 5,
    location: 'us-west',
    hostname: 'web02.example.com',
    backups_enabled: true
  })
});

const server = await response.json();
console.log(server);

$data = [
    'name' => 'web-server-02',
    'plan_id' => 1,
    'os_id' => 5,
    'location' => 'us-west',
    'hostname' => 'web02.example.com',
    'backups_enabled' => true
];

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

$response = curl_exec($ch);
$server = json_decode($response, true);
curl_close($ch);

Näidisvastus

{
  "id": 12347,
  "name": "web-server-02",
  "hostname": "web02.example.com",
  "status": "provisioning",
  "ip_address": null,
  "location": "us-west",
  "plan": {
    "id": 1,
    "name": "Standard VPS",
    "vcpus": 2,
    "memory": 4096,
    "storage": 80
  },
  "os": {
    "id": 5,
    "name": "Ubuntu 22.04 LTS"
  },
  "backups_enabled": true,
  "created_at": "2025-01-16T15:30:00Z",
  "updated_at": "2025-01-16T15:30:00Z",
  "message": "Server is being provisioned. This may take 2-5 minutes."
}

Vastuse olekukoodid

201	Serveri loomine õnnestus
400	Vigane päring – sobimatud parameetrid
401	Volitamata – sobimatu või puuduv API tunnus
402	Makse nõutav – ebapiisav krediit

SAA /api/v1/servers/{server_id}/

Hankige serveri üksikasjad

Hankige konkreetse serveri kohta üksikasjalikku teavet.

Tee parameetrid

Parameeter	Tüüp	Nõutav	Kirjeldus
`server_id`	täisarv	Jah	Unikaalne serveri ID

Näidistaotlus

cURL

Python

JavaScript

curl -X GET "https://admin.vps.org/api/v1/servers/12345/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

const serverId = 12345;
const response = await fetch(`https://admin.vps.org/api/v1/servers/${serverId}/`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const server = await response.json();
console.log(server);

Näidisvastus

{
  "id": 12345,
  "name": "web-server-01",
  "hostname": "web01.example.com",
  "status": "active",
  "ip_address": "203.0.113.10",
  "ipv6_address": "2001:0db8::1",
  "location": "us-west",
  "plan": {
    "id": 1,
    "name": "Standard VPS",
    "vcpus": 2,
    "memory": 4096,
    "storage": 80,
    "bandwidth": 2048
  },
  "os": {
    "id": 5,
    "name": "Ubuntu 22.04 LTS"
  },
  "backups_enabled": true,
  "resource_usage": {
    "cpu_percent": 23.5,
    "memory_used": 2048,
    "disk_used": 35,
    "bandwidth_used": 450
  },
  "created_at": "2025-01-10T14:30:00Z",
  "updated_at": "2025-01-16T15:45:00Z"
}

Vastuse olekukoodid

200	Serveri andmed on edukalt alla laaditud
401	Volitamata – sobimatu või puuduv API tunnus
404	Ei leitud – serverit pole olemas

PANNA /api/v1/servers/{server_id}/

Värskendusserver

Serveri konfiguratsiooni värskendamine. Kõik väljad on kohustuslikud.

Tee parameetrid

Parameter	Type	Required	Description
`server_id`	integer	Yes	Unikaalne serveri ID

Taotluse sisu parameetrid

Parameeter	Tüüp	Nõutav	Kirjeldus
`name`	nöör	Jah	Serveri nimi
`hostname`	nöör	Jah	Serveri hostinimi (FQDN)
`backups_enabled`	tõeväärtus	Jah	Automaatse varundamise lubamine/keelamine

Näidistaotlus

cURL

Python

curl -X PUT "https://admin.vps.org/api/v1/servers/12345/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "web-server-updated",
    "hostname": "web-updated.example.com",
    "backups_enabled": true
  }'

import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "name": "web-server-updated",
    "hostname": "web-updated.example.com",
    "backups_enabled": True
}

response = requests.put(url, headers=headers, json=data)
print(response.json())

Vastuse olekukoodid

200	Serveri värskendamine õnnestus
400	Vigane päring – sobimatud parameetrid
404	Ei leitud – serverit pole olemas

PLAASTER /api/v1/servers/{server_id}/

Serveri osaline värskendamine

Värskenda konkreetseid serverivälju. Ainult sisestatud välju värskendatakse.

Näidistaotlus

cURL

Python

curl -X PATCH "https://admin.vps.org/api/v1/servers/12345/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "new-server-name"
  }'

import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {"name": "new-server-name"}

response = requests.patch(url, headers=headers, json=data)
print(response.json())

KUSTUTA /api/v1/servers/{server_id}/

Kustuta server

Serveri jäädavalt kustutamine. Seda toimingut ei saa tagasi võtta.

Näidistaotlus

cURL

Python

curl -X DELETE "https://admin.vps.org/api/v1/servers/12345/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.delete(url, headers=headers)
print(response.status_code)

Vastuse olekukoodid

204	Server edukalt kustutatud
404	Ei leitud – serverit pole olemas

POST /api/v1/servers/{server_id}/start/

Käivita server

Lülitage peatatud server sisse.

Näidistaotlus

cURL

Python

JavaScript

curl -X POST "https://admin.vps.org/api/v1/servers/12345/start/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/start/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers)
print(response.json())

const serverId = 12345;
const response = await fetch(`https://admin.vps.org/api/v1/servers/${serverId}/start/`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const result = await response.json();
console.log(result);

Näidisvastus

{
  "status": "success",
  "message": "Server is starting",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "starting"
  }
}

Vastuse olekukoodid

200	Serveri käivitamiskäsk edukalt saadetud
400	Vigane päring – server juba töötab
404	Ei leitud – serverit pole olemas

POST /api/v1/servers/{server_id}/stop/

Peata server

Sulgege töötav server korrektselt.

Näidistaotlus

cURL

Python

curl -X POST "https://admin.vps.org/api/v1/servers/12345/stop/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/stop/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers)
print(response.json())

Näidisvastus

{
  "status": "success",
  "message": "Server is stopping",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "stopping"
  }
}

POST /api/v1/servers/{server_id}/reboot/

Taaskäivita server

Taaskäivitage töötav server sujuvalt.

Näidistaotlus

cURL

Python

curl -X POST "https://admin.vps.org/api/v1/servers/12345/reboot/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/reboot/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers)
print(response.json())

Näidisvastus

{
  "status": "success",
  "message": "Server is rebooting",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "rebooting"
  }
}

Vastuse olekukoodid

200	Serveri taaskäivituskäsk edukalt saadetud
400	Vigane päring – server ei tööta
404	Ei leitud – serverit pole olemas

VPS.org API

Serverite API

Loetle kõik serverid

Päringuparameetrid

Näidistaotlus

Näidisvastus

Vastuse olekukoodid

Loo uus server

Taotluse sisu parameetrid

Näidistaotlus

Näidisvastus

Vastuse olekukoodid

Hankige serveri üksikasjad

Tee parameetrid

Näidistaotlus

Näidisvastus

Vastuse olekukoodid

Värskendusserver

Tee parameetrid

Taotluse sisu parameetrid

Näidistaotlus

Vastuse olekukoodid

Serveri osaline värskendamine

Näidistaotlus

Kustuta server

Näidistaotlus

Vastuse olekukoodid

Käivita server

Näidistaotlus

Näidisvastus

Vastuse olekukoodid

Peata server

Näidistaotlus

Näidisvastus

Taaskäivita server

Näidistaotlus

Näidisvastus

Vastuse olekukoodid