Servers API - VPS.org

STENDIN /api/v1/servers/

Hemû Serveran Bilîze

Lîsteyek hemî serverên di hesabê xwe de bistînin.

Parametreyên Lêpirsînê

Parametre	Awa	Pêwîst	Terîf
`status`	ben	Na	Li gorî rewşa serverê parzûn bike: çalak, rawestiyayî, sekinandî
`location`	ben	Na	Li gorî cihê navenda daneyan fîltre bike

Daxwaza Nimûne

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

Bersiva Mînakî

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

Kodên Rewşa Bersivê

200	Lîsteya serveran bi serkeftî hat wergirtin
401	Bêdestûr - Nîşana API-yê nederbasdar an jî wenda ye

KOZ /api/v1/servers/

Servereke Nû Biafirîne

Serverek VPS-ê ya nû bi mîhengên diyarkirî bicîh bike.

Parametreyên Laşê Daxwazê

Parametre	Awa	Pêwîst	Terîf
`name`	ben	Erê	Navê serverê (alfanumerîk, xêzikên navan destûr in)
`plan_id`	hejmara giştî	Erê	Nasnameya plana VPS-ê
`os_id`	hejmara giştî	Erê	Nasnameya pergala xebitandinê
`location`	ben	Erê	Koda cihê navenda daneyan
`hostname`	ben	Na	Navê mêvandarê serverê (FQDN)
`ssh_key_id`	hejmara giştî	Na	Nasnameya mifteya SSH ji bo sazkirinê
`backups_enabled`	boolean	Na	Paşvekişandinên otomatîk çalak bike (xwerû: derew)

Daxwaza Nimûne

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

Bersiva Mînakî

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

Kodên Rewşa Bersivê

201	Server bi serkeftî hat afirandin
400	Daxwaza Xirab - Parametreyên nederbasdar
401	Bêdestûr - Nîşana API-yê nederbasdar an jî wenda ye
402	Pêdivî bi dravdanê heye - Kredî têrê nakin

STENDIN /api/v1/servers/{server_id}/

Agahiyên Serverê Bistîne

Agahiyên berfireh li ser serverek taybetî bistînin.

Parametreyên Rêyê

Parametre	Awa	Pêwîst	Terîf
`server_id`	hejmara giştî	Erê	Nasnameya serverê ya bêhempa

Daxwaza Nimûne

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

Bersiva Mînakî

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

Kodên Rewşa Bersivê

200	Agahiyên serverê bi serkeftî hatin wergirtin
401	Bêdestûr - Nîşana API-yê nederbasdar an jî wenda ye
404	Nehat Dîtin - Server tune ye

RAXISTAN /api/v1/servers/{server_id}/

Pêşkêşkara Nûvekirinê

Mîhengên serverê nûve bike. Hemû qad pêwîst in.

Parametreyên Rêyê

Parameter	Type	Required	Description
`server_id`	integer	Yes	Nasnameya serverê ya bêhempa

Parametreyên Laşê Daxwazê

Parametre	Awa	Pêwîst	Terîf
`name`	ben	Erê	Navê serverê
`hostname`	ben	Erê	Navê mêvandarê serverê (FQDN)
`backups_enabled`	boolean	Erê	Paşvekişandinên otomatîk çalak bike/neçalak bike

Daxwaza Nimûne

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

Kodên Rewşa Bersivê

200	Server bi serkeftî hate nûkirin
400	Daxwaza Xirab - Parametreyên nederbasdar
404	Nehat Dîtin - Server tune ye

PÎNE /api/v1/servers/{server_id}/

Nûvekirina Pêşkêşkerê bi Qismî

Qadên serverê yên taybet nûve bikin. Tenê qadên hatine peyda kirin dê werin nûve kirin.

Daxwaza Nimûne

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

JÊBIRIN /api/v1/servers/{server_id}/

Jêbirina Serverê

Serverek bi awayekî mayînde jê bibe. Ev çalakî nayê vegerandin.

Daxwaza Nimûne

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)

Kodên Rewşa Bersivê

204	Server bi serkeftî hate jêbirin
404	Nehat Dîtin - Server tune ye

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

Destpêkirina Serverê

Serverekî rawestiyayî veke.

Daxwaza Nimûne

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

Bersiva Mînakî

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

Kodên Rewşa Bersivê

200	Fermana destpêkirina serverê bi serkeftî hat şandin
400	Daxwaza Xirab - Server jixwe dixebite
404	Nehat Dîtin - Server tune ye

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

Serverê Rawestîne

Bi xweşikî serverek çalak bigire.

Daxwaza Nimûne

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

Bersiva Mînakî

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

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

Pêşkêşkerê ji Nû Ve Dest Pê Bike

Bi nermî serverek dixebite ji nû ve bide destpêkirin.

Daxwaza Nimûne

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

Bersiva Mînakî

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

Kodên Rewşa Bersivê

200	Fermana ji nû ve destpêkirina serverê bi serkeftî hat şandin
400	Daxwaza Xirab - Server naxebite
404	Nehat Dîtin - Server tune ye

VPS.org API

API-ya Serveran

Hemû Serveran Bilîze

Parametreyên Lêpirsînê

Daxwaza Nimûne

Bersiva Mînakî

Kodên Rewşa Bersivê

Servereke Nû Biafirîne

Parametreyên Laşê Daxwazê

Daxwaza Nimûne

Bersiva Mînakî

Kodên Rewşa Bersivê

Agahiyên Serverê Bistîne

Parametreyên Rêyê

Daxwaza Nimûne

Bersiva Mînakî

Kodên Rewşa Bersivê

Pêşkêşkara Nûvekirinê

Parametreyên Rêyê

Parametreyên Laşê Daxwazê

Daxwaza Nimûne

Kodên Rewşa Bersivê

Nûvekirina Pêşkêşkerê bi Qismî

Daxwaza Nimûne

Jêbirina Serverê

Daxwaza Nimûne

Kodên Rewşa Bersivê

Destpêkirina Serverê

Daxwaza Nimûne

Bersiva Mînakî

Kodên Rewşa Bersivê

Serverê Rawestîne

Daxwaza Nimûne

Bersiva Mînakî

Pêşkêşkerê ji Nû Ve Dest Pê Bike

Daxwaza Nimûne

Bersiva Mînakî

Kodên Rewşa Bersivê