VPS.org API

Dokumentimi i API REST

API-ja e Menaxhimit të DNS-së

Menaxhoni zonat dhe të dhënat DNS në mënyrë programore për domenet tuaja.

Pikat fundore 4 pika fundore
Shtegu Bazë /api/v1/dns-zones
Autentifikimi Duhet token i bartësit

Përmbledhje

API e DNS ofron menazhimin e plotë të zonave dhe regjistrave të DNS. Të gjitha zonat janë të vendosura në serverat e emrave autoritativë të VPS.org me krijimin dhe shpërndarjen automatike të file të zonave BIND9.

Infrastruktura e serverit të emrit

Funksionet kryesore

Autentifikimi

Të gjitha kërkesat e API DNS kërkojnë autentifikimin me token e bartësit. Gjenerati token e API nga paneli i llogarisë në /account/developers/ me të drejtat në vijim:

Shembull

Authorization: Bearer vps_abc123def456...
E rëndësishme: Token-ët e API shfaqen vetëm një herë gjatë krijimit. Ruani ato në mënyrë të sigurtë. Nëse humbni një token, duhet të gjeneroni një të ri.
MERR /api/v1/dns-zones/

Listo të gjitha zonat DNS

Merr një listë të faqes së të gjitha zonave DNS që i përkasin përdoruesit të autentifikuar. Suporton filtrimin sipas emrit të domain.

Parametrat e pyetjes

Parametrat Lloji E detyrueshme Përshkrimi
domain string Jo. Filter zones by exact domain name (e.g., example.com)

Shembull Kërkese

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

Shembull Përgjigjeje

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

Fushat e Përgjigjes

Fusha Lloji Përshkrimi
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

Kodet e Statusit të Përgjigjes

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

Merr hollësitë e zonës DNS

Merr informacione të hollësishme rreth një zone të caktuar DNS, duke përfshirë të gjitha regjistrat.

Parametrat e Shtegut

Parametrat Lloji E detyrueshme Përshkrimi
uuid string Po Unique zone identifier

Shembull Përgjigjeje

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

Kodet e Statusit të Përgjigjes

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

Krijo zonën DNS

Krijo një zonë të re DNS për një domen. Zona do të vendoset menjëherë tek VPS.org serverë emrash.

Parametrat e Trupit të Kërkesës

Parametrat Lloji E detyrueshme Përshkrimi
domain string Po Domain name (e.g., example.com)

Shembull Kërkese

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

Shembull Përgjigjeje

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

Kodet e Statusit të Përgjigjes

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

Elemino zonën DNS

Elemino përgjithmonë një zonë DNS dhe të gjitha regjistrat e lidhur me të. Ky veprim nuk mund të anullohet.

Parametrat e Shtegut

Parametrat Lloji E detyrueshme Përshkrimi
uuid string Po Unique zone identifier

Kodet e Statusit të Përgjigjes

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

Lista e rregjistrave DNS në zonë

Merr të gjitha regjistrat DNS për një zonë të caktuar (rrugë e fshehur).

Parametrat e Shtegut

Parametrat Lloji E detyrueshme Përshkrimi
uuid string Po Zone UUID

Shembull Kërkese

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

Shembull Përgjigjeje

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

Krijo një rekord DNS në zonë

Shto një regjistrim të ri DNS në një zonë të caktuar (rrugë e fshehur).

Parametrat e Trupit të Kërkesës

Parametrat Lloji E detyrueshme Përshkrimi
record_type string Po Record type: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA
name string Po Record name (@ for root, subdomain, or FQDN)
value string Po 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)

Shembull Kërkese

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

Kodet e Statusit të Përgjigjes

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

Menazho regjistrat DNS (Shfrytëzim i drejtpërdrejtë)

Operacionet e plota CRUD në regjistrat individualë DNS duke përdorur UUID të regjistrit.

Operacionet në dispozicion

Parametrat e pyetjes (për GET /api/v1/dns-records/)

Parameter Lloji Përshkrimi
zone string Filter records by zone UUID
record_type string Filter by record type (A, AAAA, MX, etc.)

Përditëso

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

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

Praktika më e mirë

Konfigurimi i TTL

Modele të zakonshme

Siguria

Manipulimi i gabimeve

Gabime të zakonshme

Kodi i Statusit Gabim Zgjidhja
400 Emri i pavlefshëm i domain Sigurohu që domeni ndjek konventat e emrave DNS
400 MX record kërkon përparësi Përfshi priority fusha për regjistrat MX dhe SRV
401 Token i pavlefshëm API Kontrollo formatin e token (duhet të fillojë me vps_)
403 Mungojnë të drejtat Gjenerator i ri token me të kërkuar dns:* të drejtat
404 Zona/rekordi nuk u gjet Kontrollo UUID dhe sigurohu që burimi i përket llogarisë tënde

Përgjigja e gabimit

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

Duke testuar ndryshimet DNS

Kontrollo përhapjen e regjistrit

# 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

Duke përdorur instrumentët në linjë