VPS.org API

REST API દસ્તાવેજીકરણ

DNS મેનેજમેન્ટ API

DNS ક્ષેત્રો બનાવો અને તેમના રેકોર્ડોનું સંચાલન કરો. ક્ષેત્રો ns1.vps.org, ns2.vps.org અને ns3.vps.org દ્વારા સેવા આપેલ છે.

અંતિમ બિંદુઓ 13
બેઝ પાથ /api/v1/dns-zones, /api/v1/dns-records

ઝાંખી

ક્ષેત્ર એક ડોમેઇન માટે રેકોર્ડ્સ ધરાવે છે. તમે API મારફતે કરેલ દરેક ફેરફાર VPS.org નામ સર્વરોને તરત જ દબાવી દેવામાં આવે છે. આ ક્ષેત્રોમાંથી ડોમેઇનને સેવા આપવા માટે, તમારા રજિસ્ટ્રાર પર તેના નામ સર્વરોને ns1.vps.org, ns2.vps.org અને ns3.vps.org પર સુયોજિત કરો.

ફેરફારો એક પગથિયે સંગ્રહાયેલ છે અને પ્રકાશિત થયેલ છે: જો નામ સર્વર ફેરફારનો ઇનકાર કરે, તો વિનંતી 502 પાછી આપે છે અને કંઇક સંગ્રહાયેલ નથી. ડોમેઇન માટે ક્ષેત્ર બનાવી શકાતુ નથી કે જે બીજા ખાતાનું પહેલેથી સંચાલન કરે છે, બીજા ખાતાના ક્ષેત્રનું પિતૃ અથવા બાળ, અથવા VPS.org સંગ્રહાયેલ નામ.

જરૂરી પરવાનગી: dns:list (GET), dns:create (POST), dns:update (PUT, PATCH, sync), dns:delete (DELETE), dns:*

મેળવો /api/v1/dns-zones/

બધા DNS ઝોનની યાદી બનાવો

તમારા ક્ષેત્રો પાછા આપે છે, નવી પહેલી, પાના પર ૨૫. રેકોર્ડ્સ અહીં સમાવેલ નથી; તેમને મેળવવા માટે એક જ ક્ષેત્રને મેળવો.

ક્વેરી પરિમાણો

પરિમાણો પ્રકાર જરૂરી વર્ણન
domain string નહિં માત્ર આ ડોમેઇન નામ સાથે જ ક્ષેત્ર પાછું લાવો
page integer નહિં પાનાં નંબર, ૧ થી શરૂ થાય છે

ઉદાહરણ વિનંતી

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

ઉદાહરણ પ્રતિભાવ

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

પ્રતિભાવ ક્ષેત્રો

ક્ષેત્ર પ્રકાર વર્ણન
uuid string ક્ષેત્ર ઓળખનાર
domain string ડોમેઇન નામ, નાનાં અક્ષરોમાં સંગ્રહાયેલ
created_at datetime બનાવટ સમય (ISO 8601, UTC)
record_count integer ક્ષેત્રમાં રેકોર્ડોની સંખ્યા, ત્રણ NS રેકોર્ડો સમાવે છે

પ્રતિભાવ સ્થિતિ કોડ્સ

200 સફળતા
403 ગુમ થયેલ અથવા અયોગ્ય API ટોકન, અથવા ટોકન પાસે જરૂરી પરવાનગી નથી
પોસ્ટ /api/v1/dns-zones/

DNS ક્ષેત્ર બનાવો

ક્ષેત્ર બનાવે છે અને તેને પ્રકાશિત કરે છે. ક્ષેત્ર ns1, ns2 અને ns3.vps.org માટે ત્રણ NS રેકોર્ડ સાથે શરૂ થાય છે, જે સિસ્ટમ રેકોર્ડ છે અને ફેરફાર કરી શકાતા નથી અથવા કાઢી શકાતા નથી.

બોડી પેરામીટર્સની વિનંતી કરો

પરિમાણો પ્રકાર જરૂરી વર્ણન
domain string હા ડોમેઇન નામ, ઉદાહરણ તરીકે 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"}'

ઉદાહરણ પ્રતિભાવ

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

પ્રતિભાવ સ્થિતિ કોડ્સ

201 ક્ષેત્ર બનાવેલ છે
400 ગુમ થયેલ અથવા અયોગ્ય ડોમેઇન નામ
મેળવો /api/v1/dns-zones/{uuid}/

DNS ક્ષેત્ર વિગતો મેળવો

રેકોર્ડ એરેમાં તેના બધા રેકોર્ડ સાથે એક ક્ષેત્ર પાછું આપે છે. જવાબ ઉપરના બનાવો જવાબ જેવો જ આકાર છે.

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

પ્રતિભાવ સ્થિતિ કોડ્સ

200 સફળતા
404 મળ્યુ નથી, અથવા તે બીજા ખાતાને લગતુ છે
કાઢી નાખો /api/v1/dns-zones/{uuid}/

DNS ક્ષેત્ર કાઢી નાંખો

બધા ત્રણ નામ સર્વરમાંથી ક્ષેત્ર દૂર કરે છે, ચકાસે છે કે તેમાંથી કોઈપણ હજુ તેને સેવા આપે છે, અને પછી ક્ષેત્ર અને તેના રેકોર્ડ્સ કાઢી નાંખે છે. જો નામ સર્વર હજુ પણ ક્ષેત્ર માટે જવાબ આપે છે, તો વિનંતી નિષ્ફળ જાય છે અને ક્ષેત્ર રાખેલ છે જેથી તમે ફરીથી પ્રયત્ન કરી શકો.

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

પ્રતિભાવ સ્થિતિ કોડ્સ

204 કાઢી નાંખેલ. જવાબ પાસે કોઇ શરીર નથી.
400 નામ સર્વર હજુ પણ ક્ષેત્રને સેવા આપે છે. ક્ષેત્ર કાઢી નંખાયું નહિં; વિગતો ક્ષેત્ર ભૂલોની યાદી કરે છે.
404 મળ્યુ નથી, અથવા તે બીજા ખાતાને લગતુ છે
મેળવો પોસ્ટ /api/v1/dns-zones/{uuid}/records/

ક્ષેત્રમાં રેકોર્ડની યાદી કરો અથવા ઉમેરો

GET એ ક્ષેત્રમાં દરેક રેકોર્ડને સાદા એરે તરીકે પાછો આપે છે (પાનામાં નથી), પ્રકાર અને નામ દ્વારા ક્રમમાં ગોઠવેલ છે. POST એ ક્ષેત્રમાં રેકોર્ડ ઉમેરે છે અને તેને પ્રકાશિત કરે છે.

બોડી પેરામીટર્સની વિનંતી કરો (POST)

પરિમાણો પ્રકાર જરૂરી વર્ણન
record_type string હા A, AAAA, CNAME, MX, NS, TXT, SRV, PTR, SOA, CAA
name string હા ડોમેઇન માટે @, અથવા લેબલ જેમ કે www. નામો નાનાં અક્ષરોમાં સંગ્રહ કરેલ છે.
value string હા રેકોર્ડ માહિતી, ઉદાહરણ તરીકે IP સરનામું અથવા યજમાનનામ. યજમાનનામોને છેલ્લી બિંદુની જરૂર નથી અને TXT કિંમતોને કોટેશનની જરૂર નથી; બંને ઉમેરાય છે જ્યારે રેકોર્ડ પ્રકાશિત થાય છે.
ttl integer હા સેકન્ડોમાં જીવવા માટેનો સમય
priority integer માત્ર MX અને SRV MX અને SRV રેકોર્ડ માટે જરૂરી છે અને દરેક બીજા પ્રકાર માટે અવગણાયેલ છે. SRV માટે, કિંમતમાં વજન, પોર્ટ અને લક્ષ્ય મૂકો.

ઉદાહરણ વિનંતી

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

ઉદાહરણ પ્રતિભાવ

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

પ્રતિભાવ ક્ષેત્રો

ક્ષેત્ર પ્રકાર વર્ણન
uuid string રેકોર્ડ ઓળખનાર, /api/v1/dns-records/ અંતબિંદુઓ દ્વારા વપરાય છે
priority integer | null MX અને SRV રેકોર્ડ માટે પ્રાથમિકતા, નહિંતર નિષ્ક્રિય
created_at date માત્ર બનાવટ તારીખ (Y-MM-DD), સમય વગર

પ્રતિભાવ સ્થિતિ કોડ્સ

200 GET: ક્ષેત્રના રેકોર્ડ
201 POST: રેકોર્ડ બનાવેલ છે
400 ચકાસણી ભૂલ, ઉદાહરણ તરીકે અજ્ઞાત રેકોર્ડ પ્રકાર, ગુમ થયેલ ttl, અથવા MX અથવા SRV રેકોર્ડ પ્રાથમિકતા વગર
404 મળ્યુ નથી, અથવા તે બીજા ખાતાને લગતુ છે
પોસ્ટ /api/v1/dns-zones/{uuid}/sync/

ક્ષેત્ર પુનઃપ્રકાશિત કરો

ક્ષેત્ર અને તેના બધા રેકોર્ડને નામ સર્વરમાં ફરીથી દબાવો. રેકોર્ડ ફેરફારો આપોઆપ પ્રકાશિત થાય છે, પરંતુ પ્રકાશિત કરવાનું શ્રેષ્ઠ પ્રયત્ન છે અને નિષ્ફળતા મૂળભૂત વિનંતી નિષ્ફળ નથી, તેથી જ્યારે ફેરફાર DNS શોધમાં દેખાતો નથી ત્યારે આનો ઉપયોગ કરો. કોઈ વિનંતી શરીરની જરૂર નથી.

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"
}
મેળવો પોસ્ટ /api/v1/dns-records/

ક્ષેત્રો વચ્ચે રેકોર્ડની યાદી બનાવો અથવા બનાવો

GET તમારા બધા ક્ષેત્રોના રેકોર્ડ પાછા આપે છે, પાના દીઠ ૨૫, ડોમેઇન, પ્રકાર અને નામ દ્વારા ક્રમમાં. POST ક્ષેત્ર રેકોર્ડ અંતિમબિંદુ જેવા રેકોર્ડ બનાવે છે, પરંતુ zone_uuid તરીકે શરીરમાં ક્ષેત્રને લે છે.

ક્વેરી પરિમાણો

પરિમાણો પ્રકાર જરૂરી વર્ણન
zone string નહિં માત્ર આ uuid સાથે ક્ષેત્રના રેકોર્ડ
record_type string નહિં માત્ર આ પ્રકારના રેકોર્ડ, ઉદાહરણ તરીકે MX (કેસ સંવેદનશીલ નથી)
page integer નહિં પાનાં નંબર, ૧ થી શરૂ થાય છે
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"
    }
  ]
}

પ્રતિભાવ સ્થિતિ કોડ્સ

200 GET: સફળતા
201 POST: રેકોર્ડ બનાવેલ છે
400 સત્યતા ભૂલ, અથવા zone_uuid ગુમ થયેલ છે અથવા તમારા ક્ષેત્રોમાંનું એક નથી
મેળવો PUT PATCH કાઢી નાખો /api/v1/dns-records/{uuid}/

રેકોર્ડ મેળવો, સુધારો અથવા કાઢી નાંખો

GET એક રેકોર્ડ પાછો આપે છે. PUT તેને બદલે છે અને record_type, name, value અને ttl ની જરૂરિયાત છે. PATCH ફક્ત તમે મોકલેલા ક્ષેત્રોને બદલે છે. DELETE રેકોર્ડને દૂર કરે છે અને કોઈ શરીર વગર ૨૦૪ પાછો આપે છે. ફેરફારો તરત જ પ્રકાશિત થાય છે. NS રેકોર્ડો જે ક્ષેત્ર સાથે બનાવેલ છે તે સિસ્ટમ રેકોર્ડો છે: સુધારો અથવા તેમને કાઢી નાંખવું ૪૦૩ પાછું આપે છે.

જ્યારે તમે MX અથવા SRV રેકોર્ડની પ્રાથમિકતાને PATCH કરો, record_type ને એ જ વિનંતી માં મોકલો. પ્રાથમિકતા સાથે PATCH શરીર પરંતુ record_type વગર પ્રાથમિકતા સાફ કરે છે.
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}'

પ્રતિભાવ સ્થિતિ કોડ્સ

200 GET, PUT અથવા PATCH: રેકોર્ડ
204 કાઢી નાંખેલ. જવાબ પાસે કોઇ શરીર નથી.
400 ચકાસણી ભૂલ
403 રેકોર્ડ સિસ્ટમ રેકોર્ડ છે, અથવા ટોકન પાસે જરૂરી પરવાનગીઓ નથી
404 મળ્યુ નથી, અથવા તે બીજા ખાતાને લગતુ છે

ભૂલ સંભાળનાર

ક્ષેત્ર નામ દ્વારા સમસ્યાને કીનેરીંગ કરેલ છે તે સાથે ચકાસણી ભૂલો ૪૦૦ પાછું આપે છે:

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

DNS ફેરફારો ચકાસી રહ્યા છે

તમારા રજિસ્ટ્રારના પ્રતિનિધિત્વ અથવા રિઝોલ્યુશન કેશને પકડવા પહેલાં ફેરફાર સક્રિય છે તેની ખાતરી કરવા માટે VPS.org નામ સર્વરોને સીધા જ પૂછો:

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