VPS.org API

Dọkumenti

VPS.org API Dọkisìntị

Akwụkwọ REST API zuru oke maka ijikwa sava VPS, ngalaba, DNS, ndabere, na ihe ndị ọzọ.

URL Ntọala https://admin.vps.org/api/v1
Nyocha Ihe Nnyemaka Onye Na-ebu Ihe
Nsụgharị v1
_Nhazi JSON

Na-amalite

VPS.org API na-enye gị ohere ijikwa akụkụ niile nke akụrụngwa nnabata VPS gị n'usoro mmemme, gụnyere sava, ngalaba, ndekọ DNS, nkwado ndabere, na foto ndị ọzọ.

Nyocha

Arịrịọ API niile chọrọ nkwenye site na iji ihe akaebe Bearer. Ị nwere ike ịmepụta ihe nnọchianya API gị site na ntọala akaụntụ gị na 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);

Token ọbụla na-eburu ikikembanye ya, dịka ndịọrụ: ndesịta mọọbụ dns: *. Ntụziaka nke chọrọ ikikembanye nke token ahụ enweghị bụ a na-ewepụ ya na 403 na a required_permission field na-akpọ ikikembanye nke enweghị. Ikikere

Mmachi Ọkwa

Nhọrọ ndị achọpụtara na-echedo na 1000 n'ụbọchị kwa akaụntụ. Nhọrọ ndị achọpụtaraghị na-echedo na 100 n'ụbọchị kwa adreesị IP. Nhọrọ n'elu oghe ahụ na-enweta 429 na Retry-After heedì na-enye ọnụọgụgụ nke sekọnd iji kwụsị. Enweghị oghe ndị achọpụtara na-echedo na nzaghachi na-arụ ọrụ.

Nhazi

Ndesịta ebemkpoinịte na-eziga obíọ̀tụ̀ na-echekwa, nke ọzọ, nke ochie na nsonaazụ, ihenhọrọ 25 n'ihuakwụkwọ ọbụla. Kpụga ihuakwụkwọ ka ịkpụga n'etiti ihuakwụkwọ, mọọbụ hụ na URL nke ọzọ ruo mgbe ọ bụ null. Ndesịta sava na-anabatakwa page_size, ruo 100.

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

Njikwa Mmejọ

API ahụ na-eji koodu ọnọdụ HTTP ọkọlọtọ iji gosi ihe ịga nke ọma ma ọ bụ ọdịda:

Koodu Ọnọdụ Ndesịta ozi ndị ahụ
200 Ịga nke Ọma - Emechara arịrịọ nke ọma
201 Emepụtara - E mepụtara akụrụngwa nke ọma
400 Arịrịọ Na-adịghị Mma - Paịmenti na-ezighi ezi ma ọ bụ arịrịọ na-adịghị mma
202, 204 Ekwetara na n'ogbe (202), mọọbụ ehichapụ na enweghị ọbụna ọ̀dọ̀ nzaghachi (204)
402 Nkwụ ụgwọ chọrọ: enweghị ụzọ nkwụ ụgwọ na faịlụ, inweta na-akwụghị ụgwọ, mọọbụ ikikembanye kaadị ekwenyeghị
403 Enweghị ike: token ahụ enweghị, ọ bụghị nke ọma mọọbụ echeghị ya oge, mọọbụ enweghị ikike achọrọ. Nkwenye ekwenye na-akwụsịkwakwa na-eziga 403, ọ bụghị 401.
404 Achọtaghị - Akụrụngwa adịghị adị
409 Nchọgharị: dịka ọmụmaatụ, ọbụla ngbanwe ụhara na-aga n'ihu, enweghị ike igosi ihenhọrọ ahụ, mọọbụ nrụnye na-aga n'ihu
429 Arịrịọ Dị Oke - A gafere oke ọnụego
500 Nsogbu Sava Dị n'ime - Ihe adịghị mma na njedebe anyị
503 Nrụọrụ a na-enweghị ike: nsogbu oge ụfọdụ. N'ihi ya, rịọnụ́ọ̀tụ̀là, na-ewere n'obi Retry-After mgbe a na-eziga ya.

Ọbịbịa nke mmehie bụ JSON. Oge ụfọdụ ha nwere nkọwa mpaghara ebe mọọbụ mmehie mpaghara ebe, mgbe ụfọdụ na ozi; mmehie nkwenye na-egosi nsogbu site na aha mpaghara ebe.

Ngalaba API

Chọgharịa akwụkwọ API anyị site na otu:

API sava 15 Isi njedebe

Kewapụta, hụ, ike, megharịa nha na wepu sava, weghachite uruti okwuntughe, họrọ DNS n'okporo ụzọ, mepee iwu, na chịkwaa SSH kii.

Lee akwụkwọ
API ndabere 4 Isi njedebe

Ndesịta nke nchekwa ndị sava gị, malite nchekwa ọfụụ, nakwa weghachi sava site na nchekwa.

Lee akwụkwọ
Foto API 4 Isi njedebe

Kwụsị ịpịpụta ngwe nke sava, gosipụta ha na wepụ ha.

Lee akwụkwọ
API Atụmatụ 2 Isi njedebe

Nweta atụmatụ VPS na ozi ọnụahịa dị. Nweta nkọwa gbasara akụrụngwa, ọnụahịa, na nnweta.

Lee akwụkwọ
API Sistemụ Ọrụ 2 Isi njedebe

Ndepụta sistemụ ọrụ na ụdị ị ga-etinye, dịka Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora na Alpine.

Lee akwụkwọ
Domeenụ̀ API 7 Isi njedebe

Nleba anya na ọbụla, banye na gbanwee doomeins, na họrọ ahasaraị na gbanwee-n'onwe ya.

Lee akwụkwọ
DNS API 13 Isi njedebe

Kewapụta DNS mpagharaogologo na kewapụta, gbanwee na wepu A, A, CNAME, MX, TXT, SRV, CAA na ndị ọzọ ndekọ.

Lee akwụkwọ
API Ọnọdụ 2 Isi njedebe

Ndesịta ebe ndị dị na-adị maka nhazi sava.

Lee akwụkwọ
Akaụntụ 1 Isi njedebe

Weghachi profaịlụ akaụntụ na ozi token API. Mara onye akaụntụ token na-abịa na-enyocha ikike ya.

Lee akwụkwọ
Ndịna 7 Isi njedebe

Tinye akaụntụ gị, kọwaa, ntinye aka na ụgwọ ọrụ na ozi gị, gbanwee ntọala ụgwọ ọrụ na ajụjụ ụgwọ ọrụ.

Lee akwụkwọ

Ńkwádò ndị ọzọ

API nwerekwa ngwụcha-ọnụọgụgụ maka usoroiheomume nrụnye (/api/v1/deploy-configs/ na /api/v1/deployments/). Ha agaghị egosipụtara ha na ihuakwụkwọ ndị a; ndesịta nkwụsị-ọnụọgụgụ niile, ejiri site na ndụ API.

Mepee ndesịta ozi ndị ahụ

Ị chọrọ enyemaka?

Ọ bụrụ na ị nwere ajụjụ maọbụ chọọ enyemaka na API, biko egbula oge ịkpọtụrụ: