VPS.org API- dokumintaasje

Begjinne

Mei de VPS.org API kinne jo programmatysk alle aspekten fan jo VPS-hostingynfrastruktuer beheare, ynklusyf servers, domeinen, DNS-records, reservekopyen en snapshots.

Autentikaasje

Alle API-oanfragen fereaskje autentikaasje mei in Bearer-token. Jo kinne jo API-token generearje fanút jo akkountynstellingen op 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);

Elk token hat syn eigen tagongsrjochten, lykas servers:list of dns:*. In fersyk dat tagong fereasket dy't it token net hat, wurdt ôfwiisd mei 403 en in required_permission-fjild mei de namme fan de ûntbrekkende tagongsrjochten. Tagongsrjochten

Taryfbeheining

Ferifikaasjefersiken binne beheind ta 1000 per oere per akkount. Net- ferifikaasjefersiken binne beheind ta 100 per oere per IP- adres. In fersyk boppe de limyt krijt 429 mei in Retry- After- koptekst dy' t it oantal sekonden oanjout dat wachtsje moat. Der wurdt gjin snelheidsbegrinzingskoptekst ferstjoerd by slagge antwurden.

Paginaasje

Listeinpunten jouwe in objekt werom mei oantal, folgjend, foarige en resultaten, 25 items per side. Gean side troch om tusken siden te gean, of folgje it folgjende URL- adres oant it null is. De tsjinnerlist akseptearret ek page_ size, oant 100.

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

Foutbehanneling

De API brûkt standert HTTP-statuskoades om sukses of mislearring oan te jaan:

Statuskoade	Beskriuwing
`200`	Súkses - Oanfraach mei súkses foltôge
`201`	Oanmakke - Boarne mei súkses oanmakke
`400`	Minne oanfraach - Unjildige parameters of ferkeard foarme oanfraach
`202`, `204`	Akseptearre en yn de wachtrige set (202), of wiske sûnder antwurd (204)
`402`	Betaling fereaske: gjin betalingsmethode yn it triem, net- betelle faktueren, of in ôfwiisde kaart foarautorisaasje
`403`	Ferbean: it token ûntbrekt, is ûnjildich of ferrûn, of hat net de fereaske tagongsrjochten. As de ferifikaasje mislearre is, dan wurdt ek 403 weromjûn, net 401.
`404`	Net fûn - Boarne bestiet net
`409`	Konflikt: bygelyks in grutteferbettering is al yn beweging, net genôch kapasiteit, of in yndieling dy al rint
`429`	Tefolle oanfragen - Taryflimyt oerskreden
`500`	Ynterne serverflater - Der is wat misgien oan ús kant
`503`	Tsjinst net beskikber: in tydlik probleem. Besykje it opnij, mei Retry- After as it ferstjoerd wurdt.

Flatermeldingen binne JSON. De measte hawwe in detailfjild of in flaterfjild, soms mei in berjocht. By jildigensflaters wurde de problemen op fjildnamme werjûn.

API-kategoryen

Blêdzje troch ús API-dokumintaasje op kategory:

Tsjinners API 15 Einpunten

Makke, ynspektearje, power, feroarje de grutte en wiskje tsjinners, set it root wachtwurd werom, set reverse DNS yn, kommando's útfiere, en beheare SSH kaaien.

Dokumintaasje besjen

Reservekopyen API 4 Einpunten

Jou in list fan jo tsjinner back- ups, begjin in nije back- up, en herstel in tsjinner fan in back- up.

Dokumintaasje besjen

Snapshots API 4 Einpunten

Nim foto's mei in label fan in tsjinner, list se en wiskje se.

Dokumintaasje besjen

Plannen API 2 Einpunten

Helje beskikbere VPS-plannen en priisynformaasje op. Krij details oer boarnen, prizen en beskikberens.

Dokumintaasje besjen

Bestjoeringssystemen API 2 Einpunten

List de bestjoeringssystemen en ferzjes dy jo ynstallearje kinne, lykas Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora en Alpine.

Dokumintaasje besjen

Domeinen API 7 Einpunten

Kontrolearje beskikberens, registrearje en fernije domeinen, en set nammetsjinners en automatyske fernijing yn.

Dokumintaasje besjen

DNS API 13 Einpunten

DNS-zones oanmeitsje en har A-, A-, CNAME-, MX-, TXT-, SRV-, CAA- en oare records oanmeitsje, bywurkje en wiskje.

Dokumintaasje besjen

Lokaasjes API 2 Einpunten

De lokaasjes sjen litte dy beskikber binne foar it ynstallearjen fan de tsjinner.

Dokumintaasje besjen

Akkount 1 Einpunten

Haal akkountprofyl en API- tokenynformaasje op. Bepaal hokker akkount in token tahört en kontrolearje de tagongsrjochten.

Dokumintaasje besjen

Affiliates 7 Einpunten

De organisaasje hat in eigen bestjoer, in eigen bestjoersried, in eigen bestjoersriedslid en in eigen bestjoersriedslid.

Dokumintaasje besjen

Mear einpunten

De API hat ek einpunten foar app- útwreiding (/ api/ v1/ deploy- configs / en / api/ v1/ deployments /). Se binne noch net beskreaun op dizze siden; de ynteraktive referinsje lit elk einpunt sjen, oanmakke fan de live API.

De ynteraktive API-referinsje iepenje

Help nedich?

As jo fragen hawwe of help nedich binne mei de API, aarzel dan net om kontakt op te nimmen mei:

Stipekaartsjes: Iepenje in stipeticket
E-post: hello@vps.org
Dokumintaasje: Folsleine dokumintaasje