VPS.org API

REST API belgelendirmesi

DNS Yönetim API'si

Alan adlarınız için DNS bölgelerini ve kayıtlarını programatik olarak yönetin.

Uç noktalar 4 uç nokta
Temel Yol /api/v1/dns-zones
Kimlik doğrulama Taşıyıcı Tokeni Gerekir

Genel Bakış

DNS API DNS bölgeleri ve kayıtlarının tam yönetimini sağlar. Tüm bölgeler VPS.org'in otoriter isim sunucularında otomatik BIND9 bölge dosyası üretimi ve dağıtımı ile barındırılır.

Ad sunucusu altyapısı

Ana Özellikler

Kimlik doğrulama

Tüm DNS API talepleri taşıyıcı token kimlik doğrulamasını gerektirir. API token'lerini hesabınızdaki kontrol panelinden oluşturun: /account/developers/ Aşağıdaki izinlerle:

Örnek

Authorization: Bearer vps_abc123def456...
Önemli: API tokenleri oluştururken sadece bir kez gösterilir. Güvenli bir yerde saklayın. Eğer bir token kaybederseniz, yeni bir tane yaratmanız gerekir.
ELDE ETMEK /api/v1/dns-zones/

Tüm DNS Bölgelerini Listele

Kimlik doğrulama işlemini tamamlamış kullanıcının sahip olduğu tüm DNS bölgelerinin sayfalanmış bir listesini al. Alan adı filtreleme desteği.

Sorgu Parametreleri

Parametreler Tip Gerekli Açıklama
domain string Hayır. Filter zones by exact domain name (e.g., example.com)

Örnek Talep

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

Örnek Yanıt

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

Yanıt Alanları

Alan Tip Açıklama
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

Yanıt Durum Kodları

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

DNS Bölgesi Ayrıntılarını Al

Tüm kayıtlar dahil olmak üzere belirli bir DNS bölgesi hakkında ayrıntılı bilgi edinin.

Yol Parametreleri

Parametreler Tip Gerekli Açıklama
uuid string Evet Unique zone identifier

Örnek Yanıt

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

Yanıt Durum Kodları

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

DNS Bölgesi Yarat

Bir alan için yeni bir DNS bölgesi yarat. Bölge derhal VPS.org isim sunucusuna dağıtılacak.

İstek Gövdesi Parametreleri

Parametreler Tip Gerekli Açıklama
domain string Evet Domain name (e.g., example.com)

Örnek Talep

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

Örnek Yanıt

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

Yanıt Durum Kodları

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

DNS Bölgesini Sil

Bir DNS bölgesini ve bütün ilişkili kayıtları kalıcı olarak siler. Bu işlem geri alınamaz.

Yol Parametreleri

Parametreler Tip Gerekli Açıklama
uuid string Evet Unique zone identifier

Yanıt Durum Kodları

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

DNS kayıtlarını bölgede listele

Belirli bir bölge için tüm DNS kayıtlarını al (üçgen yol).

Yol Parametreleri

Parametreler Tip Gerekli Açıklama
uuid string Evet Zone UUID

Örnek Talep

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

Örnek Yanıt

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

DNS kaydı oluştur

Belirli bir bölgeye yeni bir DNS kaydı ekle (üçgen yol).

İstek Gövdesi Parametreleri

Parametreler Tip Gerekli Açıklama
record_type string Evet Record type: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA
name string Evet Record name (@ for root, subdomain, or FQDN)
value string Evet 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)

Örnek Talep

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

Yanıt Durum Kodları

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 Kayıtlarını Yönet (Doğrudan Erişim)

Kayıt UUID kullanarak bireysel DNS kayıtları üzerinde tam CRUD işlemleri.

Kullanabilir Operasyonlar

Soru Parametreleri (GET /api/v1/dns-records/ için)

Parameter Tip Açıklama
zone string Filter records by zone UUID
record_type string Filter by record type (A, AAAA, MX, etc.)

Örnek: Bir kayıt için TTL güncelle

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

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

En İyi Uygulama

TTL Yapılandırması

Ortak Modeller

Güvenlik

Hata Yönetimi

Yaygın Hatalar

Durum Kodu Hata Çözüm
400 Geçersiz alan adı Alan adının DNS isimlendirme kurallarına uyduğundan emin ol
400 MX kaydı öncelik gerektirir İçe Çek priority MX ve SRV kayıtları için alan
401 Geçersiz API token Kontrol token biçimi (şunla başlamalı) vps_)
403 İzin eksik Yeni token gerektiği gibi oluştur dns:* izinler
404 Bölge/kayıt bulunamıyor UUID'yi doğrula ve kaynağın hesabınıza ait olduğunu kontrol et

Örnek Hata Cevapları

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

DNS Değişiklikleri Test Ediliyor

Kayıt Yayını Onayla

# 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

Çevrimiçi Araçları Kullanmak