Servers API

KRIJGEN /api/v1/servers/

Alle servers weergeven

Vraag een lijst op van alle servers in uw account.

Queryparameters

Parameter	Type	Vereist	Beschrijving
`status`	snaar	Nee	Filteren op serverstatus: actief, gestopt, opgeschort
`location`	snaar	Nee	Filteren op datacenterlocatie

Voorbeeldverzoek

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

Voorbeeldantwoord

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

Responsstatuscodes

200	Serverlijst succesvol opgehaald.
401	Niet geautoriseerd - Ongeldig of ontbrekend API-token

NA /api/v1/servers/

Nieuwe server aanmaken

Een nieuwe VPS-server met de opgegeven configuratie implementeren.

Parameters van de aanvraagbody

Parameter	Type	Vereist	Beschrijving
`name`	snaar	Ja	Servernaam (alfanumeriek, koppeltekens toegestaan)
`plan_id`	geheel getal	Ja	ID van het VPS-abonnement
`os_id`	geheel getal	Ja	ID van het besturingssysteem
`location`	snaar	Ja	Datacenter locatiecode
`hostname`	snaar	Nee	Serverhostnaam (FQDN)
`ssh_key_id`	geheel getal	Nee	SSH-sleutel-ID voor installatie
`backups_enabled`	booleaans	Nee	Automatische back-ups inschakelen (standaard: uitgeschakeld)

Voorbeeldverzoek

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

Voorbeeldantwoord

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

Responsstatuscodes

201	Server succesvol aangemaakt
400	Ongeldig verzoek - Ongeldige parameters
401	Niet geautoriseerd - Ongeldig of ontbrekend API-token
402	Betaling vereist - Onvoldoende saldo

KRIJGEN /api/v1/servers/{server_id}/

Servergegevens opvragen

Gedetailleerde informatie over een specifieke server opvragen.

Padparameters

Parameter	Type	Vereist	Beschrijving
`server_id`	geheel getal	Ja	Unieke server-ID

Voorbeeldverzoek

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

Voorbeeldantwoord

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

Responsstatuscodes

200	Servergegevens succesvol opgehaald.
401	Niet geautoriseerd - Ongeldig of ontbrekend API-token
404	Niet gevonden - Server bestaat niet

NEERZETTEN /api/v1/servers/{server_id}/

Updateserver

Serverconfiguratie bijwerken. Alle velden zijn verplicht.

Padparameters

Parameter	Type	Required	Description
`server_id`	integer	Yes	Unieke server-ID

Parameters van de aanvraagbody

Parameter	Type	Vereist	Beschrijving
`name`	snaar	Ja	Servernaam
`hostname`	snaar	Ja	Serverhostnaam (FQDN)
`backups_enabled`	booleaans	Ja	Automatische back-ups in-/uitschakelen

Voorbeeldverzoek

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

Responsstatuscodes

200	Server succesvol bijgewerkt
400	Ongeldig verzoek - Ongeldige parameters
404	Niet gevonden - Server bestaat niet

LAPJE /api/v1/servers/{server_id}/

Server gedeeltelijk bijwerken

Werk specifieke servervelden bij. Alleen de opgegeven velden worden bijgewerkt.

Voorbeeldverzoek

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

VERWIJDEREN /api/v1/servers/{server_id}/

Server verwijderen

Een server permanent verwijderen. Deze actie kan niet ongedaan worden gemaakt.

Voorbeeldverzoek

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)

Responsstatuscodes

204	Server succesvol verwijderd
404	Niet gevonden - Server bestaat niet

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

Start server

Schakel een uitgeschakelde server in.

Voorbeeldverzoek

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

Voorbeeldantwoord

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

Responsstatuscodes

200	Serverstartopdracht succesvol verzonden
400	Ongeldig verzoek - de server draait al
404	Niet gevonden - Server bestaat niet

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

Stop Server

Een actieve server op een gecontroleerde manier afsluiten.

Voorbeeldverzoek

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

Voorbeeldantwoord

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

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

Server opnieuw opstarten

Een draaiende server op een gecontroleerde manier herstarten.

Voorbeeldverzoek

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

Voorbeeldantwoord

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

Responsstatuscodes

200	Serverherstartopdracht succesvol verzonden
400	Ongeldig verzoek - Server draait niet
404	Niet gevonden - Server bestaat niet

VPS.org API

Alle servers weergeven

Queryparameters

Voorbeeldverzoek

Voorbeeldantwoord

Responsstatuscodes

Nieuwe server aanmaken

Parameters van de aanvraagbody

Voorbeeldverzoek

Voorbeeldantwoord

Responsstatuscodes

Servergegevens opvragen

Padparameters

Voorbeeldverzoek

Voorbeeldantwoord

Responsstatuscodes

Updateserver

Padparameters

Parameters van de aanvraagbody

Voorbeeldverzoek

Responsstatuscodes

Server gedeeltelijk bijwerken

Voorbeeldverzoek

Server verwijderen

Voorbeeldverzoek

Responsstatuscodes

Start server

Voorbeeldverzoek

Voorbeeldantwoord

Responsstatuscodes

Stop Server

Voorbeeldverzoek

Voorbeeldantwoord

Server opnieuw opstarten

Voorbeeldverzoek

Voorbeeldantwoord

Responsstatuscodes