VPS.org API

REST API dokumentacija

VPS.org API dokumentacija

Kompletna REST API dokumentacija za upravljanje VPS serverima, domenama, DNS-om, sigurnosnim kopijama i još mnogo toga.

Osnovni URL https://admin.vps.org/api/v1
Autentifikacija Token nosioca
Verzija v1
Format JSON

Početak

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

Autentifikacija

Svi API zahtjevi zahtijevaju autentifikaciju pomoću Bearer tokena. Svoj API token možete generirati iz postavki 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 token nosi svoje vlastite dozvole, kao što su servers:list ili dns:*.Zahtjev koji zahtijeva dozvolu koju token nema odbijen je sa 403 i required_permission polje koje naziva dozvolu koja nedostaje. Referentne dozvole

Ograničavanje brzine

Zahtjevi sa autentifikacijom su ograničeni na 1000 po satu po računu. Zahtjevi bez autentifikacije su ograničeni na 100 po satu po IP adresi. Zahtjev preko ograničenja prima 429 sa zaglavljem Retry-After koje daje broj sekundi čekanja. Ne šalju se zaglavlja ograničenja brzine na uspješne odgovore.

Pager

List krajnje tačke vraćaju objekt sa brojem, sljedećim, prethodnim i rezultatima, 25 stavki po stranici. Propusti stranicu da se pomakneš između stranica, ili slijedi sljedeći URL dok ne bude null. List servera također prihvaća page_size, 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 završen
201 Kreirano - Resurs je uspješno kreiran
400 Loš zahtjev - Nevažeći parametri ili oštećen zahtjev
202, 204 Prihvaćeno i u redu (202), ili izbrisano bez tijela odgovora (204)
402 Potrebno plaćanje: nema načina plaćanja u datoteci, neplaćeni računi ili odbijena prethodna autorizacija kartice
403 Zabranjeno: token nedostaje, nije važeći ili je istekao, ili nema potrebne dozvole. Neuspješna autentifikacija također vraća 403, ne 401.
404 Nije pronađeno - Resurs ne postoji
409 Konflikt: na primjer promjena veličine već je u toku, nedovoljan kapacitet, ili implementacija već je pokrenuta
429 Previše zahtjeva - Prekoračeno ograničenje brzine
500 Interna greška servera - Nešto nije u redu s naše strane
503 Servis nije dostupan: privremeni problem. Pokušajte ponovo, poštujući Retry-After kada je poslan.

Tijela grešaka su JSON. Većina ima polje detalja ili polje greške, ponekad sa porukom; greške validiranja navode probleme po imenu polja.

Kategorije API-ja

Pregledajte našu API dokumentaciju po kategorijama:

API servera 15 Krajnje tačke

Stvara, pregledava, napaja, mijenja veličinu i briše servere, resetiraju root lozinku, postavljaju reverzni DNS, pokreću naredbe i upravljaju SSH ključevima.

Pogledajte dokumentaciju
API za sigurnosne kopije 4 Krajnje tačke

Popis sigurnosnih kopija servera, pokretanje nove sigurnosne kopije i vraćanje servera iz sigurnosne kopije.

Pogledajte dokumentaciju
API za snimke 4 Krajnje tačke

Učinite označene snimke servera, popisajte ih i izbrišite.

Pogledajte dokumentaciju
API za planove 2 Krajnje tačke

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

Pogledajte dokumentaciju
API operativnih sistema 2 Krajnje tačke

Popis operativnih sistema i verzija koje možete instalirati, kao što su Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora i Alpine.

Pogledajte dokumentaciju
Domain API 7 Krajnje tačke

Provjeriti dostupnost, registrirati i obnoviti domene, postaviti nameservere i automatsko obnavljanje.

Pogledajte dokumentaciju
DNS API 13 Krajnje tačke

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

Pogledajte dokumentaciju
API za lokacije 2 Krajnje tačke

Popis lokacija dostupnih za implementaciju servera.

Pogledajte dokumentaciju
Račun 1 Krajnje tačke

Dohvati informacije o profilu računa i API tokenu. Identificiraj kojem računu pripada token i provjeri njegove dozvole.

Pogledajte dokumentaciju
Pridruženi 7 Krajnje tačke

Uključuje i dnevni izvještaj o poslovanju, izvještaj o prodaji, izvještaj o prihodima i rashodima, izvještaj o promjenama u prihodima i rashodima, izvještaj o izvršenju proračuna i izvještaj o izvršenju proračuna.

Pogledajte dokumentaciju

Više krajnjih tačaka

API također ima krajnje tačke za implementaciju aplikacija (/api/v1/deploy-configs/ i /api/v1/deployments/). One još nisu opisane na ovim stranicama; interaktivna referenca navodi svaku krajnju tačku, generiranu iz live API-ja.

Otvori interaktivnu API referencu

Trebate pomoć?

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