Komplett REST API-dokumentation för hantering av VPS-servrar, domäner, DNS, säkerhetskopior och mer.
VPS.org API låter dig programmatiskt hantera alla aspekter av din VPS-hostinginfrastruktur, inklusive servrar, domäner, DNS-poster, säkerhetskopior och ögonblicksbilder.
Alla API-förfrågningar kräver autentisering med en Bearer-token. Du kan generera din API-token från dina kontoinställningar på 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);Varje token har sina egna behörigheter, såsom servrar: lista eller dns: *. En begäran som behöver en behörighet som token inte har nekas med 403 och ett obligatoriskt_ permissionsfält som namnger den saknade behörigheten. Behörighetsreferens
Behörighetsskyddade förfrågningar är begränsade till 1000 per timme och konto. Oautenticerade förfrågningar begränsas till 100 per timme per IP- adress. En begäran om att överskrida gränsen får 429 med ett Retry- After-huvud som ger antalet sekunder att vänta. Inga kursgränshuvuden skickas på lyckade svar.
Lista endpoints returnerar ett objekt med räkning, nästa, föregående och resultat, 25 objekt per sida. Passa sidan för att flytta mellan sidor, eller följ nästa URL tills den är ogiltig. Serverlistan accepterar också page_ size, upp till 100.
{
"count": 84,
"next": "https://admin.vps.org/api/v1/backups/?page=2",
"previous": null,
"results": [ ... ]
}API:et använder standard HTTP-statuskoder för att indikera framgång eller misslyckande:
| Statuskod | Varuslag |
|---|---|
200 |
Lyckades - Begäran slutförd |
201 |
Skapad - Resursen har skapats |
400 |
Felaktig begäran - Ogiltiga parametrar eller felaktigt formaterad begäran |
202, 204 |
Godkänd och köad (202), eller struken utan svarsorgan (204) |
402 |
Betalning krävs: ingen betalningsmetod på fil, obetalda fakturor, eller ett nekat kort för godkännande |
403 |
Förbjuden: token saknas, är ogiltig eller har gått ut, eller saknar den behörighet som krävs. Misslyckad behörighetskontroll returnerar också 403, inte 401. |
404 |
Hittades inte - Resursen finns inte |
409 |
Konflikt: till exempel en omdimensionering som redan pågår, otillräcklig kapacitet eller en utbyggnad som redan pågår |
429 |
För många förfrågningar - Hastighetsgränsen har överskridits |
500 |
Internt serverfel – Något gick fel hos oss |
503 |
Service Otillgänglig: ett tillfälligt problem. Försök igen, hedra Retry-After när det skickas. |
Felorgan är JSON. De flesta har ett detaljfält eller ett felfält, ibland med ett meddelande; valideringsfel listar problemen efter fältnamn.
Bläddra bland vår API-dokumentation efter kategori:
Skapa, inspektera, driva, ändra storlek och ta bort servrar, återställa rot lösenord, ställa in omvänd DNS, köra kommandon och hantera SSH-nycklar.
Visa dokumentationListar serversäkerhetskopieringar, startar en ny säkerhetskopia och återställer en server från en säkerhetskopia.
Visa dokumentationTa märkta ögonblicksbilder av en server, lista dem och ta bort dem.
Visa dokumentationHämta tillgängliga VPS-planer och prisinformation. Få information om resurser, priser och tillgänglighet.
Visa dokumentationLista operativsystem och versioner som du kan installera, som Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora och Alpine.
Visa dokumentationKontrollera tillgänglighet, registrera och förnya domäner, och ange namnservrar och automatisk förnyelse.
Visa dokumentationSkapa DNS-zoner och skapa, uppdatera och ta bort deras A, A, CNAME, MX, TXT, SRV, CAA och andra poster.
Visa dokumentationLista platserna som är tillgängliga för serverdistribution.
Visa dokumentationHämta kontoprofil och API token information. Identifiera vilket konto en token tillhör och kontrollera dess rättigheter.
Visa dokumentationDra in ditt affiliate-saldo, remisser, provisioner och utbetalningar i din egen rapportering, ändra utbetalningsinställningar och begära utbetalningar.
Visa dokumentationAPI:et har också endpoints för app-utplaceringar (/api/v1/deploy-configs/ och /api/v1/deployments/). De beskrivs inte på dessa sidor ännu; de interaktiva referenslistorna varje endpoint, som genereras från live API.
Öppna den interaktiva API-referensenOm du har frågor eller behöver hjälp med API:et, tveka inte att kontakta oss: