VPS.org API փաստաթղթավորում

Սկսել

VPS.org API-ը թույլ է տալիս ծրագրային կերպով կառավարել ձեր VPS հոսթինգի ենթակառուցվածքի բոլոր ասպեկտները, ներառյալ սերվերները, դոմեյնները, DNS գրառումները, պահուստային պատճենները և snapshots-ները։

Նույնականացում

Բոլոր API հարցումները պահանջում են նույնականացում Bearer token-ի միջոցով: Դուք կարող եք ստեղծել ձեր API token-ը ձեր հաշվի կարգավորումներից՝ admin.vps.org/account/developers/.

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);

Յուրաքանչյուր տոկենը իր սեփական իրավունքներն ունի, ինչպիսիք են servers:list կամ dns:*։ Պահանջը, որը պահանջում է թույլտվություն, որը տոկենը չունի, մերժվում է 403-ով և required_permission դաշտով, որը անվանում է բացակայող թույլտվությունը։ Հղում իրավունքների մասին

Գնահատման սահմանափակում

Ավտոմատացված խնդրանքները սահմանափակված են 1000-ով ժամը մեկ հաշվի համար։ Ավտոմատացված չէ պահանջները սահմանափակված են 100-ով ժամը մեկ IP հասցեի համար։ Առաջարկը սահմանափակված է 429-ով Retry-After գլխարկով, որը տալիս է սպասելու վայրկյանների քանակը։ Հաջող պատասխանների դեպքում չկա արագության սահմանափակում։

էջ

Ցուցակի վերջնական կետերը վերադարձնում են օբյեկտ՝ հաշվարկով, հաջորդ, նախորդ և արդյունքներով, 25 տարր յուրաքանչյուր էջում։ Էջը անցկացնել էջերի միջև շարժվելու համար, կամ հետևել հաջորդ URL- ին մինչև այն չեղյալ դառնա։ Սերվերների ցանկը նաև ընդունում է page_size, մինչև 100։

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

Սխալների մշակում

API-ն օգտագործում է HTTP ստանդարտ կարգավիճակի կոդեր՝ հաջողությունը կամ ձախողումը նշելու համար.

Սխալների մարմինները JSON են։ Ամենաշատը ունեն մանրամասն ոլորտ կամ սխալ ոլորտ, երբեմն էլ հաղորդագրություն։ Վստահեցման սխալները ցուցադրում են խնդիրները ոլորտի անունով։

API կատեգորիաներ

Զննեք մեր API փաստաթղթերը ըստ կատեգորիայի՝

Ավելի շատ վերջնական կետեր

API-ն նաև ունի վերջնական կետերի ցուցակ ծրագրի տեղադրման համար (/api/v1/deploy-configs/ և /api/v1/deployments/)։ Նրանք դեռևս չեն նկարագրվել այս էջերում։ Ինտերակտիվ հղումը ցուցակում է յուրաքանչյուր վերջնական կետ, որը գեներացվել է կենդանի API-ից։

Օգնություն պե՞տք է։

Եթե ունեք հարցեր կամ օգնության կարիք ունեք API-ի հետ կապված, խնդրում ենք մի հապաղեք կապվել մեզ հետ՝

• Աջակցության տոմսեր՝ Բացեք աջակցության տոմս
• Էլ․ հասցե՝ hello@vps.org
• Փաստաթղթավորում Լրիվ փաստաթղթեր