VPS.org API

REST API dokumentacija

VPS.org API dokumentacija

Potpuna REST API dokumentacija za upravljanje VPS poslužiteljima, domenama, DNS-om, sigurnosnim kopijama i još mnogo toga.

Osnovni URL https://admin.vps.org/api/v1
Autentifikacija Token nositelja
Inačica v1
Format JSON

Početak rada

VPS.org API vam omogućuje programsko upravljanje svim aspektima vaše VPS hosting infrastrukture, uključujući poslužitelje, domene, DNS zapise, sigurnosne kopije i snimke stanja.

Autentifikacija

Svi API zahtjevi zahtijevaju autentifikaciju pomoću Bearer tokena. Svoj API token možete generirati u postavkama računa na 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);

Svaki žeton nosi vlastite dozvole, kao što su poslužitelji:list ili dns:*. Zahtjev koji zahtijeva dozvolu koji žeton ne ima odbija se sa 403 i obavezno_permisijsko polje koje imenuje nedostajuću dozvolu. Odrednice ispisa

Ograničavanje brzine

Autentizirani zahtjevi ograničeni su na 1.000 po satu po računu. Neautentizirani zahtjevi su ograničeni na 100 po satu po IP adresi. Zahtjev preko granice prima 429 s zaglavljem Ponovno-After kojim se daje broj sekundi za čekanje. Na uspješne odgovore ne šalju se ograničena zaglavlja.

Pogađanje

Popis ishoda vraća objekt s brojanjem, sljedećim, prethodnim i rezultatima, 25 stavki po stranici. Dodaj stranicu za premještanje između stranica ili slijedeći URL dok nije null. Poslužitelji također prihvaća stranicu do 100.

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

Obrada grešaka

API koristi standardne HTTP statusne kodove za označavanje uspjeha ili neuspjeha:

Statusni kod Opis
200 Uspjeh - Zahtjev uspješno dovršen
201 Kreirano - Resurs je uspješno kreiran
400 Loš zahtjev - Nevažeći parametri ili neispravan zahtjev
202, 204 Prihvaćeno i u redu (202), ili izbrisano bez odgovora tijela (204)
402 Plaćanje obavezno: nema načina plaćanja na datoteci, neplaćene račune ili odbijena pred-ovlaštenja kartica
403 Zabranjeno: token nedostaje, nevažeći ili istekao, ili nedostaje potrebna dozvola. Neuspješna autorizacija također vraća 403, ne 401.
404 Nije pronađeno - Resurs ne postoji
409 Konflikt: primjerice, već je u toku, nedovoljno kapaciteta ili već pokrenuto raspoređivanje
429 Previše zahtjeva - prekoračeno ograničenje brzine
500 Interna pogreška poslužitelja - Nešto je pošlo po zlu s naše strane
503 Servis nedostupan: privremeni problem. Ponovite, počasti Ponovno-Ponovno nakon što je poslano.

Tijela grešaka su JSON. Većina ima polje detalja ili polje greške, ponekad s porukom; potvrda grešaka navodi probleme po polju ime.

Kategorije API-ja

Pregledajte našu API dokumentaciju po kategorijama:

API poslužitelja 15 Krajnje točke

Kreirajte, pregledajte, napajajte, mijenjajte veličinu i brišete poslužitelje, resetirajte root lozinku, postavite obrnuti DNS, pokrenite naredbe i upravljajte SSH tipkama.

Prikaži dokumentaciju
API za sigurnosne kopije 4 Krajnje točke

Navedite svoje sigurnosne kopije poslužitelja, pokrenite novu sigurnosnu kopiju i vratite poslužitelj iz sigurnosne kopije.

Prikaži dokumentaciju
API za snimke 4 Krajnje točke

Uzmite označene snimke poslužitelja, napišite ih i izbrišite ih.

Prikaži dokumentaciju
API za planove 2 Krajnje točke

Preuzmite dostupne VPS planove i informacije o cijenama. Dobijte detalje o resursima, cijenama i dostupnosti.

Prikaži dokumentaciju
API operativnih sustava 2 Krajnje točke

Navedite operativne sustave i verzije koje možete instalirati, kao što su Ubuntu, Debian, Rocky Linux, CentOS stream, Fedora i Alpine.

Prikaži dokumentaciju
API domena 7 Krajnje točke

Provjerite dostupnost, registrirati i obnoviti domene, i postavite ime serveri i automatsko obnovljivanje.

Prikaži dokumentaciju
DNS API 13 Krajnje točke

Kreirajte DNS zone i kreirajte, ažurirajte i izbrišite njihove A, A, CNAME, MX, TXT, SRV, CAA i druge zapise.

Prikaži dokumentaciju
API za lokacije 2 Krajnje točke

Navedite lokacije koje su dostupne za raspoređivanje poslužitelja.

Prikaži dokumentaciju
Korisnički račun 1 Krajnje točke

Dobavite profil računa i API tokena informacije. Identificirajte koji račun tokena pripada i provjerite njegove dozvole.

Prikaži dokumentaciju
Afilijci 7 Krajnje točke

Povucite svoj affiliate bilans, upućivanja, provizije i isplate u vlastito izvješće, promijenite isplatu i tražite isplate.

Prikaži dokumentaciju

Više krajnjih bodova

API također ima ishode za raspoređivanje aplikacija (/api/v1/deloy-configs/ i /api/v1/delopyments /). Oni još nisu opisani na ovim stranicama; interaktivna referentna lista svaki ishod, generiran iz uživo API.

Otvori interaktivnu API referencu

Trebate pomoć?

Ako imate pitanja ili vam je potrebna pomoć s API-jem, slobodno se obratite: