VPS.org API

Doiciméadú API REST

API Bainistíochta DNS

Bainistigh criosanna agus taifid DNS go clársceidealaithe do do fhearainn.

Críochphointí 4 chríochphointe
Cosán Bonn /api/v1/dns-zones
Fíordheimhniú Comhartha Bearta de Dhíth

Forbhreathnú

Tá gach crios á óstáil ar fhreastalaithe ainmneacha údarásach VPS.org le giniúint agus imscaradh uathoibríoch comhad crios BIND9.

Innealra Ainmfhreastalaí

Príomhghnéithe

Fíordheimhniú

Éilíonn gach iarratas API DNS fíordheimhniú comhartha Bearer.Gineann comharthaí API ó do phainéal cuntas ag /account/developers/ leis na ceadanna seo a leanas:

Sampla

Authorization: Bearer vps_abc123def456...
Tábhachtach: Ní thaispeántar comharthaí API ach uair amháin le linn a gcruthaithe. Stóráil iad go sábháilte. Má chailleann tú comhartha, caithfidh tú ceann nua a ghiniúint.
FAIGH /api/v1/dns-zones/

Liostaigh Gach Crios DNS

Faigh liosta leathanacháilte de na criosanna DNS atá faoi úinéireacht an úsáideora fhíordheimhnithe. Tacaíonn sé le scagadh de réir ainm fearainn.

Paraiméadair Iarratais

Paraiméadair Cineál Riachtanach Cur Síos
domain string & Ná Sábháil Filter zones by exact domain name (e.g., example.com)

Iarratas Samplach

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

Freagra Samplach

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

Réimsí Freagartha

Réimse Cineál Cur Síos
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

Cóid Stádas Freagartha

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

Faigh Mionsonraí an Chrios DNS

Faigh eolas mionsonraithe faoi chrios DNS ar leith, lena n-áirítear gach taifead.

Paraiméadair na gCosán

Paraiméadair Cineál Riachtanach Cur Síos
uuid string Tá Unique zone identifier

Freagra Samplach

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

Cóid Stádas Freagartha

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

Cruthaigh Crios DNS

Cruthaigh crios DNS nua le haghaidh fearainn. Déanfar an crios a imscaradh láithreach chuig VPS.org freastalaí ainm.

Paraiméadair Chomhlacht an Iarratais

Paraiméadair Cineál Riachtanach Cur Síos
domain string Tá Domain name (e.g., example.com)

Iarratas Samplach

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

Freagra Samplach

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

Cóid Stádas Freagartha

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

Scrios Crios DNS

Scrios crios DNS agus gach taifead gaolmhar go buan. Ní féidir an gníomh seo a chealú.

Paraiméadair na gCosán

Paraiméadair Cineál Riachtanach Cur Síos
uuid string Tá Unique zone identifier

Cóid Stádas Freagartha

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

Liosta Taifid DNS i gCrios

Aisghabháil gach taifead DNS do chrios ar leith (bealach neadaithe).

Paraiméadair na gCosán

Paraiméadair Cineál Riachtanach Cur Síos
uuid string Tá Zone UUID

Iarratas Samplach

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

Freagra Samplach

[
  {
    "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"
  }
]
POST /api/v1/dns-zones/{uuid}/records/

Cruthaigh Taifead DNS i gCrios

Cuir taifead DNS nua le crios ar leith (bealach neadaithe).

Paraiméadair Chomhlacht an Iarratais

Paraiméadair Cineál Riachtanach Cur Síos
record_type string Tá Record type: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA
name string Tá Record name (@ for root, subdomain, or FQDN)
value string Tá 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)

Iarratas Samplach

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

Cóid Stádas Freagartha

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}/

Taifid DNS a bhainistiú (Rochtain Dhíreach)

Oibríochtaí CRUD iomlán ar thaifid DNS aonair ag baint úsáide as UUID taifead.

Oibríochtaí atá ar Fáil

Paraiméadair Iarratas (le haghaidh GET / api / v1 / dns- taifid /)

Parameter Cineál Cur Síos
zone string Filter records by zone UUID
record_type string Filter by record type (A, AAAA, MX, etc.)

Sampla: Nuashonraigh TTL Taifead

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

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

Dea-chleachtais

Cumraíocht TTL

Coitianta

Slándáil

Láimhseáil Earráidí

Earráidí Coitianta

Cód Stádais Earráid Réiteach
400 Ainm neamhbhailí fearainn Cinntigh go leanann fearann coinbhinsiúin ainmniúcháin DNS
400 Tosaíocht de dhíth ar thaifead MX Cuir san áireamh priority réimse le haghaidh taifid MX agus SRV
401 Comhartha neamhbhailí API Formáid an chomhartha seiceáilte (ní mór tús a chur le vps_)
403 Cead ar iarraidh Gineann comhartha nua le riachtanas dns:* Ceadanna
404 Crios/taifead gan aimsiú Fíoraigh UUID agus cinntigh go mbaineann an acmhainn le do chuntas

Freagra Earráid Samplach

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

Athruithe DNS á dtástáil

Fíoraigh Iolrú Taifead

# 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

Ag baint úsáide as Uirlisí ar Líne