VPS.org API skjölun

Að byrja

VPS.org API gerir þér kleift að stjórna öllum þáttum VPS hýsingarinnviða þinna forritunarlega, þar á meðal netþjónum, lénum, DNS-færslum, afritum og skyndimyndum.

Auðkenning

Allar API beiðnir krefjast auðkenningar með Bearer tákni. Þú getur búið til API táknið þitt úr reikningsstillingunum þínum á 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);

Hvert tákn ber sínar eigin heimildir, svo sem servers:list eða dns:* Beiðni sem þarfnast heimildar sem táknið hefur ekki er hafnað með 403 og required_permission reit sem nefnist vantar heimild. Heimildatilvísun

Takmörkun hraða

Auðkenndar beiðnir eru takmarkaðar við 1000 á klukkustund fyrir hvern aðgang. Óauðkenndar beiðnir eru takmarkaðar við 100 á klukkustund fyrir hverja IP- tölu. Beiðni sem fer yfir mörkin fær 429 með hausnum Retry- After sem gefur upp fjölda sekúndna sem þarf að bíða. Engir hausar um hraðatakmörk eru sendir við vel heppnaðar svör.

Síðuskipting

Listi endapunkta skilar hlut með fjölda, næsta, fyrri og niðurstöður, 25 atriði á síðu. Skipta síðu til að fara á milli blaðsíðna, eða fylgja næstu slóð þar til það er núll. Þjónalistann samþykkir einnig page_size, allt að 100.

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

Villumeðhöndlun

API notar staðlaða HTTP stöðukóða til að gefa til kynna árangur eða mistök:

Stöðukóði	Lýsing
`200`	Tókst - Beiðni lokið með góðum árangri
`201`	Búið til - Auðlind búin til
`400`	Ógild beiðni - Ógildar breytur eða gallaða beiðni
`202`, `204`	Samþykkt og sett í biðröð (202), eða eytt án svarhluta (204)
`402`	Greiðsla krafist: engin greiðslumáti í skrá, ógreiddar reikningar eða hafnað fyrirfram heimild korts
`403`	Bannað: táknið vantar, er ógilt eða útrunnið, eða það hefur ekki nauðsynlegar heimildir. Mistókst auðkenning skilar einnig 403, ekki 401.
`404`	Ekki fundið - Auðlindin er ekki til staðar
`409`	Átök: til dæmis er stærðarbreyting þegar í gangi, ekki nóg pláss eða dreifing er þegar í gangi
`429`	Of margar beiðnir - Færslumörkum náð
`500`	Innri villa á netþjóni - Eitthvað fór úrskeiðis hjá okkur
`503`	Þjónusta ófáanleg: tímabundið vandamál. Reyndu aftur, virða Retry-After þegar það er sent.

Flestir hafa smáatriða reit eða villu reit, stundum með skilaboðum; staðfestingar villur lista vandamál eftir nafni reitsins.

API flokkar

Skoðaðu API skjölun okkar eftir flokkum:

Netþjónaskil 15 Endapunktar

Búa til, skoða, máttur, breyta stærð og eyða netþjónum, endurstilla rótarlykilorðið, stilla afturábak DNS, keyra skipanir og stjórna SSH lyklum.

Skoða skjöl

Afritunarforritaskil 4 Endapunktar

Listi yfir öryggisafrit af netþjónum þínum, hefja nýtt öryggisafrit og endurheimta netþjón úr öryggisafrit.

Skoða skjöl

Myndatökuforritaskil 4 Endapunktar

Taktu merktar skyndimyndir af netþjóni, skráðu þær og eyðileggja þær.

Skoða skjöl

Áætlunarforritaskil 2 Endapunktar

Sækja upplýsingar um tiltækar VPS áætlanir og verð. Fáðu upplýsingar um úrræði, verðlagningu og framboð.

Skoða skjöl

Stýrikerfis-API 2 Endapunktar

Listi yfir stýrikerfi og útgáfur sem þú getur sett upp, svo sem Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora og Alpine.

Skoða skjöl

Domains API 7 Endapunktar

Athugaðu framboð, skráðu og endurnýja lén og stilltu nafnþjóna og sjálfvirka endurnýjun.

Skoða skjöl

DNS API 13 Endapunktar

Búa til DNS svæði og búa til, uppfæra og eyða A, A, CNAME, MX, TXT, SRV, CAA og aðrar skrár.

Skoða skjöl

Staðsetningarforritaskil 2 Endapunktar

Listi yfir staðsetningar sem eru í boði fyrir miðlara dreifingu.

Skoða skjöl

Tenging 1 Endapunktar

Sækja reikningssnið og API táknupplýsingar. Auðkenna hvaða reikning tákn tilheyrir og athuga heimildir þess.

Skoða skjöl

Samstarfsaðilar 7 Endapunktar

Dragðu hlutdeildarfélagsjöfnuðinn þinn, tilvísanir, þóknun og útborganir í eigin skýrslugerð, breyttu útborgunarstillingum og beiðni um útborganir.

Skoða skjöl

Fleiri endapunktar

API-ið hefur einnig endapunkta fyrir app-útfærslur (/api/v1/deploy-configs/ og /api/v1/deployments/) sem ekki er lýst á þessum síðum ennþá; gagnvirka tilvísunin skráir hvern endapunkt, sem myndast úr lifandi API.

Opna gagnvirka API tilvísun

Þarftu hjálp?

Ef þú hefur spurningar eða þarft aðstoð með API-ið, þá skaltu ekki hika við að hafa samband:

Stuðningsmiðar: Opna stuðningsmiða
Netfang: hello@vps.org
Skjölun: Full skjölun