VPS.org API

REST API Documentation

VPS.org API Documentation

Zadza magwaro eREST API ekutarisira maseva eVPS, madomeni, DNS, mabackups, nezvimwe.

URL Yekutanga https://admin.vps.org/api/v1
Kusimbiswa Chiratidzo Chemutakuri
Version v1
_Forma JSON

Kutanga

VPS.org API inokutendera kuti ugone kuronga zvese zviri muVPS hosting infrastructure yako, kusanganisira maseva, madomain, maDNS records, backups, uye snapshots.

Kusimbiswa

Zvikumbiro zvese zveAPI zvinoda kusimbiswa uchishandisa Bearer token. Unogona kugadzira API token yako kubva kumagadzirirwo eakaundi yako pa 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);

Each token carries its own permissions, such as servers:list or dns:*. A request that needs a permission the token does not have is refused with 403 and a required_permission field naming the missing permission. Permissions Reference

Kuganhurira Mutengo

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.

Kuisa peji

List endpoints regai chigadzirwa ne count, next, previous uye results, 25 zvinhu papeji. Pass peji kuti kuchinja pakati pezvinyorwa, kana kutevera inotevera URL kusvika ichiri null. The servers list also accepts page_size, up to 100.

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

Kugadzirisa Zvikanganiso

API inoshandisa makodhi eHTTP status akajairika kuratidza kubudirira kana kukundikana:

Kodhi yeChinzvimbo Kutaura
200 Kubudirira - Chikumbiro chapedzwa zvakanaka
201 Yakagadzirwa - Chishandiso chakagadzirwa zvinobudirira
400 Chikumbiro Chisina Kunaka - Maparamita asina kunaka kana chikumbiro chisina kunaka
202, 204 Akagamuchira uye akaisa mubhokisi rezvinyorwa (202), kana akabvisa pasina mashoko emashoko (204)
402 Kubhadhara Kunodiwa: hapana nzira yekubhadhara yakanyorwa, invoices dzisina kubhadharwa, kana kukanganwa kwechikwereti chekubhadhara
403 Akarambidzwa: the token is missing, invalid or expired, or lacks the required permission. Failed authentication also returns 403, not 401.
404 Hazviwanikwe - Chiwanikwa hachipo
409 Kusangana: semuenzaniso, kuchinja kwechiyero kwatanga, hapana simba rakakwana, kana kugoverwa kwatanga kushanda
429 Zvikumbiro Zvakawanda - Muganho wemutero wadarika
500 Chikanganiso Chemukati CheSevha - Pane chakakanganisika parutivi rwedu
503 Service Unavailable: a temporary problem. Retry, honouring Retry-After when it is sent.

Kukanganisa mabhodhi ari JSON. Vazhinji vane ruzivo field kana matambudziko field, nguva dzose ne message; kuongorora matambudziko anonyora nyaya nezita remunda.

Zvikamu zveAPI

Tarisa magwaro edu eAPI nechikamu:

API yeMasevha 15 Magumo

Create, kuongorora, simba, kuchinja saizi uye kubvisa servers, rega root password, set reverse DNS, kuenderera mberi nemazvo, uye kuchengetedza SSH mabhureki.

Ona Zvinyorwa
API yeBackups 4 Magumo

List yako server backups, kutanga nyowani backup, uye kudzoreredza server kubva backup.

Ona Zvinyorwa
API yeSnapshots 4 Magumo

Take labelled snapshots of a server, list them and delete them.

Ona Zvinyorwa
Purogiramu yeMapurani 2 Magumo

Tsvaga zvirongwa zveVPS zviripo uye ruzivo rwemitengo. Wana ruzivo nezvezviwanikwa, mitengo, uye kuwanikwa.

Ona Zvinyorwa
API yeMasisitimu Ekushanda 2 Magumo

Kuisa zvinyorwa zvemasystem ekushandisa uye zvinyorwa zvaunogona kuisa, senge Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora uye Alpine.

Ona Zvinyorwa
Mazita ezita 7 Magumo

Check availability, register and renew domains, and set nameservers and auto-renewal.

Ona Zvinyorwa
DNS API 13 Magumo

Create DNS nzvimbo uye kugadzira, kuvandudzwa uye kubvisa yavo A, A, CNAME, MX, TXT, SRV, CAA uye zvimwe zvinyorwa.

Ona Zvinyorwa
API yeNzvimbo 2 Magumo

List nzvimbo dzinowanikwa kune server kugoverwa.

Ona Zvinyorwa
Akaunti 1 Magumo

Kuwana account profile uye API token ruzivo. Kuziva account kuti token inobva uye tarisa zvibvumidzo zvayo.

Ona Zvinyorwa
Zvimwe zvinyorwa 7 Magumo

Kutambanudza yako affiliate mari, kukurudzira, zvikwereti uye payouts mu yako pachako kuzivisa, chinja payout settings uye kukumbira payouts.

Ona Zvinyorwa

Zvimwe

API zvakare ine endpoints yeapp kugoverwa (/api/v1/deploy-configs/ uye /api/v1/deployments/). Vasingazivikanwe pazvinyorwa izvi; interaction reference inonyora ese endpoints, yakagadzirwa kubva kune yakasununguka API.

Open the interactive API reference

Unoda Rubatsiro Here?

Kana muine mibvunzo kana kuti muchida rubatsiro neAPI, musazeza kutaura ne: