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־זאָנע, אַרײַנגעזעצט אַלע אױסשרײַבונגען

וועג פּאַראַמעטערס

פּאַראַמעטערס טיפּ פארלאנגט באַשרײַבונג
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/

סעלעקציע:

Create a new DNS zone for a domain. The zone will be immediately deployed to VPS.org nameservers.

פארלאנג גוף פאראמעטערס

פּאַראַמעטערס טיפּ פארלאנגט באַשרײַבונג
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־זאָנע און אַלע פֿאַרבונדן אױסשרײַבונגען פֿאַרשטאַרבן. דאָס אַקטיװיטעט איז ניט אױסצומאַכן

וועג פּאַראַמעטערס

פּאַראַמעטערס טיפּ פארלאנגט באַשרײַבונג
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־אַרײַנשרײַב צו אַ באַזונדערער זאָנע (אַרײַנגעפֿאַלענע װירע)

פארלאנג גוף פאראמעטערס

פּאַראַמעטערס טיפּ פארלאנגט באַשרײַבונג
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}/

װײַז/היטן װײַז־פֿאָרעם

פֿולע CRUD־אָפּעראַציעס אױף אײנעלעכע DNS־אַרײַנשרײַבונגען מיט דער UUID־אַרײַנשרײַבונג

אױסגלײַכונג

פֿראַגע־פּאַראַמעטערס (פֿאַר GET /api/v1/dns-records/)

Parameter טיפּ באַשרײַבונג
zone string Filter records by zone UUID
record_type string Filter by record type (A, AAAA, MX, etc.)

װײַז װיפֿל

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" ניט

בעסטער־פּראָצעס

צופּאַסונג

קלײַב אַלץ אױסundo-type

זיכערהײט

דורכפֿאַל־באַהאַנדלונג

קלאָרע טעותן

סטאַטוס קאָד טעות קלײַב אַלץ אױסundo-type
400 אומלעקסיקער דאָמעניק נאָמען װיפֿל װײַטער זאָל מען װײַזן די װײַזער?
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

ניצן אינטערנעט־אַרײַנשרײַב־באַזונדערע