VPS.org API

REST API Xuquuqda

Maareynta DNS API

Maamul aagagga DNS iyo diiwaannada si barnaamij ah oo loogu talagalay domains-kaaga.

Dhammaadka 4 dhibcood oo dhammaystiran
Waddo Saldhig ah /api/v1/dns-zones
Xaqiijinta Waa in la adeegsadaa

Dulmar Guud

DNS API bixiya maareynta buuxda ee gobollada DNS iyo diiwaanada. Gobollada oo dhan waxaa lagu martiqaadayaa servers VPS.org ee magacyada awoodda leh oo leh abuurista iyo soo bandhigida faylka BIND9 ee otomaatiga ah.

Adeegga server-ka magacyada

Sifooyinka muhiimka ah

Xaqiijinta

DNS API dhammaan codsiyada u baahan yihiin Bearer token xaqiijinta. soo saaro API tokens ka dashboard xisaabtaada at /account/developers/ la idmooyinka soo socda:

tusaale

Authorization: Bearer vps_abc123def456...
Wax muhiim ah: API tokens waxaa lagu muujiyaa kaliya mar abuurka. kaydinta iyaga si ammaan ah. Haddii aad ku lumiso token, waa inaad abuurtaa mid cusub.
HEL /api/v1/dns-zones/

Liis garee Dhammaan Aagagga DNS

Soo kabsado liiska pageted ee dhammaan gobollada DNS ay leeyihiin user authenticated. taageertaa filtering by magac domain.

Cabbirrada Weydiinta

_Barnaamijyada Nooca Loo baahan yahay Tilmaamaha
domain string Ha Filter zones by exact domain name (e.g., example.com)

Codsi Tusaale ah

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/dns-zones/" \
  -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)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/dns-zones/', {
  headers: {'Authorization': 'Bearer YOUR_API_TOKEN'}
});

const zones = await response.json();
console.log(zones);

Jawaabta Tusaale

[
  {
    "uuid": "abc123-def456-ghi789",
    "domain": "example.com",
    "created_at": "2024-01-15T10:30:00Z",
    "record_count": 12
  },
  {
    "uuid": "xyz789-uvw456-rst123",
    "domain": "myapp.io",
    "created_at": "2024-06-20T14:15:00Z",
    "record_count": 8
  }
]

Goobaha Jawaabta

Isku-darka Nooca Tilmaamaha
uuid string Unique zone identifier (used in API requests)
domain string Domain name for this DNS zone
created_at datetime Zone creation timestamp (ISO 8601 format)
record_count integer Total number of DNS records in this zone

Koodhadhka Xaaladda Jawaab celinta

200 Successfully retrieved DNS zones list
401 Unauthorized - Invalid or missing API token
403 Forbidden - Token lacks dns:list permission
HEL /api/v1/dns-zones/{uuid}/

Ka hesho DNS Zone Faahfaahinta

Soo kabsado macluumaad faahfaahsan oo ku saabsan dhul DNS gaar ah, oo ay ku jiraan diiwaanada oo dhan.

Halbeegyada Wadada

_Barnaamijyada Nooca Loo baahan yahay Tilmaamaha
uuid string Haa Unique zone identifier

Jawaabta Tusaale

{
  "uuid": "abc123-def456-ghi789",
  "domain": "example.com",
  "created_at": "2024-01-15T10:30:00Z",
  "record_count": 5,
  "records": [
    {
      "uuid": "rec-001",
      "record_type": "A",
      "name": "@",
      "value": "192.0.2.1",
      "ttl": 3600,
      "priority": null,
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "uuid": "rec-002",
      "record_type": "MX",
      "name": "@",
      "value": "mail.example.com",
      "ttl": 3600,
      "priority": 10,
      "created_at": "2024-01-15T10:32:00Z"
    }
  ]
}

Koodhadhka Xaaladda Jawaab celinta

200 Successfully retrieved zone details
404 Zone not found or not owned by user
BOOQO /api/v1/dns-zones/

abuuro DNS Zone

Abuur meel cusub oo DNS ah domain. Zone la soo bandhigi doonaa si deg deg ah VPS.org servers.

Codso Cabbirrada Jirka

_Barnaamijyada Nooca Loo baahan yahay Tilmaamaha
domain string Haa Domain name (e.g., example.com)

Codsi Tusaale ah

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

url = "https://admin.vps.org/api/v1/dns-zones/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {"domain": "newdomain.com"}

response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/dns-zones/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({domain: 'newdomain.com'})
});

const zone = await response.json();
console.log(zone);

Jawaabta Tusaale

{
  "uuid": "new-zone-uuid",
  "domain": "newdomain.com",
  "created_at": "2026-01-18T16:45:00Z",
  "record_count": 0,
  "records": []
}

Koodhadhka Xaaladda Jawaab celinta

201 DNS zone created successfully
400 Bad Request - Invalid domain name or zone already exists
403 Forbidden - Token lacks dns:create permission
TIRTIR /api/v1/dns-zones/{uuid}/

Dib u celi

Si joogto ah u tirtirta dhul DNS iyo dhammaan diiwaanada la xiriira. Falkan ma aha in la joojiyo.

Halbeegyada Wadada

_Barnaamijyada Nooca Loo baahan yahay Tilmaamaha
uuid string Haa Unique zone identifier

Koodhadhka Xaaladda Jawaab celinta

204 Zone deleted successfully (no response body)
403 Forbidden - Token lacks dns:delete permission
404 Zone not found
HEL /api/v1/dns-zones/{uuid}/records/

Liiska DNS Records in Zone

Soo kabsado dhammaan diiwaanada DNS ee dhul gaar ah (jidka ku jira).

Halbeegyada Wadada

_Barnaamijyada Nooca Loo baahan yahay Tilmaamaha
uuid string Haa Zone UUID

Codsi Tusaale ah

curl -X GET "https://admin.vps.org/api/v1/dns-zones/{uuid}/records/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Jawaabta Tusaale

[
  {
    "uuid": "rec-001",
    "record_type": "A",
    "name": "@",
    "value": "192.0.2.1",
    "ttl": 3600,
    "priority": null,
    "created_at": "2024-01-15T10:30:00Z"
  },
  {
    "uuid": "rec-002",
    "record_type": "MX",
    "name": "@",
    "value": "mail.example.com",
    "ttl": 3600,
    "priority": 10,
    "created_at": "2024-01-15T10:32:00Z"
  }
]
BOOQO /api/v1/dns-zones/{uuid}/records/

abuuro DNS Record in Zone

Ku dar diiwaanka DNS cusub in dhul gaar ah (jidka nested).

Codso Cabbirrada Jirka

_Barnaamijyada Nooca Loo baahan yahay Tilmaamaha
record_type string Haa Record type: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA
name string Haa Record name (@ for root, subdomain, or FQDN)
value string Haa Record value (IP address, hostname, text)
ttl integer No Time to live in seconds (default: 3600)
priority integer For MX/SRV Priority (required for MX and SRV records)

Codsi Tusaale ah

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/dns-zones/{uuid}/records/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "record_type": "A",
    "name": "www",
    "value": "192.0.2.1",
    "ttl": 3600
  }'
import requests

url = f"https://admin.vps.org/api/v1/dns-zones/{zone_uuid}/records/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "record_type": "A",
    "name": "www",
    "value": "192.0.2.1",
    "ttl": 3600
}

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

Koodhadhka Xaaladda Jawaab celinta

201 DNS record created successfully
400 Bad Request - Invalid parameters or validation error (e.g., MX record missing priority)
GET PUT PATCH DELETE /api/v1/dns-records/{uuid}/

Maareynta DNS Records (Adeegga Tooska ah)

Fulinta hawlgalka CRUD on diiwaanada DNS shakhsiga ah oo isticmaalaya diiwaanka UUID.

Shaqada la heli karo

Su'aal Parameters (u GET /api/v1/dns-records /)

Parameter Nooca Tilmaamaha
zone string Filter records by zone UUID
record_type string Filter by record type (A, AAAA, MX, etc.)

tusaale: Update TTL of Record

curl -X PATCH "https://admin.vps.org/api/v1/dns-records/{rec-uuid}/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ttl": 1800}'

Supported DNS Record Types

Nooca Purpose Example Value Priority Required
A Maps domain to IPv4 address 192.0.2.1 Ha
AAAA Maps domain to IPv6 address 2001:0db8::1 Ha
CNAME Creates alias to another domain example.com Ha
MX Mail server for domain mail.example.com Haa
TXT Text record (SPF, DKIM, verification) v=spf1 include:_spf.google.com ~all Ha
NS Nameserver delegation ns1.example.com Ha
SRV Service location record 10 5060 sip.example.com Haa
CAA Certificate authority authorization 0 issue "letsencrypt.org" Ha

Hababka ugu Fiican

Nidaamka TTL

Noocyada caadiga ah

Ammaanka

Xakamaynta khaladaadka

Falalka caadiga ah

Koodhka Xaaladda Xadgudub Xalka
400 Magaca domain-ka ma habboona Hubi domain raacaa heshiisyada magacyada DNS
400 MX record requires priority Ku dar priority goobta MX iyo SRV diiwaanada
401 Token API oo aan sharci ahayn Tijaabi qaabka calaamadda (waxaa lagama maarmaan ah in la bilaabo vps_)
403 Xuquuqda la'aan Samee calaamad cusub oo la doonayo dns:* xuquuqda
404 Gobol/rekor aan la helin xaqiiji UUID iyo hubi in kaydku ku lug leeyahay xisaabtaada

Jawaab Faahfaahsan

{
  "detail": "MX records require a priority value",
  "error_code": "validation_error",
  "field": "priority"
}

Imtixaan DNS Isbedelada

Ka hubi in la kordhiyay

# Query A record
dig example.com A

# Query specific nameserver
dig @ns1.vps.org example.com

# Query MX records
dig example.com MX

# Check all records
dig example.com ANY

Kaararka Online