VPS.org API დოკუმენტაციაName

დაწყება

VPS.org API საშუალებას გაძლევთ პროგრამულად მართოთ თქვენი 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
• დოკუმენტაცია: სრული დოკუმენტაცია