VPS.org API

REST API баримт бичиг

VPS.org API баримт бичиг

VPS сервер, домэйн, DNS, нөөцлөлт болон бусад зүйлсийг удирдахад зориулсан бүрэн REST API баримтжуулалт.

Үндсэн URL https://admin.vps.org/api/v1
Баталгаажуулалт Эзэмшигчийн Токен
Верс v1
Хуудасны хэлбэр JSON

Эхлэх

VPS.org API нь танд сервер, домэйн, DNS бичлэг, нөөцлөлт болон агшин зураг зэрэг VPS хостинг дэд бүтцийн бүх талыг програмын дагуу удирдах боломжийг олгодог.

Баталгаажуулалт

Бүх API хүсэлтүүд нь Bearer токен ашиглан баталгаажуулалт шаарддаг. Та өөрийн API токеныг бүртгэлийн тохиргооноос дараах хаягаар үүсгэж болно. 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);

Токен бүр өөрийн эрхийг агуулдаг, жишээ нь servers:list эсвэл dns:*. Токенд байхгүй эрх шаардсан хүсэлтийг 403-р утга болон шаардлагатай_ эрхийн талбарт байхгүй эрхийг зааж өгөх замаар цуцална. Хуулийн тайлбар

Үнийн хязгаарлалт

Аюулгүй байдлын шалгалт хийгдсэн хүсэлтүүд цаг тутамд 1000- аар хязгаарлагддаг. Аюулгүй байдлын шалгалт хийгдээгүй хүсэлтүүд IP хаяг бүрт цаг тутамд 100- ээр хязгаарлагддаг. Хязгаарлалтаас хэтэрсэн хүсэлтүүд 429- ийг хүлээх секундын тоог заасан дахин туршах- дараа гэсэн хавтсаар хүлээн авна. Сайн хариултуудад хурдны хязгаарлалтгүй хавтсыг илгээнэ.

Хуудасны тоо

Тоо, дараагийн, өмнөх, үр дүнтэй, 25 хуудасны нэг бүрийн объектыг буцаадаг. Хуудас хооронд шилжихэд хуудас руу шилж, эсвэл нуль хүртэл дараагийн URL- ийг дага. Серверийн жагсаалт нь page_ size- ийг 100 хүртэл хүлээн авдаг.

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

Алдаа зохицуулах

API нь амжилт эсвэл бүтэлгүйтлийг заахын тулд стандарт HTTP төлөвийн кодуудыг ашигладаг:

Статусын код Тодорхойлолт
200 Амжилттай - Хүсэлтийг амжилттай биелүүлэв
201 Үүсгэсэн - Нөөцийг амжилттай үүсгэсэн
400 Буруу хүсэлт - Буруу параметрүүд эсвэл буруу хэлбэртэй хүсэлт
202, 204 Accepted and queued (202), or deleted with no response body (204)
402 Төлбөр шаардагдана: төлбөрийн арга байхгүй, төлбөрөө төлөөгүй, эсвэл картын урьдчилсан зөвшөөрөл цуцлагдсан
403 Хязгаарлагдсан: Токен алга, хүчингүй, хугацаа нь дууссан, эсвэл шаардлагатай зөвшөөрөлгүй. Аюулгүй байдлын баталгаажуулалт бүтэлгүйтвэл 401 биш 403-ыг өгнө.
404 Олдсонгүй - Нөөц байхгүй байна
409 Зөвшилцөл: жишээ нь, хэмжээг өөрчлөх ажил явагдаж байна, хангалттай багтаамж байхгүй, эсвэл суурилуулалт явагдаж байна
429 Хэт олон хүсэлт - Хязгаар хэтэрсэн
500 Дотоод серверийн алдаа - Манай талд ямар нэгэн алдаа гарлаа
503 Үйлчилгээ байхгүй: түр зуурын асуудал. Дахин оролдох, илгээсэн үед дахин оролдох- дарааг нь хүндэтгэн үзэх.

Бусад алдаанууд нь JSON хэлбэртэй байдаг. Ихэнх нь дэлгэрэнгүй талбар эсвэл алдаа талбартай, заримдаа мэдээтэй байдаг. Шалгах алдаанууд нь талбарын нэрээр асуудалуудыг жагсаана.

API ангилалууд

Манай API баримт бичгийг ангиллаар нь үзэх:

Серверийн API 15 Төгсгөлийн цэгүүд

Серверүүдийг үүсгэх, шалгах, хүчдэл, хэмжээг өөрчлөх, устгах, root нууц үгийг сэргээх, эсрэг DNS-ийг тохируулах, командуудыг гүйцэтгэх, SSH түлхүүрүүдийг удирдах.

Баримт бичгийг харах
Нөөцлөлт API 4 Төгсгөлийн цэгүүд

Серверийнхээ нөөцлөлтийг жагсаах, шинэ нөөцлөлт эхлүүлэх, нөөцлөлтөөс серверийг сэргээх.

Баримт бичгийг харах
Агшин зургийн API 4 Төгсгөлийн цэгүүд

Серверийн нэртэй зураг авах, жагсааж устгах.

Баримт бичгийг харах
Төлөвлөгөөний API 2 Төгсгөлийн цэгүүд

Боломжтой VPS төлөвлөгөө болон үнийн мэдээллийг авах. Нөөц, үнэ болон бэлэн байдлын талаарх дэлгэрэнгүй мэдээллийг авах.

Баримт бичгийг харах
Үйлдлийн Системийн API 2 Төгсгөлийн цэгүүд

Та Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora болон Alpine-ийг суулгаж болох үйлдлийн систем болон хувилбаруудыг жагсаана.

Баримт бичгийг харах
Домен API 7 Төгсгөлийн цэгүүд

Домен нэрийг бүртгэж шинэчлэх, нэрийн сервер болон автомат шинэчлэлтийг тохируулах.

Баримт бичгийг харах
DNS API 13 Төгсгөлийн цэгүүд

DNS бүсүүдийг үүсгэж, тэдний A, A, CNAME, MX, TXT, SRV, CAA болон бусад бичлэгүүдийг үүсгэж, шинэчлэн устга.

Баримт бичгийг харах
Байршлын API 2 Төгсгөлийн цэгүүд

Серверийг байршуулах боломжтой газруудыг жагсаана.

Баримт бичгийг харах
Тоо бүртгэл 1 Төгсгөлийн цэгүүд

Тоон гарын үсгийн профайл болон API-ийн токен мэдээллийг авна. Токен нь ямар токенд хамаарахыг тодорхойлж, түүний эрхийг шалгана.

Баримт бичгийг харах
Холбоонууд 7 Төгсгөлийн цэгүүд

Таны холбоотнууд, зөвлөгөө, комисс, төлбөрийн балансыг өөрийн мэдээллийн санд оруулж, төлбөрийн тохиргоог өөрчлөх, төлбөрийн хүсэлт гаргах.

Баримт бичгийг харах

Бүр олон төгсгөлийн цэг

API нь програмын суурилуулалтын төгсгөлийн цэгүүдийг агуулдаг (/api/v1/deploy-configs/ ба /api/v1/deployments/). Эдгээр цэгүүдийг энэ хуудаснаас одоогоор тодорхойлсонгүй; интерактив холбоос нь бүх төгсгөлийн цэгүүдийг жагсаасан, эдгээр нь орчин үеийн API-аас үүсгэгдсэн.

Интерактив API-ийн холбоосыг нээх

Тусламж хэрэгтэй байна уу?

Хэрэв танд асуулт байвал эсвэл API-тай холбоотой тусламж хэрэгтэй бол дараах хаягаар холбогдоно уу: