VPS.org API

REST API Documentation

VPS.org API Documentation

Kompleta REST API-dokumentaro por administri VPS-servilojn, domajnojn, DNS-ojn, sekurkopiojn kaj pli.

Baza URL https://admin.vps.org/api/v1
Aŭtentigo Ĵetono por portanto
Version v1.0
Format JSON

Komenco

La API de VPS.org permesas al vi programece administri ĉiujn aspektojn de via VPS-gastiga infrastrukturo, inkluzive de serviloj, domajnoj, DNS-rekordoj, sekurkopioj kaj momentfotoj.

Aŭtentigo

Ĉiuj API-petoj postulas aŭtentikigon per portanto-ĵetono. Vi povas generi vian API-ĵetonon el viaj konto-agordoj ĉe 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);

Limigado de Rapido

API-petoj estas limigitaj al 300 petoj po 5 minutoj por ĉiu API-ĵetono. Informoj pri la limo de rapideco estas inkluzivitaj en la respondkaplinioj:

Erara Traktado

La API uzas normajn HTTP-statuskodojn por indiki sukceson aŭ malsukceson:

Statusa Kodo Description
200 Sukceso - Peto sukcese kompletigita
201 Kreita - Rimedo sukcese kreita
400 Malbona Peto - Malvalidaj parametroj aŭ misformita peto
401 Neaŭtorizita - Malvalida aŭ mankanta aŭtentiga ĵetono
403 Malpermesita - Nesufiĉaj permesoj
404 Ne trovita - Rimedo ne ekzistas
429 Tro Multaj Petoj - La limo de rapideco superita
500 Interna Servila Eraro - Io misfunkciis ĉe nia flanko

API-Kategorioj

Foliumu nian API-dokumentaron laŭ kategorio:

Servila API 9 finpunktoj

Kreu, administru kaj kontrolu VPS-servilojn. Inkluzivas energiadministradon, regrandigon, reinstaladon kaj serĉadon de servilaj informoj.

Vidi Dokumentaron
API por sekurkopioj 3 finpunktoj

Administru aŭtomatajn kaj manajn sekurkopiojn por viaj serviloj. Listigi, krei, restarigi kaj forigi servilajn sekurkopiojn.

Vidi Dokumentaron
API por Momentfotoj 4 finpunktoj

Kreu kaj administru servilajn momentfotojn por rapidaj restarigpunktoj. Perfekta por testado kaj rapidaj restarigoj.

Vidi Dokumentaron
Planoj API 2 finpunktoj

Akiru disponeblajn VPS-planojn kaj prezojn. Akiru detalojn pri rimedoj, prezoj kaj havebleco.

Vidi Dokumentaron
API de Operaciumoj 2 finpunktoj

Listigi disponeblajn operaciumojn kaj bildojn por servila deplojo. Inkluzivas Ubuntu, Debian, CentOS, kaj pli.

Vidi Dokumentaron
Domains API 6 finpunktoj

Serĉu, kontrolu haveblecon, registru kaj administru domajnajn nomojn. Kompleta domajna vivciklo-administrado per la API.

Vidi Dokumentaron
DNS API 4 finpunktoj

Administru DNS-zonojn kaj rikordojn programece. Kreu, ĝisdatigu kaj forigu rikordajn tipojn A, AAAA, CNAME, MX, TXT kaj aliajn.

Vidi Dokumentaron
Lokoj API 1 finpunkto

Listigi disponeblajn datumcentrajn lokojn por servila deplojo. Elektu el pluraj regionoj tra la mondo.

Vidi Dokumentaron
Account 1 endpoint

Retrieve account profile and API token information. Identify which account a token belongs to and check its permissions.

Vidi Dokumentaron

Ĉu vi bezonas helpon?

Se vi havas demandojn aŭ bezonas helpon pri la API, bonvolu ne heziti kontakti: