VPS.org API

API- документација

VPS.org API документација

Комплетна документација за REST API за управување со VPS сервери, домени, DNS, резервни копии и друго.

Основна URL-адреса https://admin.vps.org/api/v1
Автентикација Носителски токен
Верзија v1
Формат JSON

Започнување

API-то на VPS.org ви овозможува програмски да управувате со сите аспекти на вашата VPS хостинг инфраструктура, вклучувајќи сервери, домени, DNS записи, резервни копии и снимки од екранот.

Автентикација

Сите API барања бараат автентикација со користење на токен за носител. Можете да го генерирате вашиот 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);

Секој жетон има свои дозволи, како сервери:list или dns:*. Барањето на кое му треба дозвола на жетонот не е одбиено со 403 и барано_ за почитување на полето кое го наведува недостасувачката дозвола. Референца за дозволи

Ограничување на стапката

Автентифицираните барања се ограничени на 1.000 на час на сметка. Неаутентификуваните барања се ограничени на 100 на час на IP адреса. Барањето над границата добива 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 Прифатено и поставено во редица (202), или избришано без тело за одговор (204)
402 Потребна е плата: нема метод на плаќање на датотеката, неплатени фактури или откажана пред-авторизација на картичката
403 Забрането: недостига жетонот, невалиден или истече или му недостига потребната дозвола. Неуспешна автентичност исто така го враќа 403, не 401.
404 Не е пронајдено - Ресурсот не постои
409 Конфликт: на пример, промена на големината веќе е во тек, недостаток на капацитет или веќе работи распоредување
429 Премногу барања - надминато е ограничувањето на брзината
500 Внатрешна грешка на серверот - Нешто тргна наопаку од нашата страна
503 Сервисот не е достапен: привремен проблем. Повторно се повторува, оддавајќи чест на повторувањето- по испраќањето.

Телата на грешки се JSON. Повеќето имаат поле за детали или поле за грешка, понекогаш со порака; овластувањето ги наведува проблемите по име на полето.

API категории

Прегледајте ја нашата API документација по категорија:

API за сервери 15 Крајни точки

Креирајте, проверете, променете, измените и избришете сервери, ресетирајте ја кореновата лозинка, поставете ја обратната 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/deplop- configs/ и /api/v1/deplayments /). Тие сé уште не се опишани на овие страници; интерактивната референтна листа на секој крајен крај, генериран од живото API.

Отвори ја референца за интерактивни API

Ви треба помош?

Доколку имате прашања или ви е потребна помош со API-то, слободно контактирајте не: