VPS.org API dokumentácia

Začíname

Rozhranie VPS.org API vám umožňuje programovo spravovať všetky aspekty vašej VPS hostingovej infraštruktúry vrátane serverov, domén, DNS záznamov, záloh a snímok.

Autentifikácia

Všetky požiadavky API vyžadujú autentifikáciu pomocou nosičového tokenu. Svoj token API si môžete vygenerovať v nastaveniach svojho účtu na adrese 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);

Každý token nesie svoje vlastné oprávnenia, ako servers:list alebo dns:* Požiadavka, ktorá potrebuje oprávnenie, ktoré token nemá, je zamietnutá s 403 a poľom required_permission s názvom chýbajúceho oprávnenia. Referencie na povolenia

Obmedzenie rýchlosti

Overené požiadavky sú obmedzené na 1 000 za hodinu na konto. Neoverené požiadavky sú obmedzené na 100 za hodinu na IP adresu. Požiadavka prekračujúca limit dostane hodnotu 429 s hlavičkou Retry-After, ktorá udáva počet sekúnd čakania. Pri úspešných odpovediach sa neodosielajú hlavičky limitu rýchlosti.

Stránkovanie

List endpoints vrátia objekt s počtom, nasledujúcim, predchádzajúcim a výsledkami, 25 položiek na stránku. Prejdite stránku na presun medzi stránkami alebo sledujte ďalšiu URL, kým nie je null. Zoznam serverov tiež prijíma page_size, až do 100.

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

Ošetrenie chýb

API používa štandardné stavové kódy HTTP na označenie úspechu alebo neúspechu:

Stavový kód	Opis
`200`	Úspech - Žiadosť bola úspešne dokončená
`201`	Vytvorené – Zdroj bol úspešne vytvorený
`400`	Nesprávna požiadavka – neplatné parametre alebo chybne formátovaná požiadavka
`202`, `204`	Prijaté a zaradené do frontu (202) alebo odstránené bez tela odpovede (204)
`402`	Vyžaduje sa platba: žiadny spôsob platby v registri, nezaplatené faktúry alebo zamietnutá predbežná autorizácia karty
`403`	Zakázané: token chýba, je neplatný alebo vypršal, alebo nemá požadované povolenie.Zlyhanie overenia tiež vráti 403, nie 401.
`404`	Nenájdené - Zdroj neexistuje
`409`	Konflikt: napríklad zmena veľkosti už prebieha, nie je dostatok kapacity alebo nasadenie už beží
`429`	Príliš veľa žiadostí – prekročený limit rýchlosti
`500`	Interná chyba servera – Na našej strane sa niečo pokazilo.
`503`	Služba nie je k dispozícii: dočasný problém. Skúste to znova, keď je odoslaná, bude sa rešpektovať Retry-After.

Väčšina z nich má detailné pole alebo chybové pole, niekedy aj so správou; validácia chýb uvádza problémy podľa názvu poľa.

Kategórie API

Prezrite si našu dokumentáciu k API podľa kategórie:

API serverov 15 Koncové body

Vytvárajte, kontrolujte, napájajte, meníte veľkosť a odstraňujte servery, obnovte heslo root, nastavte spätný DNS, spúšťajte príkazy a spravujte SSH kľúče.

Zobraziť dokumentáciu

Zálohovacie API 4 Koncové body

Zoznam záloh servera, spustenie nového zálohovania a obnovenie servera zo zálohy.

Zobraziť dokumentáciu

Rozhranie API pre snímky 4 Koncové body

Vytvárajte označené snímky servera, zobrazte ich a odstráňte.

Zobraziť dokumentáciu

Rozhranie API pre plány 2 Koncové body

Získajte dostupné VPS plány a informácie o cenách. Získajte podrobnosti o zdrojoch, cenách a dostupnosti.

Zobraziť dokumentáciu

API operačných systémov 2 Koncové body

Zoznam operačných systémov a verzií, ktoré môžete nainštalovať, ako napríklad Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora a Alpine.

Zobraziť dokumentáciu

API pre domény 7 Koncové body

Skontrolujte dostupnosť, zaregistrujte a obnovte domény a nastavte názvové servery a automatické obnovenie.

Zobraziť dokumentáciu

API DNS 13 Koncové body

Vytvárajte DNS zóny a vytvárajte, aktualizujte a odstraňujte ich A, A, CNAME, MX, TXT, SRV, CAA a ďalšie záznamy.

Zobraziť dokumentáciu

API pre lokality 2 Koncové body

Zoznam umiestnení dostupných pre nasadenie servera.

Zobraziť dokumentáciu

Účet 1 Koncové body

Identifikujte, ku ktorému účtu token patrí, a skontrolujte jeho povolenia.Identify which account a token belongs to and check its permissions.

Zobraziť dokumentáciu

Pridružené spoločnosti 7 Koncové body

Stiahnite si svoj partnerský zostatok, odporúčania, provízie a platby do vlastného reportingu, zmeňte nastavenia platieb a požiadajte o platby.

Zobraziť dokumentáciu

Ďalšie koncové body

API má tiež koncové body pre nasadenie aplikácií (/api/v1/deploy-configs/ a /api/v1/deployments/), ktoré zatiaľ nie sú popísané na týchto stránkach; interaktívna referenčná príručka uvádza zoznam všetkých koncových bodov generovaných zo živého API.

Otvorte interaktívnu referenciu API

Potrebujete pomoc?

Ak máte otázky alebo potrebujete pomoc s rozhraním API, neváhajte nás kontaktovať:

Tikety podpory: Otvoriť tiket podpory
E-mail: hello@vps.org
Dokumentácia: Úplná dokumentácia