VPS.org API

Ngā tuhinga mō te REST API

API Tūmau

Whakahaerehia ō tūmau VPS mā te kaupapa. Waihangahia, whirihorahia, whakahaeretia, me te aroturukihia ō tūmau tūmataiti mariko.

Ngā Pūtake 9
Ara Tūāpapa /api/v1/servers
TIKINA /api/v1/servers/

Rārangihia ngā Tūmau Katoa

Tikina he rārangi o ngā tūmau katoa i roto i tō pūkete.

Ngā Tawhā Uiui

Tawhā Momo E hiahiatia ana Whakaahuatanga
status aho Kāore Tātarihia mā te tūnga tūmau: hohe, mutu, whakatārewatia
location aho Kāore Tātarihia mā te tauwāhi o te pokapū raraunga

Tauira Tono

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

Tauira Whakautu

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

Ngā Waehere Tūnga Urupare

200 I angitu te tiki i te rārangi tūmau
401 Kāore i Whakamanahia - Tohu API kore mana, ngaro rānei
TŪHI /api/v1/servers/

Waihangahia he Tūmau Hou

Whakatūria he tūmau VPS hou me te whirihoranga kua tohua.

Tonohia ngā Tawhā Tinana

Tawhā Momo E hiahiatia ana Whakaahuatanga
name aho Āe Ingoa tūmau (taurangi ā-reo, whakaaetia ngā tohuhono)
plan_id tauoti Āe ID o te mahere VPS
os_id tauoti Āe ID o te pūnaha whakahaere
location aho Āe Waehere tauwāhi pokapū raraunga
hostname aho Kāore Ingoa manaaki tūmau (FQDN)
ssh_key_id tauoti Kāore ID kī SSH hei tāuta
backups_enabled pūreana Kāore Whakahohehia ngā tārua aunoa (taunoa: teka)

Tauira Tono

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

Tauira Whakautu

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

Ngā Waehere Tūnga Urupare

201 I angitu te waihangatanga o te tūmau
400 Tono Kino - Ngā tawhā kore mana
401 Kāore i Whakamanahia - Tohu API kore mana, ngaro rānei
402 Utu e hiahiatia ana - Kāore i te rawaka ngā whiwhinga
TIKINA /api/v1/servers/{server_id}/

Tikina ngā Taipitopito Tūmau

Tikina ngā mōhiohio taipitopito mō tētahi tūmau motuhake.

Ngā Tawhā Ara

Tawhā Momo E hiahiatia ana Whakaahuatanga
server_id tauoti Āe ID tūmau ahurei

Tauira Tono

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

Tauira Whakautu

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

Ngā Waehere Tūnga Urupare

200 Kua whiwhi angitu i ngā taipitopito tūmau
401 Kāore i Whakamanahia - Tohu API kore mana, ngaro rānei
404 Kāore i Kitea - Kāore he Tūmau
TUKU /api/v1/servers/{server_id}/

Whakahōu Tūmau

Whakahōu i te whirihoranga tūmau. Me whakauru ngā āpure katoa.

Ngā Tawhā Ara

Parameter Type Required Description
server_id integer Yes ID tūmau ahurei

Tonohia ngā Tawhā Tinana

Tawhā Momo E hiahiatia ana Whakaahuatanga
name aho Āe Ingoa tūmau
hostname aho Āe Ingoa manaaki tūmau (FQDN)
backups_enabled pūreana Āe Whakahohe/mono i ngā tārua aunoa

Tauira Tono

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

Ngā Waehere Tūnga Urupare

200 Kua angitu te whakahōu i te tūmau
400 Tono Kino - Ngā tawhā kore mana
404 Kāore i Kitea - Kāore he Tūmau
PĀPĀ /api/v1/servers/{server_id}/

Whakahōu Wāhanga o te Tūmau

Whakahōuhia ngā āpure tūmau motuhake. Ko ngā āpure kua whakaratohia anake ka whakahōuhia.

Tauira Tono

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())
MUKU /api/v1/servers/{server_id}/

Mukua te Tūmau

Mukua tonutia tētahi tūmau. Kāore e taea te whakakore i tēnei mahi.

Tauira Tono

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)

Ngā Waehere Tūnga Urupare

204 Kua mukua angitu te tūmau
404 Kāore i Kitea - Kāore he Tūmau
TŪHI /api/v1/servers/{server_id}/start/

Tīmata Tūmau

Whakakāhia te tūmau kua mutu.

Tauira Tono

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

Tauira Whakautu

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

Ngā Waehere Tūnga Urupare

200 Kua tukuna angitu te whakahau tīmatanga tūmau
400 Tono Kino - Kei te rere kē te Tūmau
404 Kāore i Kitea - Kāore he Tūmau
TŪHI /api/v1/servers/{server_id}/stop/

Whakamutua te Tūmau

Whakawetohia mārire te tūmau e rere ana.

Tauira Tono

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

Tauira Whakautu

{
  "status": "success",
  "message": "Server is stopping",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "stopping"
  }
}
TŪHI /api/v1/servers/{server_id}/reboot/

Whakaara anō i te Tūmau

Tīmata anō i te tūmau e rere ana me te ata.

Tauira Tono

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

Tauira Whakautu

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

Ngā Waehere Tūnga Urupare

200 Kua tukuna angitu te whakahau whakaara anō tūmau
400 Tono Kino - Kāore te Tūmau e rere ana
404 Kāore i Kitea - Kāore he Tūmau