VPS.org API

Tahirin-kevitra REST API

Domains API

Mitady anaran-domana misy, mametraka sy manavao domains, ary mitantana ny mpizara anaran'izy ireo sy ny fanavaozana azy ireo hoazy. Ny uuid-ny no mamaritra ny domains.

Teboka farany 7
Lalana fototra /api/v1/domains
ALAO /api/v1/domains/

Tanisao ny sehatra rehetra

Maneho ireo domains voasoratra ao amin'ny kaontinao, 25 isaky ny pejy. Tsy misy sivana ilay lisitra.

Mila alalana: domains:list

Ohatra amin'ny fangatahana

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

Ohatra amin'ny Valiny

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

Saha Valiny

Field Karazana Fanoritsoritana
uuid string Ny marika manokan'ny domena ampiasaina amin'ny farany hafan'ny domena
status string active, pending, expired, cancelled, transferred
registrar string Mpanao fisoratana anarana ny domena
registration_date, expiration_date datetime Ny fotoana nametrahana ny domain sy ny fotoana fiafaran'ny fotoana. mety ho tsy misy ny expiration_date.
days_until_expiration integer | null Andro manontolo alohan'ny expiration_date, tsy misy raha vao tapitra
is_expired, needs_renewal_soon boolean Raha efa tapitra ny fotoanan'ny domain, ary raha tapitra ao anatin'ny 30 andro manaraka
auto_renew, renewal_period_years boolean, integer Raha toa ka hanova hoazy ilay domain, ary mandritra ny taona firy
registration_price, renewal_price string Ny vidin'ny USD amin'ny endri-daha-daza
whois_privacy, transfer_lock boolean Fandrindrana ny tsiambaratelo WHOIS sy ny gejan'ny fandefasana ny mpikirakira
nameserver1 to nameserver4 string | null Ny mpizara anarana an'ilay domena
created_at, updated_at datetime Ny fotoana namoronana sy fanovana farany ilay tahirin-kevitra (ISO 8601, UTC)
ALAO /api/v1/domains/{uuid}/

Maka ny antsipirian'ny domena

Maneho zavatra iray amin'ny domena iray miaraka amin'ireo sehatr'asa etsy ambony.

Mila alalana: domains:list

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

Kaody momba ny satan'ny valiny

200 Fahombiazana
404 Tsy hita, na an'ny kaonty hafa izy io
POST /api/v1/domains/search/

Karohy ny fisian'ny domain

Mijery raha misy anarana iray misy amin'ny tovana 20 malaza (com, net, org, io, dev, co, app, ai ary maro hafa), ary ny tovan'ny teny nanoratrao raha tsy tafiditra anatin'izany. Ny valiny dia manomboka amin'ny fifandanjana marina, avy eo ny anarana misy, avy eo ireo efa nampiasaina.

Mila alalana: domains:search

Fangatahana masontsivana momba ny vatana

Mpizahaky ny macro Karazana ilaina Fanoritsoritana
domain string ENY Anarana iray misy na tsy misy tovana, ohatra ny mysite na mysite.com (marika 2 ka hatramin'ny 63)

Ohatra amin'ny fangatahana

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

Ohatra amin'ny Valiny

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

Isa amin'ny dolara amerikana ny vidin'ny taona iray ary tsy misy ny isa ho an'ny anarana tsy misy.

Kaody momba ny satan'ny valiny

200 Fahombiazana
400 Domena tsy hita, na misy marika hafa tsy hoe litera, isa ary tsipika
500 Tsy nety ny fitadiavana ny mpizara. Andramo indray aorian'izay.
POST /api/v1/domains/register/

Misoratra anarana sehatra vaovao

Mametraka anarana domain iray ary mandray ny vola amin'ny fomba fandoavam-bola voatahiry. Miverina jerena amin'ny mpiandraikitra ny fahafahana mampiasa sy ny vidiny alohan'ny handoavana ny vola. Avy amin'ny profil'ny kaontinao no fandraisana ny antsipirian'ny fifandraisana amin'ny mpisoratra anarana. Raha toa ka mandà ny fisoratana anarana aorian'ny fandoavana ny vola ny mpiandraikitra, dia averimberina ny vola.

Mila alalana: domains:register (nanomezan'ny domains:*)

Fangatahana masontsivana momba ny vatana

Mpizahaky ny macro Karazana ilaina Fanoritsoritana
domain string ENY Ny anaran'ny domena feno, anisan'izany ny tovana, ohatra example.com
years integer Tsy misy Ny vanim-potoanan'ny fisoratana anarana, 1 hatramin'ny 10 (1 ny sanda tsotra). Ny vidiny dia ny vidiny isan-taona no averina amin'ny taona. Mila 2 taona farafahakeliny ny.ai; ny sanda kely kokoa dia manome 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}'

Ohatra amin'ny Valiny

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

Kaody momba ny satan'ny valiny

201 Domain registered
400 Domaine tsy mety, tsy misy intsony ny domain, tsy azo antoka ny vidiny, fomba fandoavam-bola efa ela, na tsy nahomby ny fandoavam-bola
402 Tsy misy fomba fandoavam-bola ao amin'ny raki-tahiry, na tsy misy vola tsy voaloa
500 Tsy azo nalefa ny fandoavam-bola, na nolavin'ny mpiandraikitra ny fisoratana anarana taorian'ny fandoavam-bola. Amin'ny tranga faharoa, milaza ny hafatra tsy fetezana raha mbola niverina ny fandoavam-bola.
POST /api/v1/domains/{uuid}/renew/

Hanova Domain

Manavao ilay domena ary mandray ny renewal_price-ny isan-taona amin'ny alalan'ny fomba fandoavam-bola voatahiry.

Mila alalana: domains:renew

Fangatahana masontsivana momba ny vatana

Mpizahaky ny macro Karazana ilaina Fanoritsoritana
years integer Tsy misy Taona ampitomboina, 1 ka hatramin'ny 10 (1 ny sanda tsotra)
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)!"
}

Kaody momba ny satan'ny valiny

200 Nohavaozina ilay domena
400 Taona tsy mitombina, tsy misy vidiny fanavaozana ho an'ilay domain, tsy misy fomba fandoavam-bola azo ampiasaina, na tsy nahomby ny fandoavam-bola
404 Tsy hita, na an'ny kaonty hafa izy io
500 Tsy afaka nahavita ny fandoavana, na dia efa nandalo aza ny fandoavana nefa tsy nahomby ny fanavaozana ny mpiandraikitra. Antsoy ny fanohanana amin'izany tranga izany.
PUT /api/v1/domains/{uuid}/nameservers/

Hanova ny mpizara anarana

Mamaritra ny mpizara anaran'ilay domain ao amin'ny mpiandraikitra ka mamerina ny zavatra navoaka. Raha te hifehy ny DNS amin'ny alalan'ny API DNS ianao, dia mampiasa ny ns1.vps.org, ns2.vps.org ary ns3.vps.org ary mamorona faritra ho an'ilay domain.

Mila alalana: domains:update

Fangatahana masontsivana momba ny vatana

Mpizahaky ny macro Karazana ilaina Fanoritsoritana
nameserver1 string ENY Anaran'ny mpizara anarana voalohany indrindra
nameserver2, nameserver3, nameserver4 string Tsy misy Anaran'ny mpizara anarana fanampiny
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"}'

Kaody momba ny satan'ny valiny

200 Naverina navoaka ny mpizara anarana; ny vatana dia ny zavatra domain
400 Tsy misy ny mpizara anarana 1
404 Tsy hita, na an'ny kaonty hafa izy io
500 Tsy nahomby ny fanavaozana; misy tsy fetezana sy faritra misy hafatra ao amin'ny vatana
PUT /api/v1/domains/{uuid}/auto-renew/

Mandefa na manajanona ny fanavaozana hoazy

Mamaritra ny auto_renew ary mamerina ny zavatra amin'ny domain nanovaina. Mandefa amin'ny alalan'ny boolean JSON: ny laha-daza tsy foana rehetra, anisan'izany ny laha-daza false, dia mandefa ny fanavaozana hoazy.

Mila alalana: 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}'

Kaody momba ny satan'ny valiny

200 Voaraikitra ny kirakira; ny vatana dia ny zavatran'ny domena
400 tsy misy
404 Tsy hita, na an'ny kaonty hafa izy io

Fanamarihana