VPS.org API dokumentace

Začínáme

Rozhraní VPS.org API vám umožňuje programově spravovat všechny aspekty vaší VPS hostingové infrastruktury, včetně serverů, domén, DNS záznamů, záloh a snapshotů.

Ověřování

Všechny požadavky API vyžadují ověření pomocí nosičového tokenu. Token API si můžete vygenerovat v nastavení účtu na adrese 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);

Každý žeton nese svá vlastní oprávnění, jako jsou servery:list nebo dns:*. Žádost, která potřebuje povolení, žeton nemá, je odmítnuta s 403 a požadované_permission pole pojmenování chybějící povolení. Odkaz na povolení

Omezení rychlosti

Autentizované žádosti jsou omezeny na 1000 za hodinu na účet. Neautentické žádosti jsou omezeny na 100 za hodinu na IP adresu. Poptávka přes limit obdrží 429 s hlavičkou Retry-Po, která dává počet sekund čekat. Na úspěšné odpovědi nejsou odesílány žádné limitní hlavičky.

Paginace

Vypsat cílové parametry vrátit objekt s počtem, další, předchozí a výsledky, 25 položek na stránku. Pass stránky pro pohyb mezi stránkami, nebo následovat další URL dokud je null. Seznam serverů také přijímá velikost stránky, až 100.

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

Zpracování chyb

API používá standardní stavové kódy HTTP k indikaci úspěchu nebo neúspěchu:

Chybové orgány jsou JSON. Většina má pole detailů nebo pole chyb, někdy se zprávou; chyby validace uvádějí problémy podle názvu pole.

Kategorie API

Procházejte naši dokumentaci k API podle kategorií:

Další koncové body

API má také cílové hodnoty pro nasazení aplikací (/api/v1/deploy-configs/ a /api/v1/translations/). Ještě nejsou popsány na těchto stránkách; interaktivní referenční seznamy jsou uvedeny v každém cílovém parametru, generovaném z živého API.

Potřebujete pomoc?

Pokud máte dotazy nebo potřebujete pomoc s API, neváhejte se na nás obrátit:

• Tikety podpory: Otevřít tiket podpory
• E-mail: hello@vps.org
• Dokumentace: Kompletní dokumentace