VPS.org API

REST API skjölun

DNS stjórnun API

Stjórnaðu DNS-svæðum og færslum forritunarlega fyrir lénin þín.

Endapunktar 4 endapunktar
Grunnslóð /api/v1/dns-zones
Auðkenning Nauðsynlegt að hafa með sér tákn

Yfirlit

DNS API veitir fulla stjórn á DNS svæðum og skrám.Öll svæði eru hýst á VPS.org's opinberum nafnþjónum með sjálfvirkri BIND9 svæðisskrá og dreifingu.

Nafnþjónn

Lykilatriði

Auðkenning

Búðu til API tákn frá reikningnum þínum á mælaborðinu á /account/developers/ Með eftirfarandi heimildir:

Dæmi

Authorization: Bearer vps_abc123def456...
Mikilvægt: API tákn eru aðeins sýnd einu sinni við gerð. Geymdu þau á öruggan hátt. Ef þú tapar tákni verður þú að búa til nýtt.
/api/v1/dns-zones/

Listi yfir öll DNS svæði

Sækja síðulista yfir öll DNS svæði sem eru í eigu auðkennds notanda. Styður síun eftir lénsheiti.

Fyrirspurnarbreytur

Breyta Tegund Nauðsynlegt Lýsing
domain string Nei Filter zones by exact domain name (e.g., example.com)

Dæmi um beiðni

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

Dæmi um svar

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

Svarsvið

Field Tegund Lýsing
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

Kóðar fyrir svörunarstöðu

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

Fá DNS Zone Upplýsingar

Sækja nákvæmar upplýsingar um tiltekna DNS svæði, þar á meðal allar færslur.

Slóðarbreytur

Breyta Tegund Nauðsynlegt Lýsing
uuid string Unique zone identifier

Dæmi um svar

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

Kóðar fyrir svörunarstöðu

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

Búa til DNS svæði

Búa til nýtt DNS svæði fyrir lén. Svæðið verður strax dreift á VPS.org nafnþjóna.

Færibreytur beiðninnar

Breyta Tegund Nauðsynlegt Lýsing
domain string Domain name (e.g., example.com)

Dæmi um beiðni

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

Dæmi um svar

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

Kóðar fyrir svörunarstöðu

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

Eyða DNS svæði

Eyða varanlega DNS svæði og öllum tengdum færslum. Ekki er hægt að afturkalla þessa aðgerð.

Slóðarbreytur

Breyta Tegund Nauðsynlegt Lýsing
uuid string Unique zone identifier

Kóðar fyrir svörunarstöðu

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

Listi yfir DNS færslur í Zone

Sækja allar DNS færslur fyrir tiltekið svæði (nested leið).

Slóðarbreytur

Breyta Tegund Nauðsynlegt Lýsing
uuid string Zone UUID

Dæmi um beiðni

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

Dæmi um svar

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

Búa til DNS færslu í Zone

Bæta við nýjum DNS færslu til tiltekins svæðis (nested leið).

Færibreytur beiðninnar

Breyta Tegund Nauðsynlegt Lýsing
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)

Dæmi um beiðni

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

Kóðar fyrir svörunarstöðu

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

Stjórna DNS skrám (beinn aðgangur)

Full CRUD aðgerðir á einstökum DNS skrám með því að nota skrá UUID.

Tiltækar aðgerðir

Fyrirspurn breytur (fyrir GET /api/v1/dns-skrár/)

Parameter Tegund Lýsing
zone string Filter records by zone UUID
record_type string Filter by record type (A, AAAA, MX, etc.)

Dæmi: Uppfæra TTL skráar

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

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

Bestu starfsvenjur

TTL stillingar

Algeng mynstur

Öryggi

Villuumsjón

Algengar villur

Stöðukóði Villa Lausn
400 Ógilt lén Gakktu úr skugga um að lénið fylgi DNS naming conventions
400 MX færsla krefst forgangs Innifalið priority Veldu MX og SRV skrár
401 Ógilt API tákn Athugaðu tákn snið (verður að byrja með vps_)
403 Vantar heimild Búa til nýtt tákn með nauðsynlegum dns:* Aðgangsheimildir
404 Svæði/skrá fannst ekki Staðfesta UUID og tryggja að auðlind tilheyrir reikningnum þínum

Dæmi um villusvörun

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

Prófa DNS breytingar

Staðfesta fjölgun skráa

# 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

Notkun á netinu verkfæri