Servers API - VPS.org

MEUNANGKEUN /api/v1/servers/

Daptarkeun Sadaya Server

Candak daptar sadaya server dina akun anjeun.

Parameter Pamundut

Parameter	Tipe	Diperlukeun	Pedaran
`status`	tali	Henteu	Saring dumasar status server: aktif, eureun, ditunda
`location`	tali	Henteu	Filter dumasar lokasi pusat data

Conto Pamundut

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

Conto Réspon

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

Kodeu Status Tanggapan

200	Daptar server parantos hasil dicandak
401	Teu Sah - Token API teu valid atanapi leungit

POSTING /api/v1/servers/

Jieun Server Anyar

Pasangkeun server VPS anyar kalawan konfigurasi anu ditangtukeun.

Pamundut Parameter Awak

Parameter	Tipe	Diperlukeun	Pedaran
`name`	tali	Muhun	Ngaran server (alfanumerik, tanda hubung diidinan)
`plan_id`	bilangan bulat	Muhun	ID rencana VPS
`os_id`	bilangan bulat	Muhun	ID sistem operasi
`location`	tali	Muhun	Kode lokasi pusat data
`hostname`	tali	Henteu	Ngaran host server (FQDN)
`ssh_key_id`	bilangan bulat	Henteu	ID konci SSH pikeun dipasang
`backups_enabled`	boolean	Henteu	Aktipkeun cadangan otomatis (standar: palsu)

Conto Pamundut

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

Conto Réspon

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

Kodeu Status Tanggapan

201	Server parantos hasil didamel
400	Pamundut Goréng - Parameter teu valid
401	Teu Sah - Token API teu valid atanapi leungit
402	Diperlukeun Pamayaran - Kredit teu cekap

MEUNANGKEUN /api/v1/servers/{server_id}/

Kéngingkeun Rincian Server

Meunangkeun inpormasi lengkep ngeunaan server anu khusus.

Parameter Jalur

Parameter	Tipe	Diperlukeun	Pedaran
`server_id`	bilangan bulat	Muhun	ID server unik

Conto Pamundut

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

Conto Réspon

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

Kodeu Status Tanggapan

200	Rincian server parantos hasil dicandak
401	Teu Sah - Token API teu valid atanapi leungit
404	Teu Kapanggih - Server teu aya

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

Apdet Server

Apdet konfigurasi server. Sadaya kolom diwajibkeun.

Parameter Jalur

Parameter	Type	Required	Description
`server_id`	integer	Yes	ID server unik

Pamundut Parameter Awak

Parameter	Tipe	Diperlukeun	Pedaran
`name`	tali	Muhun	Ngaran server
`hostname`	tali	Muhun	Ngaran host server (FQDN)
`backups_enabled`	boolean	Muhun	Aktipkeun/nonaktipkeun cadangan otomatis

Conto Pamundut

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

Kodeu Status Tanggapan

200	Server parantos diropéa kalayan suksés
400	Pamundut Goréng - Parameter teu valid
404	Teu Kapanggih - Server teu aya

PATCH /api/v1/servers/{server_id}/

Apdet Sabagian Server

Apdet widang server khusus. Ngan widang anu disayogikeun anu bakal diénggalan.

Conto Pamundut

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

HAPUS /api/v1/servers/{server_id}/

Hapus Server

Hapus server sacara permanén. Peta ieu teu tiasa dibolaykeun.

Conto Pamundut

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)

Kodeu Status Tanggapan

204	Server parantos hasil dihapus
404	Teu Kapanggih - Server teu aya

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

Mimitian Server

Hurungkeun server anu eureun.

Conto Pamundut

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

Conto Réspon

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

Kodeu Status Tanggapan

200	Paréntah ngamimitian server parantos hasil dikirim
400	Pamundut Goréng - Server parantos jalan
404	Teu Kapanggih - Server teu aya

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

Eureunkeun Server

Mareuman server anu keur jalan kalawan anggun.

Conto Pamundut

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

Conto Réspon

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

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

Pareuman deui Server

Mimitian deui server anu nuju jalan kalawan anggun.

Conto Pamundut

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

Conto Réspon

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

Kodeu Status Tanggapan

200	Paréntah reboot server parantos hasil dikirim
400	Pamundut Goréng - Server teu jalan
404	Teu Kapanggih - Server teu aya

VPS.org API

API Server

Daptarkeun Sadaya Server

Parameter Pamundut

Conto Pamundut

Conto Réspon

Kodeu Status Tanggapan

Jieun Server Anyar

Pamundut Parameter Awak

Conto Pamundut

Conto Réspon

Kodeu Status Tanggapan

Kéngingkeun Rincian Server

Parameter Jalur

Conto Pamundut

Conto Réspon

Kodeu Status Tanggapan

Apdet Server

Parameter Jalur

Pamundut Parameter Awak

Conto Pamundut

Kodeu Status Tanggapan

Apdet Sabagian Server

Conto Pamundut

Hapus Server

Conto Pamundut

Kodeu Status Tanggapan

Mimitian Server

Conto Pamundut

Conto Réspon

Kodeu Status Tanggapan

Eureunkeun Server

Conto Pamundut

Conto Réspon

Pareuman deui Server

Conto Pamundut

Conto Réspon

Kodeu Status Tanggapan