Servers API - VPS.org

THOLA /api/v1/servers/

Bhala Zonke Iziphakeli

Thola uhlu lwawo wonke amaseva ku-akhawunti yakho.

Amapharamitha Ombuzo

Ipharamitha	Uhlobo	Kuyadingeka	Incazelo
`status`	intambo	Cha	Hlunga ngesimo seseva: kuyasebenza, kumisiwe, kumisiwe
`location`	intambo	Cha	Hlunga ngendawo yesikhungo sedatha

Isicelo Sesibonelo

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

Impendulo Yesibonelo

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

Amakhodi Esimo Sempendulo

200	Uhlu lweseva olubuyiselwe ngempumelelo
401	Akugunyaziwe - Ithokheni ye-API engavumelekile noma engekho

THUMELA /api/v1/servers/

Dala iseva entsha

Sebenzisa iseva entsha ye-VPS enezilungiselelo ezithile.

Cela Amapharamitha Omzimba

Ipharamitha	Uhlobo	Kuyadingeka	Incazelo
`name`	intambo	Yebo	Igama leseva (izinhlamvu zamagama, ama-hyphen avunyelwe)
`plan_id`	inombolo ephelele	Yebo	I-ID yohlelo lwe-VPS
`os_id`	inombolo ephelele	Yebo	I-ID yesistimu yokusebenza
`location`	intambo	Yebo	Ikhodi yendawo yesikhungo sedatha
`hostname`	intambo	Cha	Igama lomphathi weseva (i-FQDN)
`ssh_key_id`	inombolo ephelele	Cha	I-ID yokhiye we-SSH okufanele uyifake
`backups_enabled`	i-boolean	Cha	Nika amandla ukusekela ngokuzenzakalelayo (okuzenzakalelayo: amanga)

Isicelo Sesibonelo

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

Impendulo Yesibonelo

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

Amakhodi Esimo Sempendulo

201	Iseva idalwe ngempumelelo
400	Isicelo Esibi - Amapharamitha angavumelekile
401	Akugunyaziwe - Ithokheni ye-API engavumelekile noma engekho
402	Kudingeka Inkokhelo - Amakhredithi anganele

THOLA /api/v1/servers/{server_id}/

Thola Imininingwane Yeseva

Thola ulwazi oluningiliziwe mayelana neseva ethile.

Amapharamitha Endlela

Ipharamitha	Uhlobo	Kuyadingeka	Incazelo
`server_id`	inombolo ephelele	Yebo	I-ID yeseva ehlukile

Isicelo Sesibonelo

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

Impendulo Yesibonelo

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

Amakhodi Esimo Sempendulo

200	Kutholwe ngempumelelo imininingwane yeseva
401	Akugunyaziwe - Ithokheni ye-API engavumelekile noma engekho
404	Akutholakali - Iseva ayikho

I-PUT /api/v1/servers/{server_id}/

Buyekeza Iseva

Buyekeza ukucushwa kweseva. Zonke izinkambu ziyadingeka.

Amapharamitha Endlela

Parameter	Type	Required	Description
`server_id`	integer	Yes	I-ID yeseva ehlukile

Cela Amapharamitha Omzimba

Ipharamitha	Uhlobo	Kuyadingeka	Incazelo
`name`	intambo	Yebo	Igama leseva
`hostname`	intambo	Yebo	Igama lomphathi weseva (i-FQDN)
`backups_enabled`	i-boolean	Yebo	Nika amandla/khubaza ukusekela ngokuzenzakalelayo

Isicelo Sesibonelo

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

Amakhodi Esimo Sempendulo

200	Iseva ibuyekezwe ngempumelelo
400	Isicelo Esibi - Amapharamitha angavumelekile
404	Akutholakali - Iseva ayikho

IPHESHI /api/v1/servers/{server_id}/

Buyekeza iseva kancane

Buyekeza izinkambu zeseva ezithile. Izinkambu ezinikeziwe kuphela ezizobuyekezwa.

Isicelo Sesibonelo

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

SUSA /api/v1/servers/{server_id}/

Susa Iseva

Susa iseva unomphela. Lesi senzo asikwazi ukuhlehliswa.

Isicelo Sesibonelo

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)

Amakhodi Esimo Sempendulo

204	Iseva isusiwe ngempumelelo
404	Akutholakali - Iseva ayikho

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

Qala iseva

Vula iseva emisiwe.

Isicelo Sesibonelo

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

Impendulo Yesibonelo

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

Amakhodi Esimo Sempendulo

200	Umyalo wokuqala iseva uthunyelwe ngempumelelo
400	Isicelo Esibi - Iseva isivele isebenza
404	Akutholakali - Iseva ayikho

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

Misa iseva

Vala iseva esebenzayo ngomusa.

Isicelo Sesibonelo

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

Impendulo Yesibonelo

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

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

Qala kabusha iseva

Qala kabusha iseva esebenzayo ngomusa.

Isicelo Sesibonelo

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

Impendulo Yesibonelo

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

Amakhodi Esimo Sempendulo

200	Umyalo wokuqalisa kabusha iseva uthunyelwe ngempumelelo
400	Isicelo Esibi - Iseva ayisebenzi
404	Akutholakali - Iseva ayikho

VPS.org API

I-API Yamaseva

Bhala Zonke Iziphakeli

Amapharamitha Ombuzo

Isicelo Sesibonelo

Impendulo Yesibonelo

Amakhodi Esimo Sempendulo

Dala iseva entsha

Cela Amapharamitha Omzimba

Isicelo Sesibonelo

Impendulo Yesibonelo

Amakhodi Esimo Sempendulo

Thola Imininingwane Yeseva

Amapharamitha Endlela

Isicelo Sesibonelo

Impendulo Yesibonelo

Amakhodi Esimo Sempendulo

Buyekeza Iseva

Amapharamitha Endlela

Cela Amapharamitha Omzimba

Isicelo Sesibonelo

Amakhodi Esimo Sempendulo

Buyekeza iseva kancane

Isicelo Sesibonelo

Susa Iseva

Isicelo Sesibonelo

Amakhodi Esimo Sempendulo

Qala iseva

Isicelo Sesibonelo

Impendulo Yesibonelo

Amakhodi Esimo Sempendulo

Misa iseva

Isicelo Sesibonelo

Impendulo Yesibonelo

Qala kabusha iseva

Isicelo Sesibonelo

Impendulo Yesibonelo

Amakhodi Esimo Sempendulo