VPS.org API

@ action

API ɗin Gudanar da DNS

Sarrafa yankunan DNS da bayanan da aka adana ta hanyar shirye-shirye don yankunanku.

Ƙarshen maki Maƙallan ƙarshe guda 4
Hanyar Tushe /api/v1/dns-zones
Tabbatarwa QDialogButtonBox

Bayani

The DNS API provides full management of DNS zones and records. All zones are hosted on VPS.org's authoritative nameservers with automatic BIND9 zone file generation and deployment.

Nameservers

QPrintPreviewDialog

Tabbatarwa

Duk tambayoyin API na DNS suna buƙatar tabbatarwa da tabbaci na tabbaci. Yi amfani da tabbacin API daga dashboard ɗin asusunka a /account/developers/ da izinin da ke ƙasa:

@ action

Authorization: Bearer vps_abc123def456...
QDialogButtonBox Ana nuna tabbaci na API sau ɗaya kawai yayin ƙirƙira. Ka adana su cikin aminci. Idan ka rasa tabbaci, sai ka ƙirƙiri ɗaya mai zuwa.
SAMU /api/v1/dns-zones/

Jerin Duk Yankunan DNS

Mai da jerin shafuka na duk yankuna na DNS da ake da su ga mai amfani da aka tabbatar. Yana goyon bayan siffanta ta hanyar sunan domen.

Sigogin Tambaya

Parameters Nau'i Ana buƙata @ action
domain string QDialogButtonBox Filter zones by exact domain name (e.g., example.com)

Buƙatar Misali

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

Misalin Amsar

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

Wuraren Amsawa

@ action Nau'i @ action
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

Lambobin Matsayin Amsawa

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

@ action

Mai da bayanai masu bayani kan wata yankin DNS, ciki har da duk rikodin.

Sigogi na Hanya

Parameters Nau'i Ana buƙata @ action
uuid string Ee Unique zone identifier

Misalin Amsar

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

Lambobin Matsayin Amsawa

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

@ action

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

Sigogin Jiki na Neman

Parameters Nau'i Ana buƙata @ action
domain string Ee Domain name (e.g., example.com)

Buƙatar Misali

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

Misalin Amsar

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

Lambobin Matsayin Amsawa

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

@ action

Cire wani yanki na DNS da duk rikodin da ke da alaka da shi. Wannan aikin ba za'a iya dakatar da shi ba.

Sigogi na Hanya

Parameters Nau'i Ana buƙata @ action
uuid string Ee Unique zone identifier

Lambobin Matsayin Amsawa

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

Nuna rubuce-rubucen DNS cikin yanki

QDialogButtonBox

Sigogi na Hanya

Parameters Nau'i Ana buƙata @ action
uuid string Ee Zone UUID

Buƙatar Misali

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

Misalin Amsar

[
  {
    "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"
  }
]
QSql /api/v1/dns-zones/{uuid}/records/

@ action

Ƙara wani sabon shigarwa na DNS zuwa wani yanki na musamman (matani mai haɗawa).

Sigogin Jiki na Neman

Parameters Nau'i Ana buƙata @ action
record_type string Ee Record type: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA
name string Ee Record name (@ for root, subdomain, or FQDN)
value string Ee 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)

Buƙatar Misali

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

Lambobin Matsayin Amsawa

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

Manajan Rikodin DNS (Acces Mai Zuwa)

Ayyuka na CRUD na cikakke kan rikodin DNS na mutum ta amfani da UUID na rikodin.

Aiki

Parameters na tambaya (don GET /api/v1/dns-records/)

Parameter Nau'i @ action
zone string Filter records by zone UUID
record_type string Filter by record type (A, AAAA, MX, etc.)

Misali: sabunta TTL na wani rijista

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

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

QDialogButtonBox

@ action

KCharselect unicode block name

QSql

QDialogButtonBox

QDialogButtonBox

Lambar Matsayi QDialogButtonBox @ action
400 Sunan domen ba daidai ba Tabbatar da shafukan yanar gizo suna bin dokokin ba da suna na DNS
400 MX record requires priority @ action priority filin ga MX da SRV rikodi
401 API token mara kyau Shirin siffar tabbaci (ya kamata ya fara da vps_)
403 QFileDialog Yi amfani da sabon tabbaci da ake buƙata dns:* Permissions
404 Ba'a samu ba Tabbatar da UUID kuma tabbatar da cewa albarkatun na cikin asusunka

@ action

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

@ action

QDialogButtonBox

# 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

@ action