VPS.org API Documentation

Farawa

VPS.org API yana ba ku damar sarrafa duk fannoni na kayan aikin VPS ɗinku ta hanyar shirye-shirye, gami da sabar, yankuna, bayanan DNS, madadin bayanai, da hotuna.

Tabbatarwa

Duk buƙatun API suna buƙatar tantancewa ta amfani da alamar Bearer. Kuna iya samar da alamar API ɗinku daga saitunan asusunku a 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);

Duk wani ɓoyayyen abu yana da izininsa na kansa, kamar servers:list ko dns:*. An ki karɓar wata bukata da ke buƙatar izinin da ɓoyayyen abu bai da shi da 403 da wani fanni na required_permission da ke ambaton izinin da ke faruwa. Mawallafi

Iyakance Ƙimar Kuɗi

An hana tambayoyin da aka tabbatar da zuwa 1,000 a kowace sa'a ga kowace asusun. An hana tambayoyin da ba a tabbatar da zuwa 100 a kowace sa'a ga kowace adireshin IP. Wani tambaya da ya wuce wannan iyaka zai karɓi 429 tare da wani Retry-After header da ke ba da adadin sakan da za'a jira. Baika da wani tsawo na tsawo ba kan amsa masu nasara.

Pagination

An sake komawa da wani abu da adadin, gaba, baya da sakamakon, abubuwa 25 a kowace fuska. Ka wuce fuska don motsa tsakanin fuskokin, ko ka bi URL na gaba har ya zama ba'a. Wannan jerin sarakuna kuma yana karɓar page_size, har zuwa 100.

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

Kula da Kuskure

API ɗin yana amfani da lambobin matsayin HTTP na yau da kullun don nuna nasara ko gazawa:

Lambar Matsayi	@ action
`200`	Nasara - An kammala buƙatar cikin nasara
`201`	An ƙirƙiri - An ƙirƙiri albarkatu cikin nasara
`400`	Buƙata mara kyau - Sigogi marasa inganci ko buƙatar da ba ta dace ba
`202`, `204`	An karɓa kuma an sanya shi cikin jerin gwano (202), ko an share shi ba tare da wani jikin amsa ba (204)
`402`	Payment Required: no payment method on file, unpaid invoices, or a declined card pre-authorization
`403`	An hana: tabbacin ya ɓace, ba daidai ba ne ko ya wuce lokaci, ko kuma bai da izinin da ake buƙata. An kasa tabbatarwa kuma yana mayar da 403, ba 401 ba.
`404`	Ba a Samu ba - Babu Albarkatu
`409`	Conflict: for example a resize already in progress, not enough capacity, or a deployment already running
`429`	Buƙatu da Yawa - An wuce iyakar farashi
`500`	Kuskuren Sabar Cikin Gida - Wani abu ya faru ba daidai ba a ɓangarenmu
`503`	Service Unavailable: a temporary problem. Try again, honoring Retry-After when it is sent.

JSON ne jikin kuskuren. Mafi yawansu suna da filin bayani ko filin kuskure, wasu lokuta tare da sakon; kuskuren tabbatarwa suna nuna matsalolin ta hanyar sunan filin.

Nau'o'in API

Bincika takardun API ɗinmu ta rukuni:

API ɗin sabar 15 Ƙarshen maki

Yi halitta, binciki, ƙarfi, canja girma da share masu waƙa, sake shigar da kalmar shiga na root, daidaita DNS mai juyawa, gudanar da umarni, da kula da maɓallan SSH.

Duba Takardu

API na Ajiyayyen Bayanai 4 Ƙarshen maki

Ka nuna jerin riƙe-riƙe na mai karɓa, fara riƙe-riƙe na sabon, da kuma mayar da mai karɓa daga riƙe-riƙe.

Duba Takardu

Hotunan API na Hotuna 4 Ƙarshen maki

Ka yi amfani da hotunan da aka yi wa lakabi na mai ba da sabis, ka lissafa su kuma ka share su.

Duba Takardu

API na Tsare-tsare 2 Ƙarshen maki

Dawo da tsare-tsaren VPS da bayanai kan farashi. Sami cikakkun bayanai game da albarkatu, farashi, da kuma samuwa.

Duba Takardu

API na Tsarin Aiki 2 Ƙarshen maki

Ka yi jerin tsarin aiki da nau'ukan da zaka iya shigarwa, kamar Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora da Alpine.

Duba Takardu

QDialogButtonBox 7 Ƙarshen maki

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

Duba Takardu

API na DNS 13 Ƙarshen maki

Create DNS zones and create, update and delete their A, A, CNAME, MX, TXT, SRV, CAA and other records.

Duba Takardu

API ɗin Wurare 2 Ƙarshen maki

Ka lissafa wuraren da suke da amfani ga shigar da mai ba da sabis.

Duba Takardu

Asusun 1 Ƙarshen maki

Ka karɓi bayanin siffar asusu da API token. Ka gane wane asusu ne token yake da shi kuma ka duba izininsa.

Duba Takardu

Affiliates 7 Ƙarshen maki

Ƙara da kuma share fayiloli daga wannan kwamfuta.

Duba Takardu

More Endpoints

API kuma yana da maɓallin ƙarshe don shigar da shirin ayuka (/api/v1/deploy-configs/ da /api/v1/deployments/). Ba'a bayyana su a cikin waɗannan shafuka ba har yanzu; maɓallin alaƙa na nuna jerin duk maɓallin ƙarshe, wanda aka samo daga mai rai API.

Buɗe maɓallin API mai taɓawa

Kuna buƙatar taimako?

Idan kuna da tambayoyi ko kuna buƙatar taimako game da API, da fatan za ku iya tuntuɓar mu:

Tikitin Tallafi: Buɗe tikitin tallafi
Imel: hello@vps.org
@ action Cikakken Takardu