VPS.org API

Faʻamatalaga o le REST API

API Pulega DNS

Pulea sone ma fa'amaumauga a le DNS i se faiga fa'apolokalame mo au 'upega tafa'ilagi.

Fa'ai'uga 4 fa'ai'uga
Ala Autu /api/v1/dns-zones
Fa'amaoniga E manaʻomia le token o le tagata faʻaulufale

Aotelega

O le DNS API e tuuina atu le puleaina atoa o itulagi ma tusi faamaumauga DNS. O itulagi uma e teuina i le VPS.org's igoa 'au'aunaga ma otometi BIND9 itulagi faila tupulaga ma le faalauiloaina.

Nameserver Infrastructure

Faʻamatalaga autu

Fa'amaoniga

O uma talosaga a le DNS API e manaʻomia ai le faʻamaonia o le Bearer token. /account/developers/ ma nei aia tatau:

Faʻataʻitaʻiga

Authorization: Bearer vps_abc123def456...
Faʻalagolago: O faʻailoga API e faʻaalia i le taimi e tasi lava i le taimi o le fausiaina. Teuina i se auala saogalemu. Afai e te leiloa se faʻailoga, e tatau ona e fausia se tasi fou.
MAUA /api/v1/dns-zones/

Lisi Sone DNS Uma

Faʻatumu se lisi o vaega uma o DNS e pulea e le tagata faʻaoga ua faʻamaonia. E lagolagoina le siakiina e igoa o le itulagi.

Fa'asologa o Fesili

Paramita Ituaiga Mana'omia Faʻamatalaga
domain string E leai Filter zones by exact domain name (e.g., example.com)

Talosaga Fa'ata'ita'i

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

Tali Fa'ata'ita'i

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

Fanua Tali

Aoga Ituaiga Faʻamatalaga
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

Fa'ailoga o Tulaga o Tali

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

Faʻataga Faʻamatalaga o le Nofoaga DNS

Toe maua faʻamatalaga faʻasolosolo e uiga i se itulagi DNS faapitoa, e aofia ai ma uma faʻamaumauga.

Fa'asologa o Ala

Paramita Ituaiga Mana'omia Faʻamatalaga
uuid string Ioe Unique zone identifier

Tali Fa'ata'ita'i

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

Fa'ailoga o Tulaga o Tali

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

Faʻatonu le DNS

Faʻatulaga se itulagi DNS fou mo se itulagi. O le itulagi o le a faʻaulufaleina i le VPS.org 'au'aunaga igoa.

Talosaga mo Fa'atulagaga o le Tino

Paramita Ituaiga Mana'omia Faʻamatalaga
domain string Ioe Domain name (e.g., example.com)

Talosaga Fa'ata'ita'i

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

Tali Fa'ata'ita'i

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

Fa'ailoga o Tulaga o Tali

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

Suʻe

Faʻasolosolo le faʻaigoaina o se 'upega tafaʻilagi. E le mafai ona toe faia lenei gaioiga.

Fa'asologa o Ala

Paramita Ituaiga Mana'omia Faʻamatalaga
uuid string Ioe Unique zone identifier

Fa'ailoga o Tulaga o Tali

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

Faʻavasega faʻamaumauga DNS i le itulagi

Toe maua uma faʻamaumauga DNS mo se itu faapitoa (malae vaʻalele faʻaputuga).

Fa'asologa o Ala

Paramita Ituaiga Mana'omia Faʻamatalaga
uuid string Ioe Zone UUID

Talosaga Fa'ata'ita'i

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

Tali Fa'ata'ita'i

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

Faʻatonu le DNS

Faʻaopopo se tala fou DNS i se itu faapitoa (ala i totonu).

Talosaga mo Fa'atulagaga o le Tino

Paramita Ituaiga Mana'omia Faʻamatalaga
record_type string Ioe Record type: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA
name string Ioe Record name (@ for root, subdomain, or FQDN)
value string Ioe 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)

Talosaga Fa'ata'ita'i

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

Fa'ailoga o Tulaga o Tali

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

Faʻatonu le DNS Recording (Direct Access)

Fa'atinoga CRUD atoa i fa'amaumauga DNS ta'itasi e fa'aaoga ai le UUID o le fa'amaumauga.

Faʻagaioiga e maua

Faʻatonu le Faʻatonu (mo le GET /api/v1/dns-records/)

Parameter Ituaiga Faʻamatalaga
zone string Filter records by zone UUID
record_type string Filter by record type (A, AAAA, MX, etc.)

Faʻafouina le TTL o se faʻamaumauga

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

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

Faʻatulagaga sili

Faʻatonu

Paʻi

Faʻatulafonoina

Faʻamaopoopoga o Faʻafitauli

Faʻafitauli Faʻapitoa

Fa'ailoga o le Tulaga Faʻafitauli Faʻaiuga
400 Le mautonu le igoa o le 'au'aunaga Faʻamautinoa o le 'upega tafaʻilagi e mulimuli i tulafono o le igoa DNS
400 E manaʻomia le faʻaiuga a le MX Faʻaopopo priority itu mo MX ma SRV tusiata
401 Faʻailoga API lē talafeagai Faʻavasega le faʻavasegaga o le token (e tatau ona amataina ma vps_)
403 Le mafai ona maua le aia tatau Faʻatū se faʻailoga fou e manaʻomia dns:* Permissions
404 E leʻi maua le 'auala Faʻamaonia le UUID ma mautinoa o le a le meatotino o lau teugatupe

Faʻatali mo se faʻamatalaga

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

Faʻataʻitaʻiga o suiga DNS

Faʻamaonia le faʻatupulaia o le tusiata

# 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

Faʻaaogaina o meafaigaluega i luga ole laiga