Maareynta DNS API

Dulmar Guud

A zone haystaa diiwaanada u domain mid ah. Isbedelka kasta oo aad samayso iyada oo API waa la soo saaray si VPS.org servers magacyada si deg deg ah. Si ay u adeegaan domain ka mid ah gobolladaas, si ay u abuuraan servers magacyada ah ee aad registrar in ns1.vps.org, ns2.vps.org iyo ns3.vps.org.

Isbedelada waxaa la kaydiyaa oo la daabacay hal tallaabo: haddii servers magacyada diido isbedelka, codsiga ku soo laabto 502 iyo waxba ma la badbaadiyo. A zone ma loo abuuri karo domain kale xisaab kale oo horey u maamulo, waalidka ama ilmaha xisaab kale ee zone, ama VPS.org magac la xiray.

Xuquuqda loo baahan yahay: dns:list (GET), dns:create (POST), dns:update (PUT, PATCH, sync), dns:delete (DELETE), dns:*

HEL /api/v1/dns-zones/

Liis garee Dhammaan Aagagga DNS

Ku soo laabtay gobolladaada, ugu dambeeyay hore, 25 bog kasta. Records ma aha in halkan lagu daray; soo qaado gobol keliya si ay u helaan.

Cabbirrada Weydiinta

_Barnaamijyada	Nooca	Loo baahan yahay	Tilmaamaha
`domain`	string	Ha	Ku soo celin oo keliya gobolka la magac domain this
`page`	integer	Ha	Tirada bog, ka bilow 1

Codsi Tusaale ah

cURL

Python

JavaScript

curl -X GET "https://admin.vps.org/api/v1/dns-zones/?domain=example.com" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests

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

response = requests.get(url, headers=headers, params={"domain": "example.com"})
for zone in response.json()["results"]:
    print(zone["uuid"], zone["domain"], zone["record_count"])

const response = await fetch('https://admin.vps.org/api/v1/dns-zones/?domain=example.com', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

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

Jawaabta Tusaale

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c",
      "domain": "example.com",
      "created_at": "2026-09-06T03:11:48.829693Z",
      "record_count": 5
    }
  ]
}

Goobaha Jawaabta

Isku-darka	Nooca	Tilmaamaha
`uuid`	string	Magaca goobta
`domain`	string	Magaca domainka, waxaa lagu kaydiyaa xarfo yaryar
`created_at`	datetime	Waqtiga abuurista (ISO 8601, UTC)
`record_count`	integer	Tirada diiwaanada ee gobolka, oo ay ku jiraan saddexda diiwaanada NS

Koodhadhka Xaaladda Jawaab celinta

200	Guul
403	Xiran ama aan sharci ahayn API token, ama token ka maqan oggolaanshaha loo baahan yahay

BOOQO /api/v1/dns-zones/

abuuro DNS Zone

Zone abuurtaa zone iyo daabacaadda. Zone bilaabay saddex diiwaanada NS ee ns1, ns2 iyo ns3.vps.org, kuwaas oo ah diiwaanada nidaamka oo aan la edit ama la tirtiro.

Codso Cabbirrada Jirka

_Barnaamijyada	Nooca	Loo baahan yahay	Tilmaamaha
`domain`	string	Haa	Magaca domain, tusaale example.com

curl -X POST "https://admin.vps.org/api/v1/dns-zones/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "example.com"}'

Jawaabta Tusaale

{
  "uuid": "c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c",
  "domain": "example.com",
  "created_at": "2026-09-14T21:02:11.402113Z",
  "records": [
    {
      "uuid": "1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b",
      "record_type": "NS",
      "name": "@",
      "value": "ns1.vps.org",
      "ttl": 86400,
      "priority": null,
      "created_at": "2026-09-14"
    },
    ...
  ],
  "record_count": 3
}

Koodhadhka Xaaladda Jawaab celinta

201	Gobol la abuuray
400	Magaca domainka oo maqan ama aan sax ahayn

HEL /api/v1/dns-zones/{uuid}/

Ka hesho DNS Zone Faahfaahinta

Ku soo laabtay mid ka mid ah dhul oo leh dhammaan diiwaanada ku qoran diiwaanada aray. jawaabta waxaa leh qaabka la mid ah sida jawaabta abuuro kor ku xusan.

curl -X GET "https://admin.vps.org/api/v1/dns-zones/c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Koodhadhka Xaaladda Jawaab celinta

200	Guul
404	Ma la helin, ama waxay ka tirsan tahay xisaab kale

TIRTIR /api/v1/dns-zones/{uuid}/

Dib u celi

Ka saaraa gobolka ka saddexda servers magacyada oo dhan, tijaabooyin in mid ka mid ah weli u adeego, ka dibna tirtirto gobolka iyo diiwaanada. Haddii server magacyada weli u jawaabo gobolka, codsiga ku fashilmaan iyo gobolka waa la hayaa si aad u isku dayi kartaa.

curl -X DELETE "https://admin.vps.org/api/v1/dns-zones/c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Koodhadhka Xaaladda Jawaab celinta

204	La tiriyay. Jawaabtu ma laha jir.
400	A server magac weli adeega dhul. Dhulka ma la tirtiro; the details field liiska khaladaadka.
404	Ma la helin, ama waxay ka tirsan tahay xisaab kale

HEL BOOQO /api/v1/dns-zones/{uuid}/records/

Liiska ama ku dar diiwaanada in Zone

GET ku soo laabto diiwaan kasta oo gobolka sidarray caadi ah (aan paginated), oo loo kala saaro oo ku saleysan nooca iyo magaca. POST ku daray diiwaanka ee gobolka iyo daabacaadda.

Codso Cabbirrada Jirka (POST)

_Barnaamijyada	Nooca	Loo baahan yahay	Tilmaamaha
`record_type`	string	Haa	A, AAAA, CNAME, MX, NS, TXT, SRV, PTR, SOA, CAA
`name`	string	Haa	@ ee domain isaga, ama calaamad sida www. Magaca waxaa lagu kaydiyaa letters yar.
`value`	string	Haa	xogta diiwaanka, tusaale ahaan, cinwaanka IP ama magac martida ah. Hostnames ma u baahan yihiin dhibic ka dib iyo qiimaha TXT ma u baahan yihiin in la soo jeediyo; labadaba waxaa lagu daray marka diiwaanka la daabacay.
`ttl`	integer	Haa	Waqtiga uu noolaanayo daqiiqado
`priority`	integer	MX iyo SRV oo keliya	Waa in loo baahan yahay in MX iyo SRV diiwaanada iyo la iska indho tiray oo ah nooc kasta oo kale. SRV, ku shub miisaanka, dekedda iyo ujeedada qiimaha.

Codsi Tusaale ah

cURL

Python

curl -X POST "https://admin.vps.org/api/v1/dns-zones/c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c/records/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"record_type": "MX", "name": "@", "value": "mail.example.com", "ttl": 3600, "priority": 10}'

import requests

zone_uuid = "c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c"
url = f"https://admin.vps.org/api/v1/dns-zones/{zone_uuid}/records/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
data = {"record_type": "A", "name": "www", "value": "203.0.113.10", "ttl": 3600}

response = requests.post(url, headers=headers, json=data)
print(response.status_code, response.json())

Jawaabta Tusaale

{
  "uuid": "9d430082-5562-42b4-a0b2-12a6f6c862f9",
  "record_type": "MX",
  "name": "@",
  "value": "mail.example.com",
  "ttl": 3600,
  "priority": 10,
  "created_at": "2026-09-14"
}

Goobaha Jawaabta

Isku-darka	Nooca	Tilmaamaha
`uuid`	string	aqoonyahanka diiwaanka, waxaa isticmaala /api/v1/dns-records/ endpoints
`priority`	integer \| null	Horumarinta diiwaanada MX iyo SRV, haddii kale waa null
`created_at`	date	Maalinta abuurista oo keliya (Y-MM-DD), waqti la'aan

Koodhadhka Xaaladda Jawaab celinta

200	GET: diiwaanada gobolka
201	POST: diiwaanka la abuuray
400	Xaaladda xadgudubka, tusaale ahaan nooc diiwaanka aan la aqoon, ttl la'aan, ama MX ama SRV diiwaanka aan la hormariyo
404	Ma la helin, ama waxay ka tirsan tahay xisaab kale

BOOQO /api/v1/dns-zones/{uuid}/sync/

Soo Celinta Soo bandhiga Zone

Isku soo wada duuboo, waa in aad si joogto ah u akhrido, laakiin waa in aad si joogto ah u akhrido, haddii kale waxaad u baahan tahay inaad dib u eegto. Waxaa jira waxyaabo badan oo aad u baahan tahay in aad ogaato ka hor inta aadan bilaabin inaad akhrido.

curl -X POST "https://admin.vps.org/api/v1/dns-zones/c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c/sync/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  "detail": "Zone example.com synced to PowerDNS"
}

HEL BOOQO /api/v1/dns-records/

Liiska ama abuuro diiwaanada ka dhex Zones

GET ku soo laabtay diiwaanada dhammaan goboladaada, 25 bogga, oo ay ku qoran yihiin domain, nooc iyo magaca. POST abuuraa diiwaan sida gobolada diiwaanada endpoint, laakiin wuxuu qaataa gobolka ee jirka sida zone_uuid.

Cabbirrada Weydiinta

_Barnaamijyada	Nooca	Loo baahan yahay	Tilmaamaha
`zone`	string	Ha	Xisaabaadka oo keliya ee gobolka leh uuidkan
`record_type`	string	Ha	Xisaabaadka oo keliya oo noocan ah, tusaale ahaan MX (case insensitive)
`page`	integer	Ha	Tirada bog, ka bilow 1

curl -X GET "https://admin.vps.org/api/v1/dns-records/?zone=c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c&record_type=A" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

curl -X POST "https://admin.vps.org/api/v1/dns-records/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"zone_uuid": "c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c", "record_type": "TXT", "name": "@", "value": "v=spf1 mx -all", "ttl": 3600}'

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "4b8e2c10-7d3f-4a5b-9e6c-1a2b3c4d5e6f",
      "record_type": "A",
      "name": "www",
      "value": "203.0.113.10",
      "ttl": 3600,
      "priority": null,
      "created_at": "2026-09-14"
    }
  ]
}

Koodhadhka Xaaladda Jawaab celinta

200	Guul
201	POST: diiwaanka la abuuray
400	Xaaladda xaqiijinta, ama zone_uuid waa ka maqan yahay ama ma aha mid ka mid ah goboladaada

HEL PUT PATCH TIRTIR /api/v1/dns-records/{uuid}/

Ka hel, cusbooneysiinta ama tirtirka diiwaanka

GET soo celin doonaa diiwaanka mid ka mid ah. PUT bedelkeeda iyo baahida record_type, magac, qiimaha iyo ttl. PATCH kaliya isbeddelo meelaha aad soo dirto. DELETE soo celin doonaa diiwaanka iyo soo celin doonaa 204 la jirka aan. Isbedelada waxaa la daabacay isla markiiba. NS diiwaanada la abuuray oo la dhul waa diiwaanada nidaamka: cusbooneysiinta ama tirtirka iyaga soo celin doonaa 403.

Marka aad PATCH muhiimadda MX ama SRV diiwaanka, soo dir record_type in codsiga la mid ah. A PATCH jirka la muhiimadda laakiin aan record_type ka saaraa muhiimadda.

curl -X PATCH "https://admin.vps.org/api/v1/dns-records/4b8e2c10-7d3f-4a5b-9e6c-1a2b3c4d5e6f/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ttl": 300}'

Koodhadhka Xaaladda Jawaab celinta

200	GET, PUT ama PATCH: diiwaanka
204	La tiriyay. Jawaabtu ma laha jir.
400	Xaaladda
403	diiwaanka waa diiwaanka nidaamka, ama calaamadda ma laha oggolaanshaha loo baahan yahay
404	Ma la helin, ama waxay ka tirsan tahay xisaab kale

Xakamaynta khaladaadka

Xaaladda qaldan ee xaqiijinta ku soo laabtaan 400 la dhibaatada keyded by magaca goobta:

{
  "priority": ["MX records require a priority value"]
}

Imtixaan DNS Isbedelada

Su'aalo VPS.org servers magacyada si toos ah u xaqiijiyaan in isbedelka waa nool ka hor inta aad wakiilka diiwaanka ama resolver caches soo qabto:

dig @ns1.vps.org example.com A
dig @ns2.vps.org example.com MX
dig @ns3.vps.org www.example.com

VPS.org API

Maareynta DNS API

Dulmar Guud

Liis garee Dhammaan Aagagga DNS

Cabbirrada Weydiinta

Codsi Tusaale ah

Jawaabta Tusaale

Goobaha Jawaabta

Koodhadhka Xaaladda Jawaab celinta

abuuro DNS Zone

Codso Cabbirrada Jirka

Jawaabta Tusaale

Koodhadhka Xaaladda Jawaab celinta

Ka hesho DNS Zone Faahfaahinta

Koodhadhka Xaaladda Jawaab celinta

Dib u celi

Koodhadhka Xaaladda Jawaab celinta

Liiska ama ku dar diiwaanada in Zone

Codso Cabbirrada Jirka (POST)

Codsi Tusaale ah

Jawaabta Tusaale

Goobaha Jawaabta

Koodhadhka Xaaladda Jawaab celinta

Soo Celinta Soo bandhiga Zone

Liiska ama abuuro diiwaanada ka dhex Zones

Cabbirrada Weydiinta

Koodhadhka Xaaladda Jawaab celinta

Ka hel, cusbooneysiinta ama tirtirka diiwaanka

Koodhadhka Xaaladda Jawaab celinta

Xakamaynta khaladaadka

Imtixaan DNS Isbedelada