Komplet REST API-dokumentation til administration af VPS-servere, domæner, DNS, backups og mere.
VPS.org API'en giver dig mulighed for programmatisk at administrere alle aspekter af din VPS-hostinginfrastruktur, herunder servere, domæner, DNS-poster, sikkerhedskopier og snapshots.
Alle API-anmodninger kræver godkendelse ved hjælp af et Bearer-token. Du kan generere dit API-token fra dine kontoindstillinger 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);Hver token bærer sine egne tilladelser, såsom servere:list eller dns:*. En anmodning, der har brug for en tilladelse token ikke har, afvises med 403 og en påkrævet_permission felt navngivning den manglende tilladelse. Tilladelsesreference
Autentificerede anmodninger er begrænset til 1.000 pr. time pr. konto. Ugodkendte anmodninger er begrænset til 100 pr. time pr. IP- adresse. En anmodning over grænsen modtager 429 med en Retry- After header, der giver antallet af sekunder at vente. Ingen satsgrænse overskrifter sendes på vellykkede svar.
Liste slutpunkter returnerer et objekt med tæller, næste, tidligere og resultater, 25 elementer pr side. Pass side for at flytte mellem sider, eller følg den næste URL, indtil det er null. Serverlisten accepterer også side_ størrelse, op til 100.
{
"count": 84,
"next": "https://admin.vps.org/api/v1/backups/?page=2",
"previous": null,
"results": [ ... ]
}API'en bruger standard HTTP-statuskoder til at angive succes eller fiasko:
| Statuskode | Description |
|---|---|
200 |
Succes - Anmodning gennemført |
201 |
Oprettet - Ressource oprettet |
400 |
Dårlig anmodning - Ugyldige parametre eller forkert udformet anmodning |
202, 204 |
Accepteret og i kø (202), eller slettet uden respons organ (204) |
402 |
Betaling påkrævet: ingen betalingsmetode på fil, ubetalte fakturaer eller en afvist kort for bemyndigelse |
403 |
Forbudt: token mangler, er ugyldig eller udløbet, eller mangler den krævede tilladelse. Mislykkede godkendelse giver også 403, ikke 401. |
404 |
Ikke fundet - Ressourcen findes ikke |
409 |
Konflikt: for eksempel en resize allerede i gang, ikke nok kapacitet, eller en implementering allerede kører |
429 |
For mange anmodninger - Hastighedsgrænse overskredet |
500 |
Intern serverfejl - Noget gik galt hos os |
503 |
Service Ikke tilgængelig: et midlertidigt problem. Prøv igen, ære Retry-Efter når det er sendt. |
Fejlorganer er JSON. De fleste har et detaljefelt eller et fejlfelt, nogle gange med en meddelelse; valideringsfejl lister problemerne efter feltnavn.
Gennemse vores API-dokumentation efter kategori:
Opret, inspicere, magt, ændre størrelse og slette servere, nulstille root password, indstille omvendt DNS, køre kommandoer, og administrere SSH nøgler.
Se dokumentationListe din server backups, starte en ny backup, og gendanne en server fra en backup.
Se dokumentationTag mærkede øjebliksbilleder af en server, oplist dem og slet dem.
Se dokumentationHent tilgængelige VPS-abonnementer og prisoplysninger. Få detaljer om ressourcer, priser og tilgængelighed.
Se dokumentationListe over de operativsystemer og versioner, du kan installere, såsom Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora og Alpine.
Se dokumentationTjek tilgængelighed, registrere og forny domæner, og indstille navneservere og auto-fornyelse.
Se dokumentationOpret DNS-zoner og opret, opdatere og slette deres A, A, CNAME, MX, TXT, SRV, CAA og andre poster.
Se dokumentationListe over de steder, der er tilgængelige for server- implementering.
Se dokumentationHent kontoprofil og API token information. Identificer hvilken konto en token tilhører, og tjek dens tilladelser.
Se dokumentationAPI har også endpoints for app-udrulninger (/api/v1/deploy-configs/ og /api/v1/udførelser/). De er endnu ikke beskrevet på disse sider; de interaktive referencelister hvert endpoint, genereret fra den levende API.
Åbn den interaktive API- referenceHvis du har spørgsmål eller har brug for hjælp til API'en, er du velkommen til at kontakte os: