VPS.org API dokumentacija

Začetek

VPS.org API vam omogoča programsko upravljanje vseh vidikov vaše VPS gostovalne infrastrukture, vključno s strežniki, domenami, DNS zapisi, varnostnimi kopijami in posnetki podatkov.

Avtentikacija

Vse zahteve API zahtevajo preverjanje pristnosti z žetonom nosilca. Žeton API lahko ustvarite v nastavitvah računa na 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);

Vsak žeton ima svoja dovoljenja, kot so strežniki:list ali dns:*. Zahtevek, ki potrebuje dovoljenje, ki ga žeton nima, je zavrnjen s 403 in zahtevanim_permisijskim poljem, ki poimenuje manjkajoče dovoljenje. Referenca o dovoljenjih

Omejevanje hitrosti

Avtentikirane zahteve so omejene na 1.000 na uro na račun. Neautentikirane zahteve so omejene na 100 na uro na naslov IP. Zahtevek nad mejo prejema 429 z glavo Ponovni-After, ki daje število sekund, ki čaka. Na uspešne odgovore ne pošiljajo omejevalnih zaglavij.

Pogajanje

Izbira končnih točk seznama vrne predmet z številom, naslednjim, prejšnjim in rezultati, 25 postavk na stran. Prenesite stran, da se premakne med stranmi ali sledite naslednjemu URL-ju, dokler ni null. Seznam strežnikov sprejme tudi stran_ velikost, do 100.

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

Obravnavanje napak

API uporablja standardne kode stanja HTTP za označevanje uspeha ali neuspeha:

Telesa napak so JSON. Večina ima polje za podrobnosti ali polje za napake, včasih s sporočilom; napake pri potrditvi naštejte težave po imenu polja.

Kategorije API-jev

Brskajte po naši dokumentaciji API-ja po kategorijah:

Več končnih točk

API ima tudi končne točke za uporabo aplikacij (/api/v1/razporeditev-configs/ in /api/v1/razporeditev /). Na teh straneh še niso opisani; interaktivna referenčna točka navaja vsak opazen dogodek, ki je nastal iz živega API.

Potrebujete pomoč?

Če imate vprašanja ali potrebujete pomoč z API-jem, se obrnite na:

• Vstopnice za podporo: Odprite zahtevek za podporo
• E-pošta: hello@vps.org
• Dokumentacija: Celotna dokumentacija