Servers API - VPS.org

GBÀ /api/v1/servers/

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

Gba atokọ gbogbo awọn olupin ninu akọọlẹ rẹ.

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

Pílámẹ́rà	Irú	Ti a nilo	Àpèjúwe
`status`	okùn	Rárá	Àlẹ̀mọ́ nípa ipò olupin: ti nṣiṣe lọwọ, ti daduro, ti daduro
`location`	okùn	Rárá	Àlẹ̀mọ́ nípa ipò ibi tí a ń gbé dátà sí

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

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ẹẹrẹ Ìdáhùn

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

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

200	A ṣe àṣeyọrí láti rí àkójọ olupin náà
401	Àìfúnni láṣẹ - Àmì API tí kò tọ́ tàbí tí kò sí mọ́

Ifiranṣẹ /api/v1/servers/

Ṣẹ̀dá olupin tuntun

Ṣe àgbékalẹ̀ olupin VPS tuntun kan pẹlu iṣeto pàtó kan.

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

Pílámẹ́rà	Irú	Ti a nilo	Àpèjúwe
`name`	okùn	Bẹ́ẹ̀ni	Orúkọ olupin (a ti gba àwọn lẹ́tà-ìwé, àwọn àmì-ìwé-ìwé-àṣẹ)
`plan_id`	odidi nọmba	Bẹ́ẹ̀ni	ID ti eto VPS
`os_id`	odidi nọmba	Bẹ́ẹ̀ni	ID ti eto iṣiṣẹ
`location`	okùn	Bẹ́ẹ̀ni	Kóòdù ibi tí a ń pè ní Datacenter
`hostname`	okùn	Rárá	Orúkọ olùgbàlejò olupin (FQDN)
`ssh_key_id`	odidi nọmba	Rárá	SSH bọtini ID lati fi sori ẹrọ
`backups_enabled`	Boolia	Rárá	Mu awọn afẹyinti laifọwọyi ṣiṣẹ (aiyipada: eke)

À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 '{
    "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ẹẹrẹ Ìdáhùn

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

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

201	A ṣẹ̀dá olupin ní àṣeyọrí
400	Ìbéèrè Tí Kò Dáa - Àwọn pàrámítà Tí Kò Tọ́
401	Àìfúnni láṣẹ - Àmì API tí kò tọ́ tàbí tí kò sí mọ́
402	Isanwo nilo - Awọn kirediti to ko to

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

Gba Awọn alaye olupin

Gba alaye alaye nipa olupin kan pato.

Àwọn Pílámítà Ọ̀nà

Pílámẹ́rà	Irú	Ti a nilo	Àpèjúwe
`server_id`	odidi nọmba	Bẹ́ẹ̀ni	ID olupin alailẹgbẹ

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

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ẹẹrẹ Ìdáhùn

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

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

200	A ṣe àṣeyọrí rí àwọn àlàyé olupin
401	Àìfúnni láṣẹ - Àmì API tí kò tọ́ tàbí tí kò sí mọ́
404	A ko ri - olupin ko si

FÚN /api/v1/servers/{server_id}/

Ṣe imudojuiwọn olupin

Ṣe àtúnṣe síṣeto olupin. Gbogbo awọn aaye ni a nilo.

Àwọn Pílámítà Ọ̀nà

Parameter	Type	Required	Description
`server_id`	integer	Yes	ID olupin alailẹgbẹ

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

Pílámẹ́rà	Irú	Ti a nilo	Àpèjúwe
`name`	okùn	Bẹ́ẹ̀ni	Orúkọ olupin
`hostname`	okùn	Bẹ́ẹ̀ni	Orúkọ olùgbàlejò olupin (FQDN)
`backups_enabled`	Boolia	Bẹ́ẹ̀ni	Mu/mu awọn afẹyinti laifọwọyi ṣiṣẹ

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

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

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

200	Àtúnṣe olupin náà ní àṣeyọrí
400	Ìbéèrè Tí Kò Dáa - Àwọn pàrámítà Tí Kò Tọ́
404	A ko ri - olupin ko si

ÀPÁTÌ /api/v1/servers/{server_id}/

Ṣe imudojuiwọn olupin ni apakan

Ṣe àtúnṣe àwọn pápá olupin pàtó kan. Àwọn pápá tí a pèsè nìkan ni a ó ṣe àtúnṣe.

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

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

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

Pa olupin rẹ

Pa olupin run patapata. A ko le yi igbese yii pada.

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

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)

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

204	A ti paarẹ olupin naa ni aṣeyọri
404	A ko ri - olupin ko si

Ifiranṣẹ /api/v1/servers/{server_id}/start/

Bẹ̀rẹ̀ olupin

Agbara lori olupin ti a da duro.

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

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ẹẹrẹ Ìdáhùn

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

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

200	A ti fi àṣẹ ìbẹ̀rẹ̀ olupin ranṣẹ ni aṣeyọri
400	Ìbéèrè Tí Kò Dáa - Ẹ̀rọ olupin ti ń ṣiṣẹ́ tẹ́lẹ̀
404	A ko ri - olupin ko si

Ifiranṣẹ /api/v1/servers/{server_id}/stop/

Dá olupin duro

Fi ẹ̀rọ ìṣiṣẹ́ pa olupin tí ó ń ṣiṣẹ́.

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

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ẹẹrẹ Ìdáhùn

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

Ifiranṣẹ /api/v1/servers/{server_id}/reboot/

Atunbere olupin

Fi ẹ̀tọ́ bẹ̀rẹ̀ olupin tí ń ṣiṣẹ́.

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

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ẹẹrẹ Ìdáhùn

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

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

200	A ti fi àṣẹ àtúnṣe olupin ránṣẹ́ ní àṣeyọrí
400	Ìbéèrè Tí Kò Dáa - Ẹ̀rọ olupin kò ṣiṣẹ́
404	A ko ri - olupin ko si

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

Àwọn Pílámítà Ọ̀nà

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

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

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

Ṣe imudojuiwọn olupin

Àwọn Pílámítà Ọ̀nà

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

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

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

Ṣe imudojuiwọn olupin ni apakan

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

Pa olupin rẹ

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

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

Bẹ̀rẹ̀ olupin

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

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

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

Dá olupin duro

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

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

Atunbere olupin

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

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

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