VPS.org API

Dokumentazzjoni tal-REST API

Domenji API

Tfittex għal ismijiet ta' dominji disponibbli, irreġistra u tiġġedded dominji, u timmaniġġja l-nameservers tagħhom u t-tiġdid awtomatiku.Domains huma identifikati mill-uuid tagħhom.

Punti tat-tmiem 7
Mogħdija Bażika /api/v1/domains
IKSEB /api/v1/domains/

Elenka d-Dominji Kollha

Jirritorna l-dominji rreġistrati fil-kont tiegħek, 25 għal kull paġna. Il-lista ma jkollu l-ebda filtri.

Permess meħtieġ: domains:list

Eżempju ta' Talba

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);

Eżempju ta' Rispons

{
  "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"
    }
  ]
}

Oqsma ta' Rispons

Qasam Tip Deskrizzjoni
uuid string Identifikatur tad-dominju użat fil-punti aħħarin tad-dominju l-oħra
status string active, pending, expired, cancelled, transferred
registrar string Id-dominju huwa miżmum minn
registration_date, expiration_date datetime Meta d-dominju kien irreġistrat u meta jiskadi. expiration_date jistgħu jkunu null.
days_until_expiration integer | null Jiem sħaħ sa expiration_date, negattiv ladarba jiskadi
is_expired, needs_renewal_soon boolean Jekk id-dominju jkunx skada, u jekk jiskadix fit-30 jum li ġejjin
auto_renew, renewal_period_years boolean, integer Jekk id-dominju jiġġedded awtomatikament, u għal kemm snin
registration_price, renewal_price string Prezzijiet f'USD bħala strings deċimali
whois_privacy, transfer_lock boolean Is-settings tal-privatezza WHOIS u l-lock tat-trasferiment tar-reġistratur
nameserver1 to nameserver4 string | null Is-servers tal-isem tad-dominju
created_at, updated_at datetime Meta nħolqot ir-reġistrazzjoni u meta nbidlet l-aħħar (ISO 8601, UTC)
IKSEB /api/v1/domains/{uuid}/

Ikseb Dettalji tad-Dominju

Jirritorna oġġett dominju wieħed mal-oqsma hawn fuq.

Permess meħtieġ: domains:list

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

Kodiċijiet tal-Istatus tar-Rispons

200 Suċċess
404 Ma nstabx, jew jappartjeni għal kont ieħor
POST /api/v1/domains/search/

Tfittxija Domenju Disponibilità

Jiċċekkja jekk isem hux disponibbli fuq madwar 20 estensjoni popolari (com, net, org, io, dev, co, app, ai u aktar), flimkien mal-estensjoni li inti ttajpjat jekk ma tkunx fosthom.Riżultati tibda bil-match eżatta, imbagħad ismijiet disponibbli, imbagħad dawk meħuda.

Permess meħtieġ: domains:search

Parametri tal-Korp tat-Talba

Parametru Tip Meħtieġ Deskrizzjoni
domain string Iva Isem b'estensjoni jew mingħajrha, pereżempju mysite jew mysite.com (2 sa 63 karattru)

Eżempju ta' Talba

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"])

Eżempju ta' Rispons

{
  "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
}

Il-prezzijiet huma numru f'USD għal sena u huma null għal ismijiet li mhumiex disponibbli.Il-prezzijiet murija huma illustrattivi.

Kodiċijiet tal-Istatus tar-Rispons

200 Suċċess
400 Id-dominju nieqes, jew fih karattri minbarra l-ittri, ċifri u ħjiel
500 It-tfittxija tar-reġistratur ma rnexxietx. Ipprova mill-ġdid aktar tard.
POST /api/v1/domains/register/

Irreġistra Dominju Ġdid

Jirreġistra dominju u jiċċarġja l-metodu ta' ħlas tiegħek. Id-disponibbiltà u l-prezz huma ċċekkjati mar-reġistrant mill-ġdid eżatt qabel l-iċċarġjar. Id-dettalji ta' kuntatt tar-reġistrant jittieħdu mill-profil tal-kont tiegħek. Jekk ir-reġistrant jirrifjuta r-reġistrazzjoni wara l-iċċarġjar, il-ħlas jiġi rritornat.

Permess meħtieġ: domains:register (mogħtija mid-dominji:*)

Parametri tal-Korp tat-Talba

Parametru Tip Meħtieġ Deskrizzjoni
domain string Iva L-isem sħiħ tad-dominju inkluż l-estensjoni tiegħu, pereżempju example.com
years integer Nru Registration period, 1 to 10 (default 1). The price is the yearly price times years. .ai requires at least 2 years; a smaller value returns 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}'

Eżempju ta' Rispons

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

Kodiċijiet tal-Istatus tar-Rispons

201 Domain irreġistrat
400 Domenju invalidu, dominju m'għadux disponibbli, prezz ma setax jiġi vverifikat, metodu ta' ħlas skadut, jew il-ħlas ma setax isir
402 Ebda metodu ta' ħlas fil-fajl, jew fatturi mhux imħallsa
500 Il-ħlas ma setax jiġi pproċessat, jew ir-reġistrant ċaħad ir-reġistrazzjoni wara l-ħlas, fit-tieni każ il-messaġġ ta' żball jgħid jekk ir-rifużjoni għaddietx.
POST /api/v1/domains/{uuid}/renew/

Iġġedded Domain

Iġġedded id-dominju u jiċċarġja l-prezz tat-tiġdid tiegħu għal kull sena lill-metodu ta' ħlas salvat tiegħek.

Permess meħtieġ: domains:renew

Parametri tal-Korp tat-Talba

Parametru Tip Meħtieġ Deskrizzjoni
years integer Nru Snin biex iżżid, 1 sa 10 (default 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)!"
}

Kodiċijiet tal-Istatus tar-Rispons

200 Id-dominju mġedded
400 Snin invalidi, l-ebda prezz tat-tiġdid għad-dominju, l-ebda metodu ta' ħlas li jista' jintuża, jew il-ħlas ma rnexxilux
404 Ma nstabx, jew jappartjeni għal kont ieħor
500 Il-ħlas ma setax jiġi pproċessat, jew il-ħlas għadda iżda t-tiġdid tar-reġistratur falla.Ikkuntattja l-appoġġ f'dak il-każ.
PUT /api/v1/domains/{uuid}/nameservers/

Aġġorna l-Nameservers

Biex timmaniġġja DNS mal-API DNS, tuża ns1.vps.org, ns2.vps.org u ns3.vps.org u toħloq żona għad-dominju.Issettja l-nameservers tad-dominju fir-reġistratur u jirritorna l-oġġett dominju aġġornat.

Permess meħtieġ: domains:update

Parametri tal-Korp tat-Talba

Parametru Tip Meħtieġ Deskrizzjoni
nameserver1 string Iva Isem tal-host tal-server tal-isem primarju
nameserver2, nameserver3, nameserver4 string Nru Isem tal-host server addizzjonali 
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"}'

Kodiċijiet tal-Istatus tar-Rispons

200 Nameservers aġġornati; il-korp huwa l-oġġett tad-dominju
400 nameserver1 nieqes
404 Ma nstabx, jew jappartjeni għal kont ieħor
500 L-aġġornament falla; il-korp għandu l-oqsma tal-iżball u tal-messaġġ
PUT /api/v1/domains/{uuid}/auto-renew/

Aqleb Auto-Tiġdid fuq jew Off

Send enabled as a JSON boolean: kull string mhux vojta, inkluża l-string false, iddawwar it-tiġdid awtomatiku fuq.

Permess meħtieġ: 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}'

Kodiċijiet tal-Istatus tar-Rispons

200 Setting salvati; il-korp huwa l-oġġett dominju
400 nieqes
404 Ma nstabx, jew jappartjeni għal kont ieħor

Noti