VPS.org API

Dokumentimi i API REST

Domain API

Kërko për emra domenash në dispozicion, rregjistro dhe rinovojë domenet, dhe menaxhoje serverat e emrave të tyre dhe rinovimin automatik. Domenet identifikohen nga uuid e tyre.

Pikat fundore 7
Shtegu Bazë /api/v1/domains
MERR /api/v1/domains/

Listo të gjitha domenet

Kthen domenet e regjistruara në llogarinë tuaj, 25 për faqe. Lista nuk ka filtra.

Të drejta të nevojshme: domains:list

Shembull Kërkese

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/domains/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/domains/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for domain in response.json()["results"]:
    print(domain["domain_name"], domain["status"], domain["expiration_date"])
const response = await fetch('https://admin.vps.org/api/v1/domains/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

Shembull Përgjigjeje

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
      "domain_name": "example.com",
      "status": "active",
      "registrar": "dynadot",
      "registration_date": "2026-01-15T10:30:00Z",
      "expiration_date": "2027-01-15T10:30:00Z",
      "days_until_expiration": 122,
      "is_expired": false,
      "needs_renewal_soon": false,
      "auto_renew": true,
      "renewal_period_years": 1,
      "registration_price": "12.64",
      "renewal_price": "12.64",
      "whois_privacy": true,
      "nameserver1": "ns1.vps.org",
      "nameserver2": "ns2.vps.org",
      "nameserver3": "ns3.vps.org",
      "nameserver4": null,
      "transfer_lock": true,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-09-01T08:12:40Z"
    }
  ]
}

Fushat e Përgjigjes

Fusha Lloji Përshkrimi
uuid string Identifikuesi i domain përdorur në endpoints e tjera të domain
status string active, pending, expired, cancelled, transferred
registrar string Registrar domain është mbajtur në
registration_date, expiration_date datetime Kur është regjistruar domeni dhe kur skadohet. expiration_date mund të jetë null.
days_until_expiration integer | null Ditë të plota deri në date_expiration, negative kur të skadojë
is_expired, needs_renewal_soon boolean Nëse domeini ka skaduar dhe në qoftë se skadohet brenda 30 ditëve të ardhshme
auto_renew, renewal_period_years boolean, integer Nëse domen rifreskohet automatikisht dhe për sa vjet
registration_price, renewal_price string Çmimet në USD si stringa decimale
whois_privacy, transfer_lock boolean Rregullimet e transferimit të bllokos
nameserver1 to nameserver4 string | null Serverët e emrave të domain
created_at, updated_at datetime Kur është krijuar regjistri dhe është ndryshuar për herë të fundit (ISO 8601, UTC)
MERR /api/v1/domains/{uuid}/

Merr hollësitë e domain

Kthen një objekt domeni me fushat e mësipërme.

Të drejta të nevojshme: domains:list

curl -X GET "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Kodet e Statusit të Përgjigjes

200 Suksesi
404 Nuk u gjet ose i përket një llogarie tjetër
POST /api/v1/domains/search/

Kërko në dispozicion

Kontrollon nëse një emër është në dispozicion në rreth 20 zgjatje të njohura (com, net, org, io, dev, co, app, ai dhe më shumë), plus zgjatjen që keni shkruar nëse nuk është midis tyre. Rezultatet fillojnë me përputhje të saktë, pastaj emrat në dispozicion, pastaj emrat e marrë.

Të drejta të nevojshme: domains:search

Parametrat e Trupit të Kërkesës

Parametrat Lloji E detyrueshme Përshkrimi
domain string Po Një emër me apo pa zgjatim, për shembull mysite ose mysite.com (2 deri në 63 karaktere)

Shembull Kërkese

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/domains/search/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "mysite.com"}'
import requests

url = "https://admin.vps.org/api/v1/domains/search/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.post(url, headers=headers, json={"domain": "mysite.com"})
for result in response.json()["results"]:
    if result["available"]:
        print(result["domain"], result["registration_price"], result["renewal_price"])

Shembull Përgjigjeje

{
  "results": [
    {
      "domain": "mysite.com",
      "available": false,
      "price": null,
      "registration_price": null,
      "renewal_price": null,
      "tld": "com",
      "is_exact_match": true
    },
    {
      "domain": "mysite.dev",
      "available": true,
      "price": 17.24,
      "registration_price": 17.24,
      "renewal_price": 17.24,
      "tld": "dev",
      "is_exact_match": false
    }
  ],
  "base_domain": "mysite",
  "search_count": 20
}

Çmimet janë numra në dollarë për një vit dhe janë zero për emrat që nuk janë në dispozicion. Çmimet e shfaqura janë ilustruese.

Kodet e Statusit të Përgjigjes

200 Suksesi
400 Mungon domeini, ose përmban gërma të tjera përveç shkronjave, shifrave dhe vijave
500 Kërkimi i regjistrit dështoi. Përpiqu përsëri më vonë.
POST /api/v1/domains/register/

Regjistro Domen të Ri

Regjistro një domen dhe ngarko metodën e ruajtur të pagesës. Disponibiliteti dhe çmimi kontrollohen me regjistrin përsëri para ngarkimit. Detajet e kontaktit të rregjistruesve marren nga profili i llogarisë suaj. Nëse regjistër refuzon regjistrimin pas ngarkimit, pagesa kthehet.

Të drejta të nevojshme: domains:register (i dhënë nga domenet:*)

Parametrat e Trupit të Kërkesës

Parametrat Lloji E detyrueshme Përshkrimi
domain string Po Emri i plotë i domain duke përfshirë zgjatjen e tij, për shembull example.com
years integer Jo. Periudha e regjistrimit, 1 deri 10 (e prezgjedhur 1). Çmimi është çmimi vjetor herë vite..ai kërkon së paku 2 vjet; një vlerë më e vogël kthen 400. 
curl -X POST "https://admin.vps.org/api/v1/domains/register/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "mysite.dev", "years": 1}'

Shembull Përgjigjeje

{
  "success": true,
  "domain_uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
  "domain_name": "mysite.dev",
  "message": "mysite.dev registered successfully!"
}

Kodet e Statusit të Përgjigjes

201 Domain e regjistruar
400 Domain i pavlefshëm, domain nuk është më në dispozicion, çmimi nuk mund të verifikohet, metoda e vjetër e pagesës, apo pagesa dështoi
402 Asnjë metodë pagese në file, apo faturat e papaguara
500 Pagimi nuk mund të përpunohet, ose registrari e ka refuzuar regjistrimin pas pagimit. Në rastin e dytë, mesazhi i gabimit tregon nëse kthimi është kryer.
POST /api/v1/domains/{uuid}/renew/

Rifresko një Domain

Rinovojë domenin dhe ngarkon çmimin e rinovimit për çdo vit me metodën e ruajtur të pagesës.

Të drejta të nevojshme: domains:renew

Parametrat e Trupit të Kërkesës

Parametrat Lloji E detyrueshme Përshkrimi
years integer Jo. Vitet për t'u shtuar, 1 deri 10 (e paracaktuar 1) 
curl -X POST "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/renew/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"years": 1}'
{
  "success": true,
  "domain_uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
  "new_expiration": "2028-01-15T10:30:00+00:00",
  "message": "example.com renewed successfully for 1 year(s)!"
}

Kodet e Statusit të Përgjigjes

200 Domain rifreskuar
400 Vite të pavlefshme, asnjë çmim rinovimi për domenin, asnjë metodë e përdorshme pagese, apo pagesa dështoi
404 Nuk u gjet ose i përket një llogarie tjetër
500 Pagimi nuk mund të përpunohet, ose pagimi u krye por rinovimi i registrarit dështoi. Kontakto ndihmën në këtë rast.
PUT /api/v1/domains/{uuid}/nameservers/

Serverët e emrave

Vendos serverat e emrave të domenit tek registrari dhe kthen objektin e përditësuar të domenit. Për të menazhuar DNS me API-në e DNS, përdorni ns1.vps.org, ns2.vps.org dhe ns3.vps.org dhe krijoni një zonë për domenin.

Të drejta të nevojshme: domains:update

Parametrat e Trupit të Kërkesës

Parametrat Lloji E detyrueshme Përshkrimi
nameserver1 string Po Emri i serverit primar
nameserver2, nameserver3, nameserver4 string Jo. Emrat shtesë të serverit të emrave 
curl -X PUT "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/nameservers/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"nameserver1": "ns1.vps.org", "nameserver2": "ns2.vps.org", "nameserver3": "ns3.vps.org"}'

Kodet e Statusit të Përgjigjes

200 Emri server përditësuar; trup është objekti domain
400 Mungon serveri i emrit 1
404 Nuk u gjet ose i përket një llogarie tjetër
500 Përditësimi dështoi; trupi i mesazhit ka fusha gabimi dhe mesazhi
PUT /api/v1/domains/{uuid}/auto-renew/

Aktivizo apo çaktivizo përtëritjen automatike

Vendos auto_renew dhe kthen objektin e përditësuar të domenit. Dërgo aktivuar si një boolean JSON: çdo stringë jo bosh, duke përfshirë stringën false, aktivizon rinovimin automatik.

Të drejta të nevojshme: domains:update

curl -X PUT "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/auto-renew/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

Kodet e Statusit të Përgjigjes

200 Rregullimi u ruajt; trupi është objekti i domain
400 mungon
404 Nuk u gjet ose i përket një llogarie tjetër

Shënim