VPS.org API

Faʻamatalaga o le REST API

Atinaʻe

Suʻe mo igoa o le itulagi e avanoa, tusia ma toe faʻafouina itulagi, ma pulea a latou 'nameservers' ma le toe faʻafouina otometi. E iloa e le uuid o le itulagi.

Fa'ai'uga 7
Ala Autu /api/v1/domains
MAUA /api/v1/domains/

Lisi Uma o Itūlau Autū

Returns the domains registered in your account, 25 per page. The list has no filters.

Manaomia le aia tatau: domains:list

Talosaga Fa'ata'ita'i

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

Tali Fa'ata'ita'i

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

Fanua Tali

Aoga Ituaiga Faʻamatalaga
uuid string Faailoga tagata o le 'au'aunaga e faaaoga i isi pito i tua o le 'au'aunaga
status string active, pending, expired, cancelled, transferred
registrar string Registrar o le itulagi e te teu i ai
registration_date, expiration_date datetime I le taimi na tusia ai le igoa o le tuatusi ma i le taimi e telē ai. E mafai ona leai se expiration_date.
days_until_expiration integer | null Aso atoa e oo atu i le expiration_date, leiloa pe a maeʻa
is_expired, needs_renewal_soon boolean Afai ua mavae le tuatusi o le tuatusi, ma afai e mavae i totonu o le 30 aso mulimuli
auto_renew, renewal_period_years boolean, integer Pe a faʻafouina le 'auala' i le taimi nei, ma mo le tele o tausaga
registration_price, renewal_price string Tau i le USD e pei o fuaiupu decimal
whois_privacy, transfer_lock boolean Faʻatonu o le faʻaaloalo ma le faʻailoilo o le faʻailoilo o le WHOIS
nameserver1 to nameserver4 string | null Le 'au'aunaga igoa o le 'au'aunaga
created_at, updated_at datetime I le taimi na faia ai ma suia ai le tusiata (ISO 8601, UTC)
MAUA /api/v1/domains/{uuid}/

Faʻataga Faʻamatalaga o le Dome

Toe faʻafoʻi se meatotino o le itumalo ma le itulagi i luga.

Manaomia le aia tatau: domains:list

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

Fa'ailoga o Tulaga o Tali

200 Fa'ataunuuina
404 E le maua, po o e fai ma sui o se isi teugatupe
POST /api/v1/domains/search/

Suʻe Domain Faʻatonu

Fa'amautinoa pe mafai ona maua se igoa i luga o le 20 fa'aosoosoga lauiloa (com, net, org, io, dev, co, app, ai ma isi), fa'apea fo'i ma le fa'aosoosoga na e tipiina pe afai e le i ai i totonu o latou. E amataina fa'amatalaga ma le fesuiaiga sa'o, ona maua ai lea o igoa, ona ave ai lea o igoa.

Manaomia le aia tatau: domains:search

Talosaga mo Fa'atulagaga o le Tino

Paramita Ituaiga Mana'omia Faʻamatalaga
domain string Ioe Se igoa ma pe leai se faʻaopoopoga, mo se faataitaiga mysite po o mysite.com (2 i le 63 caracters)

Talosaga Fa'ata'ita'i

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

Tali Fa'ata'ita'i

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

O tau e numera i le USD mo se tausaga ma e leai se numera mo igoa e le o avanoa. O tau e faʻaalia e faʻataʻitaʻi.

Fa'ailoga o Tulaga o Tali

200 Fa'ataunuuina
400 E leai se 'au'aunaga, pe e iai ni karapu e le o ni tusi, numera po o ni faaupuga
500 Le sailiga o le tusi fa'amaonia na fa'aleagaina.
POST /api/v1/domains/register/

Resitala se Itūlau Fou

Fa'ataga se 'upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se' upega tafa'ilagi e fa'ataga ai se'

Manaomia le aia tatau: domains:register (tagata e maua e le domains: *)

Talosaga mo Fa'atulagaga o le Tino

Paramita Ituaiga Mana'omia Faʻamatalaga
domain string Ioe Le igoa atoa o le 'au'aunaga, e aofia ai lona faʻaopoopoga, mo se faataitaiga example.com
years integer E leai 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}'

Tali Fa'ata'ita'i

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

Fa'ailoga o Tulaga o Tali

201 Fa'ataga le 'au'aunaga
400 Fa'atonu le fa'atonu, fa'atonu le fa'atonu, le tau e le mafai ona fa'amaonia, auala totogiina ua le aoga, po'o le totogiina na fa'aleagaina
402 E leai se auala totogi i le faila, po o faʻamatalaga le totogiina
500 E le mafai ona faʻatino le totogiina, pe na le taliaina e le tagata faʻatonu le faʻamaoniaina i le maeʻa ai o le totogiina. I le tulaga lona lua, o le imeli o le faʻafitauli e fai mai pe na faʻatino le toe totogiina.
POST /api/v1/domains/{uuid}/renew/

Faʻafou se Domain

Faafou le 'upega tafa'ilagi ma totogi lona renewal_price mo ia tausaga i lau auala totogifuapauina na teu.

Manaomia le aia tatau: domains:renew

Talosaga mo Fa'atulagaga o le Tino

Paramita Ituaiga Mana'omia Faʻamatalaga
years integer E leai Tausaga e faaopoopo ai, 1 i le 10 (faʻatapulaʻaina i le 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)!"
}

Fa'ailoga o Tulaga o Tali

200 Faʻafouina le 'au'aunaga
400 tausaga le talafeagai, leai se tau faafouina mo le 'au'aunaga, leai se auala totogi e mafai ona faʻaaogaina, poʻo le totogiina na faʻaleagaina
404 E le maua, po o e fai ma sui o se isi teugatupe
500 E le mafai ona fa'atino le totogi, pe na'o le totogi na'o le fa'afouina o le registrar na'o le fa'atonu. Fa'afeso'ota'i le lagolago i lena tulaga.
PUT /api/v1/domains/{uuid}/nameservers/

Faʻafouina

E fa'atonutonu ai le DNS ma le DNS API, fa'aaoga ns1.vps.org, ns2.vps.org ma ns3.vps.org ma fausia se itu mo le 'au'aunaga.

Manaomia le aia tatau: domains:update

Talosaga mo Fa'atulagaga o le Tino

Paramita Ituaiga Mana'omia Faʻamatalaga
nameserver1 string Ioe igoa o le faitotoʻa o le 'au'aunaga
nameserver2, nameserver3, nameserver4 string E leai Faʻaopoopoga o igoa o le 'au'aunaga
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"}'

Fa'ailoga o Tulaga o Tali

200 Nameservers updated; o le tino o le meatotino o le 'au'aunaga
400 nameserver1 e le maua
404 E le maua, po o e fai ma sui o se isi teugatupe
500 Le faʻafouga na faʻaleagaina; o le tino e iai faʻafitauli ma meatautala
PUT /api/v1/domains/{uuid}/auto-renew/

Faʻaola pe faʻaola le toe faʻafouina otometi

Faʻatulagaina le auto_renew ma toe aumaia le meatotino o le 'au'aunaga ua faʻafouina. Faʻatonu le auina atu o se JSON boolean: soʻo se fuaiupu e le vaitino, e aofia ai le fuaiupu 'false', e faʻatonu ai le toe faʻafouina otometi.

Manaomia le aia tatau: 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}'

Fa'ailoga o Tulaga o Tali

200 Faʻatonu na teu; o le tino o le meatotino o le 'auala
400 faʻatagaina le leai
404 E le maua, po o e fai ma sui o se isi teugatupe

Faʻamatalaga