Complete REST API-documentatie voor het beheren van VPS-servers, domeinen, DNS, back-ups en meer.
Met de VPS.org API kunt u programmatisch alle aspecten van uw VPS-hostinginfrastructuur beheren, waaronder servers, domeinen, DNS-records, back-ups en snapshots.
Alle API-verzoeken vereisen authenticatie met een Bearer-token. U kunt uw API-token genereren via uw accountinstellingen. admin.vps.org/account/developers/.
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 data = await response.json();
console.log(data);Elke token heeft zijn eigen rechten, zoals servers:list of dns:*. Een verzoek dat een toestemming nodig heeft die het token niet heeft, wordt geweigerd met 403 en een verplicht_permissieveld met de ontbrekende toestemming. Verwijzing naar machtigingen
Aangemelde verzoeken zijn beperkt tot 1.000 per uur per account. Ongeauthenticeerde verzoeken zijn beperkt tot 100 per uur per IP-adres. Een verzoek over de limiet ontvangt 429 met een Retry-After header die het aantal seconden geeft om te wachten. Er worden geen tarieflimietkoppen verstuurd op succesvolle antwoorden.
Lijst eindpunten geven een object terug met telling, volgende, vorige en resultaten, 25 items per pagina. Passeer pagina om te verplaatsen tussen pagina's, of volg de volgende URL totdat het nul is. De serverslijst accepteert ook pagina_grootte, tot 100.
{
"count": 84,
"next": "https://admin.vps.org/api/v1/backups/?page=2",
"previous": null,
"results": [ ... ]
}De API gebruikt standaard HTTP-statuscodes om succes of mislukking aan te geven:
| Statuscode | Omschrijving |
|---|---|
200 |
Succes - Verzoek succesvol afgerond |
201 |
Aangemaakt - Bron succesvol aangemaakt |
400 |
Ongeldig verzoek - Ongeldige parameters of een onjuist geformuleerd verzoek. |
202, 204 |
Geaccepteerd en in de wachtrij gezet (202) of verwijderd zonder antwoordlichaam (204) |
402 |
Betaling Vereist: geen betalingsmethode in het bestand, onbetaalde facturen of een geweigerde kaartpre-autorisatie |
403 |
Verboden: het token ontbreekt, ongeldig of verlopen, of mist de vereiste toestemming. Foute authenticatie geeft ook 403, niet 401 terug. |
404 |
Niet gevonden - De bron bestaat niet |
409 |
Conflict: bijvoorbeeld een herindeling die al bezig is, niet genoeg capaciteit, of een reeds uitgevoerde implementatie |
429 |
Te veel aanvragen - Limiet voor het aantal aanvragen overschreden |
500 |
Interne serverfout - Er is iets misgegaan aan onze kant. |
503 |
Service Niet beschikbaar: een tijdelijk probleem. Herproberen, erewoord na het verzenden. |
Fout-lichamen zijn JSON. De meeste hebben een detailveld of een foutveld, soms met een bericht; validatie-fouten geven de problemen op naam van het veld weer.
Bekijk onze API-documentatie per categorie:
Creëer, inspecteer, stroom, formaat en verwijder servers, reset het root-wachtwoord, stel omgekeerde DNS in, voer commando's uit en beheer SSH-sleutels.
Documentatie bekijkenGeef uw back-ups van de server op, start een nieuwe back-up en herstel een server vanuit een back-up.
Documentatie bekijkenNeem de labels snapshots van een server, vermeld ze en verwijder ze.
Documentatie bekijkenBekijk de beschikbare VPS-abonnementen en prijsinformatie. Ontvang details over resources, prijzen en beschikbaarheid.
Documentatie bekijkenGeef een overzicht van de besturingssystemen en versies die u kunt installeren, zoals Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora en Alpine.
Documentatie bekijkenControleer beschikbaarheid, register en vernieuwing domeinen, en set nameservers en auto-vernieuwing.
Documentatie bekijkenMaak DNS-zones aan en maak, update en verwijder hun A, A, CNAME, MX, TXT, SRV, CAA en andere records.
Documentatie bekijkenGeef een lijst van de beschikbare locaties voor server-implementatie.
Documentatie bekijkenAccountprofiel en API token-informatie ophalen. Identificeer tot welke account een token behoort en controleer de rechten ervan.
Documentatie bekijkenTrek uw affiliate saldo, verwijzingen, commissies en uitbetalingen in uw eigen rapportage, wijzigen uitbetaling instellingen en verzoeken uitbetalingen.
Documentatie bekijkenDe API heeft ook eindpunten voor app-implementaties (/api/v1/deploy-configs/ en /api/v1/diployments/). Ze worden nog niet beschreven op deze pagina's; de interactieve referentie geeft elk eindpunt weer dat wordt gegenereerd uit de live API.
Open de interactieve API-referentieAls u vragen heeft of hulp nodig heeft met de API, neem dan gerust contact met ons op.