VPS.org API dokumentasyon

Pagsisimula

Ang VPS.org API ay nagbibigay-daan sa iyong pamahalaan sa pamamagitan ng programa ang lahat ng aspeto ng iyong imprastraktura ng VPS hosting, kabilang ang mga server, domain, DNS record, backup, at snapshot.

Pagpapatotoo

Ang lahat ng kahilingan sa API ay nangangailangan ng pagpapatotoo gamit ang Bearer token. Maaari mong buuin ang iyong API token mula sa mga setting ng iyong account sa 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);

Ang bawat token ay may sariling mga pahintulot, tulad ng servers:list o dns:*. Ang isang kahilingan na nangangailangan ng pahintulot na ang token ay hindi mayroon ay tinanggihan sa 403 at isang required_permission field na pinangalanan ang nawawalang pahintulot. Permissions Reference

Paglilimita sa Rate

Authenticated requests are limited to 1,000 per hour per account. Unauthenticated requests are limited to 100 per hour per IP address. A request over the limit receives 429 with a Retry-After header giving the number of seconds to wait. No rate limit headers are sent on successful responses.

Pag-pagina

Listahan endpoints bumalik ng isang bagay na may bilang, susunod, nakaraang at mga resulta, 25 mga item sa bawat pahina. Magpasa pahina upang ilipat sa pagitan ng mga pahina, o sundin ang susunod na URL hanggang sa ito ay null. Ang servers listahan din tinatanggap page_size, hanggang sa 100.

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

Paghawak ng Error

Gumagamit ang API ng mga karaniwang HTTP status code upang ipahiwatig ang tagumpay o kabiguan:

Kodigo ng Katayuan	Paglalarawan
`200`	Tagumpay - Matagumpay na natapos ang kahilingan
`201`	Nalikha - Matagumpay na nalikha ang mapagkukunan
`400`	Masamang Kahilingan - Hindi wastong mga parameter o maling anyo ng kahilingan
`202`, `204`	Tinanggap at naka-queue (202), o tinanggal na walang katawan ng tugon (204)
`402`	Pagbabayad na Kinakailangan: walang paraan ng pagbabayad sa file, hindi nababayaran invoice, o isang tinanggihan card pre-authorization
`403`	Forbidden: ang token ay nawawala, hindi wasto o expired, o kulang ang kinakailangang pahintulot. Failed authentication din bumalik 403, hindi 401.
`404`	Hindi Natagpuan - Walang mapagkukunan
`409`	Conflict: halimbawa ng isang resize na sa progreso, hindi sapat na kapasidad, o isang deployment na tumatakbo
`429`	Masyadong Maraming Kahilingan - Lumagpas na sa limitasyon ng rate
`500`	Error sa Internal Server - May nangyaring mali sa aming panig
`503`	Serbisyo Hindi magagamit: isang pansamantalang problema. Subukan muli, honouring Subukan muli-Pagkatapos kapag ito ay ipinadala.

Error katawan ay JSON. Karamihan ay may isang detalye field o isang error field, minsan na may isang mensahe; validation error listahan ng mga problema sa pamamagitan ng pangalan ng patlang.

Mga Kategorya ng API

Tingnan ang aming dokumentasyon ng API ayon sa kategorya:

API ng mga Server 15 Mga Endpoint

Lumikha, suriin, kapangyarihan, baguhin ang laki at tanggalin ang mga server, i-reset ang root password, itakda ang baligtad DNS, patakbuhin ang mga utos, at pamahalaan ang mga SSH key.

Tingnan ang Dokumentasyon

Mga Backup API 4 Mga Endpoint

Ilista ang iyong server backup, simulan ang isang bagong backup, at ibalik ang isang server mula sa isang backup.

Tingnan ang Dokumentasyon

Mga Snapshot API 4 Mga Endpoint

Kumuha ng naka-label na snapshots ng isang server, listahan ng mga ito at tanggalin ang mga ito.

Tingnan ang Dokumentasyon

API ng mga Plano 2 Mga Endpoint

Kunin ang mga available na plano ng VPS at impormasyon sa presyo. Kumuha ng mga detalye tungkol sa mga mapagkukunan, presyo, at availability.

Tingnan ang Dokumentasyon

API ng mga Operating System 2 Mga Endpoint

Ang mga operating system na ito ay kinabibilangan ng Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora at Alpine.

Tingnan ang Dokumentasyon

Mga Domain API 7 Mga Endpoint

Tingnan ang availability, mag-register at mag-renew ng domain, at magtakda ng nameservers at auto-renewal.

Tingnan ang Dokumentasyon

Mga DNS server 13 Mga Endpoint

Ang mga ito ay maaaring maging mga domain name, domain name extension, domain name extension, domain name extension, domain name extension, domain name extension, domain name extension, domain name extension, domain name extension, domain name extension.

Tingnan ang Dokumentasyon

API ng mga Lokasyon 2 Mga Endpoint

Ilista ang mga lokasyon na magagamit para sa server deployment.

Tingnan ang Dokumentasyon

Account 1 Mga Endpoint

Bumalik profile ng account at API token impormasyon. Kilalanin kung aling account isang token ay kabilang sa at suriin ang mga pahintulot nito.

Tingnan ang Dokumentasyon

Mga Affiliate 7 Mga Endpoint

I-drag ang iyong affiliate balanse, mga referral, komisyon at payout sa iyong sariling pag-uulat, baguhin ang mga setting ng payout at humingi ng payout.

Tingnan ang Dokumentasyon

Higit pang mga Endpoints

Ang API ay may mga endpoints din para sa mga deployment ng app (/api/v1/deploy-configs/ at /api/v1/deployments/). Hindi sila inilarawan sa mga pahinang ito pa; ang interactive na sanggunian ay naglalaman ng listahan ng bawat endpoint, na nabuo mula sa live na API.

Buksan ang interactive API reference

Kailangan mo ba ng tulong?

Kung mayroon kang mga katanungan o kailangan ng tulong sa API, huwag mag-atubiling makipag-ugnayan sa:

Mga Tiket ng Suporta: Magbukas ng tiket ng suporta
I-email: hello@vps.org
Dokumentasyon: Kumpletong Dokumentasyon