VPS.org API

Pagina officialis Documentationis

API Administrationis DNS

Zonas DNS et inscriptiones programmatice pro dominiis tuis administra.

Extrema Quattuor puncta extrema
Via Basis /api/v1/dns-zones
Authenticatio Totem portatoris necesse est

Conspectus

DNS API zonarum et inscriptorum DNS administrationem completam praebet. Totas zonas in VPS.org servibus nominalibus autoritativis cum automatica BIND9 zonae archivi generatione et deploymentum hospitium est.

Infrastructura

Species principalis

Authenticatio

Omnes petitiones API DNS authenticationem tokenis portatoris requirit. Tokens API ex tabula contorum generat apud /account/developers/ cum sequuntur permissionibus:

Exemplum

Authorization: Bearer vps_abc123def456...
Importans: API tokens solum unam tantum creationis tempus aedificia sunt. Secure deposita sunt. Si token perdi, novum creatus esse debet.
ACQUIRE /api/v1/dns-zones/

Enumera Omnes Zonas DNS

Recupere paginatam listam omnium zonarum DNS quae utenti authenticato pertinet. Filtrationem per nomen dominii sustinet.

Parametri Quaestionis

Parametrus Typus Requisitum Descriptio
domain string No Filter zones by exact domain name (e.g., example.com)

Exemplum Petitionis

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

Exemplum Responsionis

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

Campi Responsorum

Campo Typus Descriptio
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

Codices Status Responsorum

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

Descriptio descriptio descriptio

Retrieve detailed information about a specific DNS zone, including all records.

Parametri Semitae

Parametrus Typus Requisitum Descriptio
uuid string Ita Unique zone identifier

Exemplum Responsionis

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

Codices Status Responsorum

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

Creatio zonae DNS

Novam zonam DNS pro dominio creavit. Zona imediate in VPS.org servorum nominis deployatur.

Parametri Corporis Petitionis

Parametrus Typus Requisitum Descriptio
domain string Ita Domain name (e.g., example.com)

Exemplum Petitionis

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

Exemplum Responsionis

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

Codices Status Responsorum

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

Despectus in Domus

Deletae sunt zona DNS et omnes inscriptiones ad ea coniunctae. Haec actiones non sunt reversibiles.

Parametri Semitae

Parametrus Typus Requisitum Descriptio
uuid string Ita Unique zone identifier

Codices Status Responsorum

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

Index communium praefecturae Aequae

In hoc modo, omnes res in una zona (regione) inveniuntur.

Parametri Semitae

Parametrus Typus Requisitum Descriptio
uuid string Ita Zone UUID

Exemplum Petitionis

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

Exemplum Responsionis

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

Descriptio in pagina archivii

In hoc modo, incolae in novam civitatem (Republicam Foederalem Germaniae) migraverunt.

Parametri Corporis Petitionis

Parametrus Typus Requisitum Descriptio
record_type string Ita Record type: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA
name string Ita Record name (@ for root, subdomain, or FQDN)
value string Ita 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)

Exemplum Petitionis

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

Codices Status Responsorum

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

Descriptio (Anglice) Descriptio (Francice)

Full CRUD operations on individual DNS records using record UUID.

Operatio

Parametra query (for GET /api/v1/dns-records/)

Parameter Typus Descriptio
zone string Filter records by zone UUID
record_type string Filter by record type (A, AAAA, MX, etc.)

Exemplum: Aetate antiqua inscriptio.

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

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

Praesides Belgicae

Configuratio TTL

Pagina communis

Securitate

Errore manipulatio

Errores communia

Status Codex Errore Solutio
400 Nomen dominii invalidum Despectus in Domus de Domo
400 Record MX prioritatem exigit Includere priority campo pro MX et SRV inscriptionibus
401 Invalidus API token Verificatio token formati (debet cum vps_)
403 Permissio manet Generetur novum token cum necesse dns:* Permissions
404 Non repertus Verificat UUID et certior est res tuae contuum pertinet

Exemplum erroris

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

Despectus in Cantu

Despectus in Rerum Novarum

# 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

Pagina interretialis