VPS.org API

Dokumentazzjoni tal-REST API

API tal-Ġestjoni tad-DNS

Oħloq żoni DNS u jimmaniġġjaw rekords tagħhom.Żoni huma serviti minn ns1.vps.org, ns2.vps.org u ns3.vps.org.

Punti tat-tmiem 13
Mogħdija Bażika /api/v1/dns-zones, /api/v1/dns-records

Ħarsa ġenerali

Żona waħda fiha r-rekords għal dominju wieħed. Kull bidla li tagħmel permezz tal-API tiġi mġiegħla fil-nameservers VPS.org mill-ewwel. Biex isservi dominju minn dawn iż-żoni, issettja l-nameservers tiegħu fir-reġistru tiegħek għal ns1.vps.org, ns2.vps.org u ns3.vps.org.

Il-bidliet huma salvati u ppubblikati f'pass wieħed: jekk is-servers tal-isem jirrifjutaw bidla, it-talba tirritorna 502 u xejn ma jiġi salvat.Żona ma tistax tinħoloq għal dominju li kont ieħor diġà jamministra, ġenitur jew tifel ta' kont ieħor taż-żona, jew isem riżervat VPS.org.

Permess meħtieġ: dns:list (GET), dns:create (POST), dns:update (PUT, PATCH, sync), dns:delete (DELETE), dns:*

IKSEB /api/v1/dns-zones/

Elenka ż-Żoni DNS Kollha

Jirritorna ż-żoni tiegħek, l-aktar ġodda ewwel, 25 kull paġna. Rekords mhumiex inklużi hawn; getch żona waħda biex tikseb minnhom.

Parametri tal-Mistoqsija

Parametru Tip Meħtieġ Deskrizzjoni
domain string Nru Ir-ritorn biss iż-żona b'dan eżattament l-isem tad-dominju
page integer Nru Numru tal-paġna, li jibda minn 1

Eżempju ta' Talba

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

Eżempju ta' Rispons

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

Oqsma ta' Rispons

Qasam Tip Deskrizzjoni
uuid string Identifikatur taż-żona
domain string Isem tad-dominju, maħżun f'ittri żgħar
created_at datetime Ħin tal-ħolqien (ISO 8601, UTC)
record_count integer Numru ta’ rekords fiż-żona, inklużi t-tliet rekords NS

Kodiċijiet tal-Istatus tar-Rispons

200 Suċċess
403 Token tal-API nieqes jew invalidu, jew it-token ma għandux il-permess meħtieġ
POST /api/v1/dns-zones/

Oħloq Żona DNS

Iż-żona tibda bi tliet rekords NS għal ns1, ns2 u ns3.vps.org, li huma rekords tas-sistema u ma jistgħux jiġu editjati jew imħassra.

Parametri tal-Korp tat-Talba

Parametru Tip Meħtieġ Deskrizzjoni
domain string Iva L-isem tad-dominju, pereżempju 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"}'

Eżempju ta' Rispons

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

Kodiċijiet tal-Istatus tar-Rispons

201 Żona maħluqa
400 Isem ta' dominju nieqes jew invalidu
IKSEB /api/v1/dns-zones/{uuid}/

Ikseb id-Dettalji taż-Żona DNS

Jirritorna żona waħda b’rekords kollha tagħha f’matriċi rekords.It-tweġiba għandha l-istess forma bħall-ħolqien tweġiba hawn fuq.

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

Kodiċijiet tal-Istatus tar-Rispons

200 Suċċess
404 Ma nstabx, jew jappartjeni għal kont ieħor
ĦASSAR /api/v1/dns-zones/{uuid}/

Ħassar Żona DNS

Tneħħi ż-żona mit-tliet nameservers kollha, tiċċekkja li l-ebda wieħed minnhom għadu jserviha, u mbagħad tħassar iż-żona u r-rekords tagħha.Jekk nameserver għadu jwieġeb għaż-żona, it-talba tfalli u ż-żona tinżamm sabiex tkun tista' terġa' tipprova.

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

Kodiċijiet tal-Istatus tar-Rispons

204 Mħassar. It-tweġiba m’għandhiex korp.
400 Iż-żona ma tħassritx; il-qasam tad-dettalji jelenka l-iżbalji.
404 Ma nstabx, jew jappartjeni għal kont ieħor
IKSEB POST /api/v1/dns-zones/{uuid}/records/

Lista jew Żid rekords fiż-żona

GET tirritorna kull rekord fiż-żona bħala array sempliċi (mhux paginated), magħżula skond it-tip u l-isem.POST żżid rekord għaż-żona u tippubblikah.

Parametri tal-Korp tat-Talba (POST)

Parametru Tip Meħtieġ Deskrizzjoni
record_type string Iva A, AAAA, CNAME, MX, NS, TXT, SRV, PTR, SOA, CAA
name string Iva @ għad-dominju nnifsu, jew tikketta bħal www. Ismijiet huma maħżuna f'ittri żgħar.
value string Iva Id-dejta tar-rekord, pereżempju indirizz IP jew hostname. Hostnames ma jeħtieġu l-ebda punt wara u valuri TXT ma jeħtieġu l-ebda kwotazzjonijiet; it-tnejn huma miżjuda meta r-rekord huwa ppubblikat.
ttl integer Iva Ħin biex jgħixu f'sekondi
priority integer MX u SRV biss Meħtieġa għall-MX u SRV rekords u injorati għal kull tip ieħor.Għal SRV, tpoġġi piż, port u l-mira fil-valur.

Eżempju ta' Talba

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

Eżempju ta' Rispons

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

Oqsma ta' Rispons

Qasam Tip Deskrizzjoni
uuid string Identifikatur tar-rekord, użat mill-punti aħħarin /api/v1/dns-records/
priority integer | null Prijorità għar-rekords MX u SRV, inkella null
created_at date Data tal-ħolqien biss (S-MM-DD), mingħajr ħin

Kodiċijiet tal-Istatus tar-Rispons

200 GET: ir-rekords taż-żona
201 POST: rekord maħluqa
400 Żball ta' validazzjoni, pereżempju tip ta' rekord mhux magħruf, ttl nieqes, jew rekord MX jew SRV mingħajr prijorità
404 Ma nstabx, jew jappartjeni għal kont ieħor
POST /api/v1/dns-zones/{uuid}/sync/

Ippubblika mill-ġdid Żona

Iġbed iż-żona u r-rekords kollha tagħha lejn l-nameservers mill-ġdid. Il-bidliet fir-rekord huma ppubblikati awtomatikament, iżda l-pubblikazzjoni hija l-aħjar sforz u falliment ma jonqosx it-talba oriġinali, għalhekk uża dan meta bidla ma tidherx fit-tiftix tad-DNS. L-ebda korp tat-talba mhu meħtieġ.

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"
}
IKSEB POST /api/v1/dns-records/

Lista jew Oħloq rekords Madwar Żoni

GET tirritorna r-rekords taż-żoni kollha tiegħek, 25 għal kull paġna, ordnati skont id-dominju, it-tip u l-isem.POST joħloq rekord bħall-punt aħħari tar-rekords taż-żona, iżda jieħu ż-żona fil-korp bħala zone_uuid.

Parametri tal-Mistoqsija

Parametru Tip Meħtieġ Deskrizzjoni
zone string Nru Ir-rekords biss taż-żona b'dan l-uuid
record_type string Nru Rekords ta’ dan it-tip biss, pereżempju MX (każ insensittiv)
page integer Nru Numru tal-paġna, li jibda minn 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"
    }
  ]
}

Kodiċijiet tal-Istatus tar-Rispons

200 GET: suċċess
201 POST: rekord maħluqa
400 Żball ta’ validazzjoni, jew zone_uuid huwa nieqes jew mhux wieħed miż-żoni tiegħek
IKSEB PUT PATCH ĦASSAR /api/v1/dns-records/{uuid}/

Ikseb, Aġġorna jew Ħassar Reġistrazzjoni

GET jirritorna rekord wieħed. PUT jissostitwixxi dan u jeħtieġ record_type, isem, valur u ttl. PATCH bidliet biss l-oqsma inti tibgħat. DELETE tneħħi r-rekord u jirritorna 204 mingħajr korp. Tibdiliet huma ppubblikati immedjatament. Ir-rekords NS maħluqa maż-żona huma rekords tas-sistema: aġġornament jew tħassir tagħhom jirritorna 403.

Meta inti PATCH-prijorità ta'rekord MX jew SRV, jibgħat record_type fl-istess talba.A korp PATCH bil-prijorità iżda mingħajr record_type ċar il-prijorità. 
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}'

Kodiċijiet tal-Istatus tar-Rispons

200 GET, PUT jew PATCH: ir-rekord
204 Mħassar. It-tweġiba m’għandhiex korp.
400 Żball ta’ validazzjoni
403 Ir-rekord huwa rekord tas-sistema, jew it-token m'għandux il-permess meħtieġ
404 Ma nstabx, jew jappartjeni għal kont ieħor

Immaniġġjar ta’ żbalji

Validazzjoni żbalji ritorn 400 mal-problema keyed mill-isem qasam:

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

Ittestjar tal-Bidliet tad-DNS

Mistoqsija l-VPS.org nameservers direttament biex tikkonferma bidla hija ħajjin qabel id-delegazzjoni reġistratur tiegħek jew caches resolver jaqbdu up:

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