VPS.org API- dokumentasjon

Komme i gang

VPS.org API lar deg programmatisk administrere alle aspekter av VPS-hostinginfrastrukturen din, inkludert servere, domener, DNS-oppføringer, sikkerhetskopier og øyeblikksbilder.

Autentisering

Alle API-forespørsler krever autentisering ved hjelp av et Bearer-token. Du kan generere API-tokenet ditt fra kontoinnstillingene dine på admin.vps.org/account/developers/.

cURL

Python

JavaScript

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

Hvert symbol har sine egne rettigheter, slik som servere: list eller dns: *. En forespørsel som trenger tillatelse som symbolet ikke har blir nektet med 403 og et påkrevd_ permission felt som navngir den manglende tillatelsen. Rettigheter referanse

Hastighetsbegrensning

Autentiserte forespørsler er begrenset til 1000 pr. time pr konto. Uanerkjente forespørsler er begrenset til 100 pr. time pr IP- adresse. En forespørsel over grensen mottar 429 med en « Prøv igjen etter » - overskrift som angir hvor mange sekunder du vil vente. Det blir ikke sendt noen overskrifter med rentegrense for vellykkede svar.

Sjikt

List endepunkter returnerer et objekt med antall, neste, forrige og resultater, 25 elementer på siden. Gå forbi siden for å flytte mellom sider, eller følg neste URL til det er null. Tjenerlista godtar også side_ størrelse opp til 100.

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

Feilhåndtering

API-et bruker standard HTTP-statuskoder for å indikere suksess eller fiasko:

Statuskode	Beskrivelse
`200`	Suksess - Forespørselen er fullført
`201`	Opprettet – Ressursen er opprettet
`400`	Feil forespørsel – Ugyldige parametere eller feilformet forespørsel
`202`, `204`	Godkjent og i kø (202), eller slettet uten svarorgan (204)
`402`	Nødvendig betaling: ingen betalingsmetode på fil, ubetalte fakturaer eller avvist kort forut for godkjenning
`403`	Forbudt: symbolet mangler, er ugyldig eller utløpt, eller mangler den nødvendige tillatelsen. Autentisering gir også 403, ikke 401.
`404`	Ikke funnet – Ressursen finnes ikke
`409`	Konflikt: for eksempel en endring av størrelse som allerede pågår, ikke nok kapasitet, eller en innføring som allerede kjører
`429`	For mange forespørsler – Frekvensgrensen er overskredet
`500`	Intern serverfeil – noe gikk galt hos oss
`503`	Tjenesten ikke tilgjengelig: et midlertidig problem. Forsøk igjen, oppfyller gjenoppta når den sendes.

Feilkropper er JSON. De fleste har et detaljfelt eller feilfelt, noen ganger med en melding. Valideringsfeil viser problemene etter feltnavn.

API-kategorier

Bla gjennom API-dokumentasjonen vår etter kategori:

Server-API 15 Endepunkter

Opprett, besiktig, makt, endre størrelse og slett tjenere, nullstill root- passordet, sett tilbake DNS, kjør kommandoer og organiser SSH- nøkler.

Vis dokumentasjon

Sikkerhetskopierings-API 4 Endepunkter

List opp tjeneren din, start en ny sikkerhetskopi og gjenopprett en tjener fra en sikkerhetskopi.

Vis dokumentasjon

API- bilder 4 Endepunkter

Ta et merket skjermbilde av en tjener, vis det og slett.

Vis dokumentasjon

Planer API 2 Endepunkter

Hent tilgjengelige VPS-abonnementer og prisinformasjon. Få detaljer om ressurser, priser og tilgjengelighet.

Vis dokumentasjon

Operativsystemer API 2 Endepunkter

List opp operativsystemene og versjonene du kan installere, slik som Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora og Alpine.

Vis dokumentasjon

Domene- API 7 Endepunkter

Sjekk tilgjengelighet, registrer og forny domener, og sett navntjenere og automatisk fornyelse.

Vis dokumentasjon

DNS API 13 Endepunkter

Opprett DNS- områder og opprett, oppdater og slett sine A, A, CNAME, MX, TXT, SRV, CAA og andre poster.

Vis dokumentasjon

Steder API 2 Endepunkter

List ut stedene som er tilgjengelige for tjenerutføring.

Vis dokumentasjon

Konto 1 Endepunkter

Hent kontoprofil og informasjon om API- tegn. Identifiser hvilken konto et symbol tilhører, og sjekk tillatelsene den har.

Vis dokumentasjon

Tilknyttede foretak 7 Endepunkter

Dra din tilknyttede balanse, henvisninger, provisjoner og utbetalinger inn i din egen rapportering, endre utbetalingsinnstillinger og be om utbetalinger.

Vis dokumentasjon

Flere endepunkter

API har også endepunkter for programutbygginger (/api/v1/deploy-configs/ og /api/v1/deployments/). De er ikke beskrevet på disse sidene ennå; de interaktive referanselistene er laget fra live API.

Åpne den interaktive API- referansen

Trenger du hjelp?

Hvis du har spørsmål eller trenger hjelp med API-et, ikke nøl med å ta kontakt:

Støtteforespørsler: Åpne en supportforespørsel
E-post: hello@vps.org
Dokumentasjon: Full dokumentasjon