VPS.org API

Constellation name (optional)

VPS.org API Documentation

Volledige REST API-dokumentasie vir die bestuur van VPS-bedieners, domeine, DNS, rugsteun en meer.

Basis-URL https://admin.vps.org/api/v1
Verifikasie Draerteken
Weergawe v1
Formaat JSON

Aan die gang kom

Die VPS.org API laat jou toe om alle aspekte van jou VPS-gasheerinfrastruktuur programmaties te bestuur, insluitend bedieners, domeine, DNS-rekords, rugsteun en kiekies.

Verifikasie

Alle API-versoeke vereis verifikasie met behulp van 'n Draer-token. Jy kan jou API-token genereer vanaf jou rekeninginstellings by 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);

Elke vorm bevat sy eie regte, soos bedieners:list of dns:*. 'n Versoek wat 'n toestemming nodig het, word nie geweier met 403 en 'n benodigde_posaatveld met die naam van die ontbrekende toestemming nie. Regte Verwysing

Tempobeperking

Verifiëerde versoeke is tot 1 000 per uur per rekening beperk. Ongetroue versoeke word beperk tot 100 per uur per IP-adres. 'n Versoek oor die beperking ontvang 429 met' n herprobeer- na opskrif gee die nommer van sekondes om te wag. Geen tempo beperk opskrifte word gestuur op suksesvolle reaksies.

BerekenCity in New York USA

Lys puntpunte gee 'n voorwerp terug met tel, volgende, vorige en resultate, 25 items per bladsy. Pas op bladsy om tussen bladsye te skuif, of volg die volgende URL totdat dit nie kan nie. Die bedienerslys aanvaar ook bladsy_grootte, tot 100.

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

Fouthantering

Die API gebruik standaard HTTP-statuskodes om sukses of mislukking aan te dui:

Statuskode Beskrywing
200 Sukses - Versoek suksesvol voltooi
201 Geskep - Hulpbron suksesvol geskep
400 Slegte versoek - Ongeldige parameters of verkeerd gevormde versoek
202, 204 Aanvaar en wagtou (202), of uitgevee met geen reaksie liggaam (204)
402 Betaling benodig: geen betaling metode op lêer, onbetaalde fakture of 'n van die hand gewys kaart pre-authorisering
403 Voorgebodes: die teken is afwesig, ongeldig of het nie die benodigde toestemming nie. Gefaalde geldigheidsverklaring gee ook terug 403, nie 401 nie.
404 Nie gevind nie - Hulpbron bestaan nie
409 Konflik: Byvoorbeeld, die vordering is reeds verander, nie genoeg vermoë nie of'n ontplooiing wat reeds loop
429 Te veel versoeke - tempolimiet oorskry
500 Interne bedienerfout - Iets het aan ons kant verkeerd geloop
503 Diens Onbeskikbaar: 'n tydelike probleem. Herprobeer, eer weer- na wanneer dit gestuur word.

Fout liggame is JSON. Die meeste het 'n detail veld of' n fout veld, soms met 'n boodskap; geldige foute lys die probleme op die veld naam.

API-kategorieë

Blaai deur ons API-dokumentasie volgens kategorie:

Bedieners-API 15 Eindpunte

Skep, inspekteer, mag, hervergroot en uitvee bedieners, herstel die root wagwoord, stel omgekeerde Dns, hardloop opdragte, en bestuur SSH sleutels.

Bekyk Dokumentasie
Rugsteun-API 4 Eindpunte

Lys van die bediener rugsteun, begin 'n nuwe rugsteun, en herstel' n bediener van 'n rugsteun.

Bekyk Dokumentasie
Kiek API 4 Eindpunte

Neem 'n geobbelde kiek van' n bediener, lys hulle en uitvee hulle.

Bekyk Dokumentasie
Planne API 2 Eindpunte

Kry beskikbare VPS-planne en prysinligting op. Kry besonderhede oor hulpbronne, pryse en beskikbaarheid.

Bekyk Dokumentasie
Bedryfstelsels API 2 Eindpunte

Lys die bedryfstelsels en weergawes wat jy kan installeer, soos Ubuntu, Debian, Rocky Linux, CentOS Stroom, Fedraa en Alpyn.

Bekyk Dokumentasie
Domeine API 7 Eindpunte

Gaan beskikbaarheid, register en hernieu domeine na en stel naambedieners en outohernuweal.

Bekyk Dokumentasie
DNS API 13 Eindpunte

Skep DNS-nes en skep, dateer op en skrap hulle A, A, CNAME, MX, TXT, SRV, CAA en ander verslae.

Bekyk Dokumentasie
Liggings-API 2 Eindpunte

Lys die liggings beskikbaar vir bediener-uitgebruik.

Bekyk Dokumentasie
Rekening 1 Eindpunte

Onttrek rekening profiel en API-bewys informasie. Identifiseer wat rekening 'n teken behoort aan en bevestig die regte.

Bekyk Dokumentasie
Verstandelike gevolge 7 Eindpunte

Trek jou geffareerde balans, verwysings, kommissies en betalings in jou eie verslag, verander betaalingsinstellings en versoek vergoeding.

Bekyk Dokumentasie

Meer Endpunte

Die API het ook eindpunte vir app- ontplooiings (/api/v1/dply-constigs/ en /api/v1/dplooiings/). Hulle word nie beskryf op hierdie bladsye nog nie; die interaktiewe verwysingslys elke punt punt, gegenereer van die lewende API.

Maak oop die interaktiewe Api verwysing

Het jy hulp nodig?

Indien u vrae het of hulp benodig met die API, moet asseblief nie huiwer om ons te kontak nie: