API de gestion DNS

Aperçu

L'API DNS assure la gestion complète des zones et des enregistrements DNS. Toutes les zones sont hébergées sur les serveurs de noms autorisés de VPS.org avec la génération et le déploiement automatique de fichiers de zone BIND9.

Infrastructure de serveur de noms

• ns1.vps.org (38.248.6.195) - Master primaire avec signature en ligne DNSSEC
• ns2.vps.org (38.248.6.196) - Esclave secondaire
• ns3.vps.org (38.248.6.197) - Esclave secondaire

Principales caractéristiques

• Génération et déploiement automatiques de fichiers zone BIND9
• Transferts de zone via l'authentification TSIG (réplication maître-esclave)
• Prise en charge de tous les principaux types d'enregistrements DNS (A, AAAA, CNAME, MX, TXT, NS, SRV, CAA)
• Filtrage des noms de domaine et identification des zones UUID
• Routes nichées pour la gestion des dossiers propres à une zone

Authentification

Toutes les requêtes d'API DNS nécessitent l'authentification de jeton Bearer. Générer des jetons d'API à partir de votre tableau de bord de compte à /account/developers/ avec les permissions suivantes:

• dns:list - Afficher les zones et les enregistrements DNS
• dns:create - Créer de nouvelles zones et enregistrements
• dns:update - Modifier les zones et les enregistrements existants
• dns:delete - Supprimer les zones et les enregistrements
• dns:* - Accès complet à la gestion DNS

Exemple

Authorization: Bearer vps_abc123def456...

Lister toutes les zones DNS

Récupérer une liste paginée de toutes les zones DNS appartenant à l'utilisateur authentifié. Prend en charge le filtrage par nom de domaine.

Paramètres de requête

Exemple de requête

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

Exemple de réponse

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

Champs de réponse

Codes d'état de réponse

Obtenir les détails de la zone DNS

Récupérer des informations détaillées sur une zone DNS spécifique, y compris tous les enregistrements.

Paramètres de chemin

Exemple de réponse

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

Codes d'état de réponse

Créer une zone DNS

Créez une nouvelle zone DNS pour un domaine. La zone sera immédiatement déployée sur VPS.org serveurs de noms.

Paramètres du corps de la requête

Exemple de requête

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

Exemple de réponse

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

Codes d'état de réponse

Supprimer la zone DNS

Supprimer définitivement une zone DNS et tous les enregistrements associés. Cette action ne peut pas être annulée.

Paramètres de chemin

Codes d'état de réponse

Liste des enregistrements DNS dans la zone

Récupérer tous les enregistrements DNS pour une zone spécifique (voie de neutralisation).

Paramètres de chemin

Exemple de requête

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

Exemple de réponse

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

Créer un enregistrement DNS dans la zone

Ajouter un nouvel enregistrement DNS à une zone spécifique (route de neige).

Paramètres du corps de la requête

Exemple de requête

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

Codes d'état de réponse

Gérer les dossiers DNS (Accès direct)

Opérations CRUD complètes sur des enregistrements DNS individuels à l'aide d'un enregistrement UUID.

Opérations disponibles

• GET /api/v1/dns-records/{uuid}/ - Retrieve record details
• PUT /api/v1/dns-records/{uuid}/ - Full update (all fields required)
• PATCH /api/v1/dns-records/{uuid}/ - Partial update (only changed fields)
• DELETE /api/v1/dns-records/{uuid}/ - Delete record

Paramètres de requête (pour GET /api/v1/dns-records/)

Exemple : Mettre à jour le TTL d'un enregistrement

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

Meilleures pratiques

Configuration TTL

• Production (tableau): 3600-86400 secondes (1-24 heures)
• Avant la migration: 300-600 secondes (5-10 minutes) - TTL inférieur avant les changements prévus
• Développement : 300-1800 secondes (5-30 minutes) pour des essais plus rapides

Dessins communs

• Domaine racine (@): Utiliser des enregistrements A/AAAA, non CNAME
• www sous-domaine: Peut utiliser CNAME pointant vers racine ou séparer un enregistrement
• Courriel (MX) : Toujours inclure priorité, nombre inférieur = priorité supérieure
• - C'est quoi, ça? Impossible de coexister avec d'autres types d'enregistrements pour le même nom

Sécurité

• Dossiers de l'ACS : Préciser quelles AC peuvent délivrer des certificats
• SPF/DKIM/DMARC: Configurer l'authentification de l'email pour empêcher le spoofing
• Vérifications régulières : Examiner les enregistrements DNS tous les trimestres, supprimer les entrées inutilisées

Gestion des erreurs

Erreurs courantes

Exemple de réponse d'erreur

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

Essais des modifications du DNS

Vérifier la propagation des enregistrements

# 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

Utilisation des outils en ligne

• whatsmydns.net: Check global DNS propagation
• dnschecker.org: Multi-location DNS lookup
• mxtoolbox.com: Email-related DNS testing