VPS.org API ҳуҷҷат

Сар кардани кор

API-и VPS.org ба шумо имкон медиҳад, ки ҳама ҷанбаҳои инфрасохтори хостинги VPS-и худро, аз ҷумла серверҳо, доменҳо, сабтҳои DNS, нусхаҳои эҳтиётӣ ва аксҳои фаврӣ, ба таври барномавӣ идора кунед.

Тасдиқ

Ҳамаи дархостҳои API аутентификатсияро бо истифода аз токени Bearer талаб мекунанд. Шумо метавонед токени API-и худро аз танзимоти ҳисоби худ дар ин ҷо тавлид кунед. 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
• Ҳуҷҷатҳо: Ҳуҷҷатҳои пурра