VPS.org API

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

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

તમારા ડોમેન્સ માટે DNS ઝોન અને રેકોર્ડ્સ પ્રોગ્રામેટિકલી મેનેજ કરો.

અંતિમ બિંદુઓ 4 અંતિમ બિંદુઓ
બેઝ પાથ /api/v1/dns-zones
પ્રમાણીકરણ બેરીર ટોકન જરૂરી

ઝાંખી

DNS API DNS ક્ષેત્રો અને રેકોર્ડોનું સંપૂર્ણ વ્યવસ્થાપન પૂરુ પાડે છે. બધા ક્ષેત્રો VPS.org ના સત્તાવાર નામ સર્વર પર સ્વયં BIND9 ક્ષેત્ર ફાઇલ ઉત્પન્ન અને વિસ્તરણ સાથે યજમાન છે.

નામસર્વર ઇન્ફ્રાસ્ટ્રક્ચર

મુખ્ય લાક્ષણિકતાઓ

પ્રમાણીકરણ

બધા DNS API વિનંતીઓને બેરીયર ટોકન સત્તાધિકરણની જરૂર છે. તમારા ખાતા ડેશબોર્ડમાંથી API ટોકનોને આમાં ઉત્પન્ન કરો /account/developers/ નીચેની પરવાનગીઓ સાથે:

ઉદાહરણ

Authorization: Bearer vps_abc123def456...
મહત્વનું: API ટોકનોને બનાવતી વખતે ફક્ત એકવાર બતાવવામાં આવે છે. તેમને સુરક્ષિત રીતે સંગ્રહો. જો તમે ટોકન ગુમાવો, તો તમારે નવું એક બનાવવું જ પડશે.
મેળવો /api/v1/dns-zones/

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

સત્તાધિકરણ થયેલ વપરાશકર્તા દ્વારા માલિકી ધરાવતા બધા DNS ક્ષેત્રોની પાનાંઓની યાદી મેળવો. ડોમેઇન નામ દ્વારા ગાળવાનું આધાર આપે છે.

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

પરિમાણો પ્રકાર જરૂરી વર્ણન
domain string નહિં Filter zones by exact domain name (e.g., example.com)

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

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

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

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

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

ક્ષેત્ર પ્રકાર વર્ણન
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

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

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

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

બધા રેકોર્ડો સમાવતા, ચોક્કસ DNS ક્ષેત્ર વિશે વિગતવાર જાણકારી મેળવો.

પાથ પરિમાણો

પરિમાણો પ્રકાર જરૂરી વર્ણન
uuid string હા Unique zone identifier

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

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

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

200 Successfully retrieved zone details
404 Zone not found or not owned by user
પોસ્ટ /api/v1/dns-zones/

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

ડોમેઇન માટે નવો DNS વિસ્તાર બનાવો. વિસ્તાર તરત જ VPS.org નામસર્વરો પર સ્થાપિત થશે.

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

પરિમાણો પ્રકાર જરૂરી વર્ણન
domain string હા Domain name (e.g., example.com)

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

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

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

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

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

201 DNS zone created successfully
400 Bad Request - Invalid domain name or zone already exists
403 Forbidden - Token lacks dns:create permission
કાઢી નાખો /api/v1/dns-zones/{uuid}/

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

DNS ક્ષેત્ર અને બધા સંકળાયેલા રેકોર્ડોને કાયમ માટે કાઢી નાંખો. આ ક્રિયા પાછી ખેંચી શકાતી નથી.

પાથ પરિમાણો

પરિમાણો પ્રકાર જરૂરી વર્ણન
uuid string હા Unique zone identifier

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

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

ક્ષેત્રમાં DNS રેકોર્ડોની યાદી કરો

ચોક્કસ ક્ષેત્ર માટે બધા DNS રેકોર્ડ્સને મેળવો (નેસ્ટેડ માર્ગ).

પાથ પરિમાણો

પરિમાણો પ્રકાર જરૂરી વર્ણન
uuid string હા Zone UUID

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

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

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

[
  {
    "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"
  }
]
પોસ્ટ /api/v1/dns-zones/{uuid}/records/

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

નવો DNS રેકોર્ડને ચોક્કસ ક્ષેત્રમાં ઉમેરો (નેસ્ટેડ માર્ગ).

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

પરિમાણો પ્રકાર જરૂરી વર્ણન
record_type string હા Record type: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA
name string હા Record name (@ for root, subdomain, or FQDN)
value string હા 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)

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

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

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

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

DNS રેકોર્ડ્સનું વ્યવસ્થાપન કરો (પ્રત્યક્ષ પ્રવેશ)

UUID રેકોર્ડની મદદથી વ્યક્તિગત DNS રેકોર્ડ પર સંપૂર્ણ CRUD ક્રિયાઓ.

ઉપલબ્ધ ક્રિયાઓ

પ્રશ્ન પરિમાણો (GET /api/v1/dns-records/ માટે)

Parameter પ્રકાર વર્ણન
zone string Filter records by zone UUID
record_type string Filter by record type (A, AAAA, MX, etc.)

ઉદાહરણ: રેકોર્ડનું TTL સુધારો

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

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

શ્રેષ્ઠ પદ્ધતિઓ

TTL રૂપરેખાંકન

સામાન્ય ભાતો

સુરક્ષા

ભૂલ સંભાળનાર

સામાન્ય ભૂલો

સ્થિતિ કોડ ભૂલ ઉકેલ
400 અયોગ્ય ડોમેઇન નામ ખાતરી કરો કે ડોમેઇન DNS નામકરણ સંધિઓ અનુસરે છે
400 MX રેકોર્ડને પ્રાથમિકતાની જરૂર છે સમાવે priority MX અને SRV રેકોર્ડો માટે ક્ષેત્ર
401 અયોગ્ય API ટોકન ટોકન બંધારણ ચકાસો (આ સાથે શરૂ થવું જ જોઇએ) vps_)
403 ગુમ થયેલ પરવાનગી જરૂરી સાથે નવું ટોકન બનાવો dns:* પરવાનગીઓ
404 ક્ષેત્ર/રેકોર્ડ મળ્યો નથી UUID ને ચકાસો અને ખાતરી કરો કે સ્ત્રોત તમારા ખાતા સાથે સંબંધિત છે

ઉદાહરણ ભૂલ જવાબ

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

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

રેકોર્ડ પ્રસારણ ચકાસો

# 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

ઓનલાઇન સાધનો વાપરી રહ્યા છીએ