Obtenir les instructions DNS d'un domaine

Renvoie les enregistrements DNS prêts à coller (CNAME + TXT) et des guides pas-à-pas par registrar pour activer un domaine personnalisé.

2 min de lectureTélécharger en PDF

Réponse exemple

{
  "note": "Add BOTH records (CNAME + TXT). Then call coffrify_verify_domain to flip verified=true.",
  "domain": "files.acme.com",
  "records": [
    {
      "ttl": 3600,
      "name": "files",
      "type": "CNAME",
      "target": "edge.coffrify.com",
      "purpose": "Route the custom domain to Coffrify's edge."
    },
    {
      "ttl": 3600,
      "name": "_coffrify-verify.files",
      "type": "TXT",
      "target": "cfy-verify-3f9a2b7c8d1e4056",
      "purpose": "Prove domain ownership before activation."
    }
  ],
  "verified": false,
  "after_setup": {
    "verification_tool": "coffrify_verify_domain",
    "expected_propagation": "1-30 minutes depending on registrar",
    "verification_endpoint": "POST /v1/domains/dom_8KQ2vN1rZ7/verify"
  },
  "verified_at": null,
  "registrar_guides": [
    {
      "url": "https://dash.cloudflare.com",
      "name": "Cloudflare",
      "steps": [
        "Dashboard → ton domaine → DNS → Records.",
        "Ajoute CNAME : Name = files, Target = edge.coffrify.com, Proxy status = DNS only (gris).",
        "Ajoute TXT : Name = _coffrify-verify.files, Content = cfy-verify-3f9a2b7c8d1e4056, TTL = Auto.",
        "Save. La propagation prend en général 1-5 min sur Cloudflare."
      ]
    },
    {
      "url": "https://www.ovh.com/manager/web/",
      "name": "OVH",
      "steps": [
        "Espace client OVH → Domaines → ton domaine → Zone DNS.",
        "Ajouter une entrée → Type : CNAME → Sous-domaine : files → Cible : edge.coffrify.com.",
        "Ajouter une entrée → Type : TXT → Sous-domaine : _coffrify-verify.files → Valeur : \"cfy-verify-3f9a2b7c8d1e4056\".",
        "Valider. Propagation 5-30 min."
      ]
    }
  ]
}

GET/v1/domains/{id}/dns-instructionsRécupère les enregistrements DNS à configurer et les guides registrar pour le domaine personnalisé identifié par {id}.

Cet endpoint renvoie tout ce qu'il faut pour brancher un domaine personnalisé sur l'edge Coffrify. Il fournit deux enregistrements à créer (un CNAME qui route le trafic et un TXT qui prouve la propriété du domaine), accompagnés de guides pas-à-pas pour les registrars les plus courants : Cloudflare, OVH, Hostinger, Gandi, Namecheap, Google Domains / Cloud DNS et AWS Route 53. La cible CNAME (cname_target) et le jeton de vérification (verification_token) proviennent de la ligne de domaine créée au préalable (via coffrify_create_domain). Le domaine est résolu dans le workspace courant : seul un domaine appartenant à votre workspace est visible.

Comportement notable : le host affiché dans les enregistrements est dérivé du domaine. Pour un sous-domaine comme files.acme.com, le host vaut files ; pour un domaine apex comme acme.com, le host vaut @. Le nom de l'enregistrement TXT est _coffrify-verify (pour un apex) ou _coffrify-verify.<host> (pour un sous-domaine). Cet endpoint est en lecture seule : il ne déclenche aucune vérification et ne modifie pas l'état du domaine.

Authentification

Requiert une clé API valide dont le jeton porte le scope domains:manage. Le scope est vérifié côté serveur via la résolution d'alias (un jeton * ou domains:* satisfait également l'exigence). Présentez la clé via l'en-tête Authorization: Bearer cof_live_... (ou cof_test_..., cof_mcp_live_...). Les appels depuis le tableau de bord en session cookie disposent du scope * et passent donc sans restriction.

Paramètres de chemin

Champ	Type	Requis	Description
id	string	Oui	Identifiant du domaine personnalisé (colonne `id` de `coffrify_custom_domains`), extrait du chemin de l'URL. Le domaine doit appartenir au workspace authentifié.

Réponse

La réponse JSON contient : domain (le domaine personnalisé), verified (booléen indiquant si la propriété a déjà été validée), verified_at (horodatage de la vérification ou null), et records[] (tableau des enregistrements DNS à créer). Chaque entrée de records expose type (CNAME ou TXT), name (le host à saisir), target (la valeur à coller : cible CNAME ou jeton TXT), ttl (3600) et purpose (explication du rôle de l'enregistrement).

Le bloc after_setup indique l'outil et l'endpoint de vérification à appeler une fois les enregistrements créés (coffrify_verify_domain / POST /v1/domains/{id}/verify) ainsi que le délai de propagation attendu. registrar_guides[] liste, pour chaque registrar (name, url, steps[]), les étapes concrètes pré-remplies avec votre host, votre cible et votre jeton. Le champ note rappelle d'ajouter les deux enregistrements avant de lancer la vérification.

Erreurs

Code HTTP	code	Quand	Résolution
401	missing_api_key	En-tête Authorization absent et aucune session valide.	Ajoutez `Authorization: Bearer cof_live_...`.
401	invalid_api_key	Préfixe de clé inconnu ou clé introuvable.	Vérifiez la clé ; générez-en une sur app.coffrify.com/developer.
403	scope_missing	Le jeton ne porte pas le scope `domains:manage`.	Générez un jeton incluant `domains:manage`.
404	not_found	Aucun domaine avec cet `id` dans le workspace.	Vérifiez l'`id` et qu'il appartient bien au workspace authentifié.
429	rate_limited	Quota de requêtes du workspace dépassé sur les endpoints de lecture.	Respectez l'en-tête `Retry-After` et réessayez.
500	internal_error	Erreur de base de données lors de la lecture du domaine.	Réessayez ; conservez le `request_id` pour le support.

Voir aussi

POST /v1/domains/{id}/verify — déclenche la vérification de propriété une fois les enregistrements DNS propagés.
POST /v1/domains — crée un domaine personnalisé et génère la cible CNAME + le jeton de vérification.
GET /v1/domains — liste les domaines personnalisés du workspace et leur état de vérification.