Àwọn Dóméǹ

GBÀ /api/v1/domains/

Ṣe àkójọ gbogbo àwọn agbègbè ìkápá

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

Àwọn ìkúndùǹ tí a fẹ́: domains:list

Àpẹẹrẹ Ìbéèrè

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

Àpẹẹrẹ Ìdáhùn

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

Àwọn Ààyè Ìdáhùn

Àwọn Ààyè-iṣẹ́	Irú	Àwọn Àkọlé
`uuid`	string	Àtòjọ-ẹ̀yàn Dómén tí a lo nínú àwọn ààtò ìparí dómén mìíràn
`status`	string	`active`, `pending`, `expired`, `cancelled`, `transferred`
`registrar`	string	Regístarí dómén náà tí a fi pamọ́ sí
`registration_date`, `expiration_date`	datetime	Àwọn ààyè tí a fi àwọn dómén kọ́ nígbà tí a tì kọ́ nígbà tí o tì kù. àwọn ààyè_ìgbà_ìparí iṣẹ́ lè jẹ́ àìdá.
`days_until_expiration`	integer \| null	Àwọn ọjọ́ ìtàn láti ìgbà_àtílẹ̀, àìdájú látì ìgbà aago
`is_expired`, `needs_renewal_soon`	boolean	Bó o tì kùnà dómén náà, àti bó o tì kùnà nínú àwọn ọjọ́ 30 tókàn
`auto_renew`, `renewal_period_years`	boolean, integer	Bó o tì fẹ́ dómìnira náà láti ṣí nípa ìṣàfarawé àwọn ìṣàmúlò-ètò, àti fún àwọn oṣù kọ̀ǹpútà
`registration_price`, `renewal_price`	string	Àwọn àwọn ìtàn nínú USD bí àwọn àyọkà ìsàlẹ̀-ilà
`whois_privacy`, `transfer_lock`	boolean	Àwọn ìkúndùǹ ìdáràn atí ìṣàmúlò-ètò ìjánu-ìṣàmúlò-ètò WHOIS
`nameserver1` to `nameserver4`	string \| null	Àwọn ààtò àtòjọ-ìwé dóméètì
`created_at`, `updated_at`	datetime	Àwọn ààyè tí a fi kọ́ àtòjọ-ẹ̀yàn náà àti àwọn ìṣàmúlò-ètò tókàn (ISO 8601, UTC)

GBÀ /api/v1/domains/{uuid}/

Àwọn Àlàyé Dómén

Fi àwọn ààtòjútó ààtòjútó pamọ́ sínú àwọn ààtòjútó ààtòjútó.

Àwọn ìkúndùǹ tí a fẹ́: domains:list

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

Àwọn Kóòdù Ipò Ìdáhùn

200	Àwọn Ìṣàmúlò-ètò
404	Kò rí, tàbí ò jẹ́ àwọn

Àwọn Àkọlé /api/v1/domains/search/

Àwọn ààyè-iṣẹ́ àwọn dómén

Ṣayẹwo láti rí pé àwọn ìṣàmúlò-ètò tí a lò nínú àwọn àwọn àkóónú 20 (com, net, org, io, dev, co, app, ai atí àwọn mìíràn), àti àwọn àkóónú tí o tíkà láti rí pé o kò wa nínú wọn. Àwọn àwọn

Àwọn ìkúndùǹ tí a fẹ́: domains:search

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àwọn Àtòjọ-ẹ̀yàn	Irú	Ti a nilo	Àwọn Àkọlé
`domain`	string	Bẹ́ẹ̀ni	A name with or without an extension, for example mysite or mysite.com (2 to 63 characters)

Àpẹẹrẹ Ìbéèrè

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

Àpẹẹrẹ Ìdáhùn

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

Prices are numbers in USD for one year and are null for names that are not available. The prices shown are illustrative.

Àwọn Kóòdù Ipò Ìdáhùn

200	Àwọn Ìṣàmúlò-ètò
400	Àwọn dómén tí a kò lè, tàbí o ní àwọn àmì-àṣírí mìíràn tí kò jẹ́ àwọn àyọkà, àwọn ìtàn àti àwọn ìṣàmúlò-ètò
500	Àwọn ìṣàfihàn àwọn régístràtì kùnà. Àwọn ìṣàfarawé àwọn ìṣàmúlò-ètò.

Àwọn Àkọlé /api/v1/domains/register/

Forukọsilẹ Aṣẹ Tuntun

Fi dómìnirà kọ̀ǹpútà kan pamọ́ sínú àwọn ìṣàmúlò-ètò ìṣàmúlò-ètò rẹ̀. Àwọn ìṣàmúlò-ètò tí a lè lò nínú àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè àwọn ààyè

Àwọn ìkúndùǹ tí a fẹ́: domains:register (tí a fì pamọ́ sí àwọn ààyè-iṣẹ́:*)

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àwọn Àtòjọ-ẹ̀yàn	Irú	Ti a nilo	Àwọn Àkọlé
`domain`	string	Bẹ́ẹ̀ni	Orúkọ dómén kíkún àti ìṣàfarawégbègbè rẹ, àwọn ààtòjú àtòjọ-ẹ̀yàn.com
`years`	integer	_Kò	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}'

Àpẹẹrẹ Ìdáhùn

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

Àwọn Kóòdù Ipò Ìdáhùn

201	Àwọn ààyè-iṣẹ́ àìṣàmúlò-ètò
400	Àwọn ààyè-iṣẹ́ kò ní ìṣàfarawé, ààyè-iṣẹ́ kò wa, àwọn ààyè-iṣẹ́ kò lè ṣàyẹwo, àwọn ìṣàmúlò-ètò ìṣàfihàn tí a tì pẹ̀lú, tàbí ìṣàfihàn náà kù
402	Kò ní ìṣàmúlò-ètò pàtó fún ìṣàmúlò-ètò nínú fáìlì, tàbí àwọn fátìrì tí a kò pà
500	Kò lè ṣé ìṣàmúlò-ètò, tàbí àwọn alábòójútó tí a fi pamọ́ lójútó àwọn ààyè-iṣẹ́ nínú àwọn ààyè-iṣẹ́. Nínú àwọn ààyè-iṣẹ́ kejì, àkọlé àwọn ààyè-iṣẹ́ àìdájú àwọn ààyè-iṣẹ́ sọ nípa àwọn ààyè-iṣẹ́ àwọn ààyè-iṣẹ́.

Àwọn Àkọlé /api/v1/domains/{uuid}/renew/

Àwọn Àmì-ìwé

Ṣàfikún dómìnirà náà àti àwọn àwọn ìṣàmúlò-ètò rẹ̀ fún odun kọọkan sí àwọn ìṣàmúlò-ètò ìṣàfihàn rẹ̀.

Àwọn ìkúndùǹ tí a fẹ́: domains:renew

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àwọn Àtòjọ-ẹ̀yàn	Irú	Ti a nilo	Àwọn Àkọlé
`years`	integer	_Kò	Àwọn odun láti fàyè gba, 1 sí 10 (ò̀tọ́)

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)!"
}

Àwọn Kóòdù Ipò Ìdáhùn

200	Àwọn ààyè-iṣẹ́ àìdálẹ̀
400	Àwọn odun tí kò tọ́, kò ní owó ìṣàfarawé fún dómén, kò ní ìṣàmúlò-ètò ìṣàmúlò-ètò, tàbí ìṣàmúlò-ètò náà tí kò bá
404	Kò rí, tàbí ò jẹ́ àwọn
500	Kò lè ṣé ìṣàmúlò-ètò, tàbí ìṣàmúlò-ètò náà lọ́wọ́lọ́wọ́, àwọn ìṣàmúlò-ètò náà tí a tí ìṣàmúlò-ètò náà ṣẹ́. Fẹ̀ẹ̀ kọ́ nínú àwọn ààyè náà.

PUT /api/v1/domains/{uuid}/nameservers/

Àwọn Sáà Àìṣàmúlò-ètò

Sets the domain's nameservers at the registrar and returns the updated domain object. To manage DNS with the DNS API, use ns1.vps.org, ns2.vps.org and ns3.vps.org and create a zone for the domain.

Àwọn ìkúndùǹ tí a fẹ́: domains:update

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àwọn Àtòjọ-ẹ̀yàn	Irú	Ti a nilo	Àwọn Àkọlé
`nameserver1`	string	Bẹ́ẹ̀ni	Àwọn àwọn ààtò àtòjọ-ẹ̀yàn
`nameserver2`, `nameserver3`, `nameserver4`	string	_Kò	Àwọn àwọn

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

Àwọn Kóòdù Ipò Ìdáhùn

200	Àwọn ààtòjútó àwọn ààtòjútó àwọn ààtòjútó àwọn ààtòjútó àwọn ààtòjútó
400	Àìpàdé àwọn ààtò àtòjọ-ìwé1
404	Kò rí, tàbí ò jẹ́ àwọn
500	Àkóónú ìṣàmúlò-ètò náà kùnà; àwọn ààyè-iṣẹ́ ìṣàfarawé kọ̀ǹpútà àti àkọ́lé nínú ìsàlẹ̀-ètò náà

PUT /api/v1/domains/{uuid}/auto-renew/

Fi Ìṣàmúlò-ètò Ìṣàmúlò-ètò Rẹ́ láti Mú Àwọn

Sets auto_renew and returns the updated domain object. Send enabled as a JSON boolean: any non-empty string, including the string false, turns auto-renewal on.

Àwọn ìkúndùǹ tí a fẹ́: 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}'

Àwọn Kóòdù Ipò Ìdáhùn

200	Àtòjọ-ẹ̀yàn tí a fi pamọ́; ẹ̀yàn ní ohun-ìtàn dómén
400	tí a fi àkóónú mú
404	Kò rí, tàbí ò jẹ́ àwọn

Àwọn Àmì-ìwé

API kò lè pa dómìnirà, gbàwọlé dómìnirà, tàbí yí àwọn ààyè-iṣẹ́ WHOIS àti àwọn ìdàkọ́ àwọn ìjánu-ìjánù. Àwọn ìjánu-ìjánù àti àwọn ìpàsẹ̀ nínú pánẹ́ẹ̀lì ìṣakosoì ní admin.vps.org.
Àwọn àkọlé DNS fún dómìnira ní a kọ̀lù láti inú DNS API. API Ìṣàkóso DNS

VPS.org API

Àwọn Dóméǹ

Ṣe àkójọ gbogbo àwọn agbègbè ìkápá

Àpẹẹrẹ Ìbéèrè

Àpẹẹrẹ Ìdáhùn

Àwọn Ààyè Ìdáhùn

Àwọn Àlàyé Dómén

Àwọn Kóòdù Ipò Ìdáhùn

Àwọn ààyè-iṣẹ́ àwọn dómén

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àpẹẹrẹ Ìbéèrè

Àpẹẹrẹ Ìdáhùn

Àwọn Kóòdù Ipò Ìdáhùn

Forukọsilẹ Aṣẹ Tuntun

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àpẹẹrẹ Ìdáhùn

Àwọn Kóòdù Ipò Ìdáhùn

Àwọn Àmì-ìwé

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àwọn Kóòdù Ipò Ìdáhùn

Àwọn Sáà Àìṣàmúlò-ètò

Ìbéèrè fún Àwọn Ìwọ̀n Ara

Àwọn Kóòdù Ipò Ìdáhùn

Fi Ìṣàmúlò-ètò Ìṣàmúlò-ètò Rẹ́ láti Mú Àwọn

Àwọn Kóòdù Ipò Ìdáhùn

Àwọn Àmì-ìwé