VPS.org API

టెక్స్టు API పత్రికీకరణQuery

DNS నిర్వహణ API

మీ డొమైన్‌ల కోసం DNS జోన్‌లు మరియు రికార్డులను ప్రోగ్రామాటిక్‌గా నిర్వహించండి.

అంత్య బిందువులు 4 ముగింపు బిందువులు
బేస్ పాత్ /api/v1/dns-zones
ప్రామాణీకరణ బేకర్ టొకెన్ అవసరం

అవలోకనం

DNSAPI DNS మండలాలు మరియు రికార్డులను పూర్తి నిర్వహణను అందిస్తుంది. అన్ని imers VPS.org యొక్క అధికారికమైన పేరు సర్వర్‌లు వుద్భవింపచేయబడిన ఉంటాయి స్వయంచాలక BIND9 జాంబ్ ఫైల్ ఉద్భవం మరియు కంప్రత్యక్షత.

నెట్వర్క్ ఇంటర్ ఫెస్ డాటా ఇంస్టెంట్Comment

కీ సౌలభ్యాలు

ప్రామాణీకరణ

అన్ని DNSPI అభ్యర్ధనలకు సంక్షించటాన్ని అవసరం. మీ ఖాతాల నుండి APIపత్రాలను సృష్టించండి /account/developers/ ఈ క్రింది అనుమతులు తో:

ఉదాహరణలుComment

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 రికార్డ్‌ను సృష్టించుముName

ఒక నిర్ణీత జోన్‌కు కొత్త 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 రికార్డ్లను నిర్వహించు (నిర్దిష్ట యాక్సెస్)

DNS రికార్డింగులను ఉపయోగించి ప్రతి DNS రికార్డింగులు పూర్తి CRIS కార్యకలాపాలు.

అందుబాటులొ వున్న కార్యాలు

ప్రశ్న పారామిలిటరీలు (api/v/1/ 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 ఆకృతీకరణ

ఉమ్మడి రూపకల్పనలు

భద్రత

వ్యవహరించుటలో దోషముNAME OF TRANSLATORS

ఉమ్మడి దోషములు

స్థితి కోడ్ దోషము పరిష్కారం
400 సరికాని డొమైన్ పేరు DNS పేరు పెట్టు సమావేశాలను అనుసరించుచున్నది
400 MX రికార్డు ప్రాముఖ్యత అవసరమైంది జోడించు priority MX మరియు SRV రికార్డుల కొరకు పట్టీ
401 చెల్లని API గుర్తు సూచన ఫార్మాట్‌ను పరిశీలించుము (ఆరంభించి ప్రారంభించాలి) vps_)
403 అనుమతి లేదు అవసరమైనదానితో కొత్త సూచనను సృష్టించుము dns:* అనుమతులు
404 జోన్/ఉపయోగం కనబడలేదు మీ లెక్కలోని UIDని పరిశీలించండి మరియు ధ్రువీకరించండి

ఉదాహరణలు దోషము

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

ఆన్‌లైన్ సాధనములను ఉపయోగించు