VPS.org API Documentation

Kuanza

API ya VPS.org hukuruhusu kudhibiti kiprogramu vipengele vyote vya miundombinu yako ya upangishaji wa VPS, ikiwa ni pamoja na seva, vikoa, rekodi za DNS, nakala rudufu, na picha.

Uthibitishaji

Maombi yote ya API yanahitaji uthibitishaji kwa kutumia tokeni ya Mbebaji. Unaweza kutoa tokeni yako ya API kutoka kwa mipangilio ya akaunti yako katika 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);

Kila ishara inajibebea kibali chake, kama vile watoaji: orodha ya bidhaa au kaya:*. Ombi ambalo linahitaji ruhusa haliruhusiwi kwa mwaka 403 na uwanja wa huduma wa lazima wa kutokupokea ruhusa kwa sababu ya kukosa. Ruhusa Yatumika

Kikomo cha Viwango

Maombi ya kweli ni ya mara 1,000 kwa saa. Maombi yasiyokubaliwa yanabaki 100 kwa saa kwa kila anwani ya IP. Ombi kwa kipindi cha mwisho hupokea 429 kwa mujibu wa Retry-Baada ya kutoa hesabu ya sekunde ili kungoja.

Kugeuzwa

Orodha ya habari zinarudisha kitu chenye hesabu, halafu, matokeo ya awali na matokeo, vitu 25 kwa kila ukurasa. [1a] Ukurasa wass to foose to ouRL, au kufuata URU ifuatayo mpaka ikoseshwe. Orodha ya wahudumiaji pia hukubali ukurasa_size, kufikia 100.

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

Kushughulikia Hitilafu

API hutumia misimbo ya kawaida ya hali ya HTTP kuonyesha mafanikio au kutofaulu:

Nambari ya Hali	Maelezo
`200`	Imefanikiwa - Ombi limekamilika kwa mafanikio
`201`	Imeundwa - Rasilimali imeundwa kwa mafanikio
`400`	Ombi Batili - Vigezo batili au ombi lenye hitilafu
`202`, `204`	Alikubaliwa na kupigiwa foleni (202, au kufuta bila kuitikia mwili (204)
`402`	Malipo Yahitajiwa: hakuna njia ya malipo kwenye faili, noti za bei ya juu, au karatasi iliyokatwa
`403`	Forbidden: the token is missing, invalid or expired, or lacks the required permission. Failed authentication also returns 403, not 401.
`404`	Haipatikani - Rasilimali haipo
`409`	Mgogoro: Kwa mfano, tayari kuna mpango wa kurekebisha hali, si uwezo wa kutosha, au utaratibu ambao tayari unaendelea
`429`	Maombi Mengi Sana - Kiwango cha juu kimezidi
`500`	Hitilafu ya Ndani ya Seva - Kuna kitu kilienda vibaya upande wetu
`503`	Utumishi Usioweza Kuzuilika: tatizo la muda tu.

Error bodies are JSON. Most have a detail field or an error field, sometimes with a message; validation errors list the problems by field name.

Aina za API

Vinjari hati zetu za API kwa kategoria:

API ya Seva 15 Sehemu za Mwisho

Create, chunguza, udhibiti, rekebisha na kufuta vihifadhi, weka upya neno la siri la msingi, weka nyuma DNS, ongoza amri, na udhibiti funguo za SSH.

Tazama Nyaraka

API ya Hifadhi Rudufu 4 Sehemu za Mwisho

Orodhesha mhudumu wako, anzisha mgongo mpya, na kurudisha msaidizi kutoka kwenye mgongo.

Tazama Nyaraka

API ya Vijipicha 4 Sehemu za Mwisho

Iandike picha za mfanyakazi, uziandike na uziondoe.

Tazama Nyaraka

API ya Mipango 2 Sehemu za Mwisho

Pata mipango ya VPS inayopatikana na taarifa za bei. Pata maelezo kuhusu rasilimali, bei, na upatikanaji.

Tazama Nyaraka

API ya Mifumo ya Uendeshaji 2 Sehemu za Mwisho

Orodhesha mifumo na tafsiri za uendeshaji unazoweza kuweka, kama vile Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora na Alpine.

Tazama Nyaraka

Domains API 7 Sehemu za Mwisho

Chunguza kupatikana, kujiandikisha na kutumiwa tena, na kuweka majina ya watu waliohifadhiwa na walio na magari mapya.

Tazama Nyaraka

DNS API 13 Sehemu za Mwisho

Fanya mipango ya kutengeneza na kutengeneza maeneo mapya, kisha ufute habari za A, AAA, CNME, MX, MSTA, SRV, CAA na rekodi nyinginezo.

Tazama Nyaraka

API ya Maeneo 2 Sehemu za Mwisho

Orodhesha mahali ambapo wanajeshi wanaweza kutumwa.

Tazama Nyaraka

Simulizi 1 Sehemu za Mwisho

Toa muhtasari wa akaunti na API ople news. Tambua ni alama gani ya akaunti ni ya na kuangalia ruhusa zake.

Tazama Nyaraka

Affasi 7 Sehemu za Mwisho

Chunguza usawaziko wako, masharti, na vifaa unavyotoa na ulipie ripoti zako, badili wakati na uombe malipo.

Tazama Nyaraka

Mambo Zaidi ya Kutimizwa

AnuI pia imeweka bayana kwa ajili ya programu za maombi (/api/v1/deploy-configs/ na /api/v1/vloyments/). Hawafasishwi kwenye kurasa hizi bado; orodha ya marejezo yanayohusisha mambo yote, inayotokana na MSI.

Fungua rejezo la ANI linalohusisha mazungumzo

Unahitaji Msaada?

Ikiwa una maswali au unahitaji usaidizi kuhusu API, tafadhali usisite kuwasiliana na:

Tikiti za Usaidizi: Fungua tiketi ya usaidizi
Barua pepe: hello@vps.org
Hati: Nyaraka Kamili