Servers API - VPS.org

ZÍSKAT /api/v1/servers/

Zobrazit všechny servery

Získejte seznam všech serverů ve vašem účtu.

Parametry dotazu

Parametr	Typ	Požadovaný	Popis
`status`	řetězec	Žádný	Filtrovat podle stavu serveru: aktivní, zastavený, pozastavený
`location`	řetězec	Žádný	Filtrovat podle umístění datového centra

Příklad žádosti

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

Příklad odpovědi

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

Kódy stavu odpovědi

200	Seznam serverů byl úspěšně načten
401	Neoprávněné – Neplatný nebo chybějící token API

ZVEŘEJNIT /api/v1/servers/

Vytvořit nový server

Nasaďte nový VPS server se zadanou konfigurací.

Parametry těla požadavku

Parametr	Typ	Požadovaný	Popis
`name`	řetězec	Ano	Název serveru (alfanumerický, povoleny jsou pomlčky)
`plan_id`	celé číslo	Ano	ID VPS tarifu
`os_id`	celé číslo	Ano	ID operačního systému
`location`	řetězec	Ano	Kód umístění datového centra
`hostname`	řetězec	Žádný	Název hostitele serveru (FQDN)
`ssh_key_id`	celé číslo	Žádný	ID klíče SSH pro instalaci
`backups_enabled`	booleovská	Žádný	Povolit automatické zálohování (výchozí: false)

Příklad žádosti

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

Příklad odpovědi

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

Kódy stavu odpovědi

201	Server byl úspěšně vytvořen
400	Chybný požadavek - Neplatné parametry
401	Neoprávněné – Neplatný nebo chybějící token API
402	Platba je vyžadována - Nedostatek kreditů

ZÍSKAT /api/v1/servers/{server_id}/

Získat podrobnosti o serveru

Získejte podrobné informace o konkrétním serveru.

Parametry cesty

Parametr	Typ	Požadovaný	Popis
`server_id`	celé číslo	Ano	Unikátní ID serveru

Příklad žádosti

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

Příklad odpovědi

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

Kódy stavu odpovědi

200	Úspěšně načteny podrobnosti o serveru
401	Neoprávněné – Neplatný nebo chybějící token API
404	Nenalezen - Server neexistuje

DÁT /api/v1/servers/{server_id}/

Aktualizační server

Aktualizovat konfiguraci serveru. Všechna pole jsou povinná.

Parametry cesty

Parameter	Type	Required	Description
`server_id`	integer	Yes	Unikátní ID serveru

Parametry těla požadavku

Parametr	Typ	Požadovaný	Popis
`name`	řetězec	Ano	Název serveru
`hostname`	řetězec	Ano	Název hostitele serveru (FQDN)
`backups_enabled`	booleovská	Ano	Povolit/zakázat automatické zálohování

Příklad žádosti

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

Kódy stavu odpovědi

200	Server byl úspěšně aktualizován
400	Chybný požadavek - Neplatné parametry
404	Nenalezen - Server neexistuje

NÁPLAST /api/v1/servers/{server_id}/

Částečně aktualizovat server

Aktualizovat konkrétní pole serveru. Aktualizována budou pouze zadaná pole.

Příklad žádosti

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

VYMAZAT /api/v1/servers/{server_id}/

Smazat server

Trvale smazat server. Tuto akci nelze vrátit zpět.

Příklad žádosti

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)

Kódy stavu odpovědi

204	Server byl úspěšně smazán
404	Nenalezen - Server neexistuje

ZVEŘEJNIT /api/v1/servers/{server_id}/start/

Spustit server

Zapněte zastavený server.

Příklad žádosti

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

Příklad odpovědi

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

Kódy stavu odpovědi

200	Příkaz ke spuštění serveru byl úspěšně odeslán.
400	Chybný požadavek - Server již běží
404	Nenalezen - Server neexistuje

ZVEŘEJNIT /api/v1/servers/{server_id}/stop/

Zastavit server

Elegantně vypněte běžící server.

Příklad žádosti

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

Příklad odpovědi

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

ZVEŘEJNIT /api/v1/servers/{server_id}/reboot/

Restartovat server

Bezproblémově restartujte běžící server.

Příklad žádosti

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

Příklad odpovědi

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

Kódy stavu odpovědi

200	Příkaz k restartu serveru byl úspěšně odeslán
400	Chybný požadavek - Server neběží
404	Nenalezen - Server neexistuje

VPS.org API

API serverů

Zobrazit všechny servery

Parametry dotazu

Příklad žádosti

Příklad odpovědi

Kódy stavu odpovědi

Vytvořit nový server

Parametry těla požadavku

Příklad žádosti

Příklad odpovědi

Kódy stavu odpovědi

Získat podrobnosti o serveru

Parametry cesty

Příklad žádosti

Příklad odpovědi

Kódy stavu odpovědi

Aktualizační server

Parametry cesty

Parametry těla požadavku

Příklad žádosti

Kódy stavu odpovědi

Částečně aktualizovat server

Příklad žádosti

Smazat server

Příklad žádosti

Kódy stavu odpovědi

Spustit server

Příklad žádosti

Příklad odpovědi

Kódy stavu odpovědi

Zastavit server

Příklad žádosti

Příklad odpovědi

Restartovat server

Příklad žádosti

Příklad odpovědi

Kódy stavu odpovědi