API des domaines

Ajoutez un nom d’hôte que vous possédez, configurez le CNAME de vérification renvoyé par l’API, puis envoyez la requête de vérification du domaine.

Utiliser Authentification API pour les requêtes protégées. Les exemples utilisent vos propres ID de ressources et un jeton temporaire ; les exemples de réponses enregistrés sont synthétiques.

Méthode	Chemin	Opération
GET	/v1/domain	Lister les domaines
POST	/v1/domain	Créer un domaine
GET	/v1/domain/{id}	Obtenir le domaine
PUT	/v1/domain/{id}	Mettre à jour le domaine
DELETE	/v1/domain/{id}	Supprimer le domaine
POST	/v1/domain/{id}/verify	Vérifier le domaine

Lister les domaines

GET /v1/domain

Renvoie une liste paginée de Domain

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

Nom	Emplacement	Requis	Description
X-Tenant-ID	en-tête	oui	ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.
page	requête	non	Numéro de page
per_page	requête	non	Éléments par page

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/domain" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Réponse : HTTP 200

Liste de Domain

Champs de réponse

Champ	Type	Description
data	tableau
data[].created_at	entier	(horodatage Unix)
data[].deleted_at	entier	(horodatage Unix)
data[].domain_id	chaîne
data[].hostname	chaîne	Nom d’hôte personnalisé appartenant à l’utilisateur ; les espaces de noms adios.dev et adios.run sont réservés aux routes gérées par la plateforme
data[].redirect_to	chaîne	URL ou nom d’hôte facultatif vers lequel rediriger (par exemple https://www.adios.dev)
data[].scope	chaîne	Portée autorisée du nom d’hôte : exact autorise uniquement hostname ; subtree autorise aussi les noms d’hôtes descendants. Les nouveaux domaines enregistrables utilisent subtree par défaut, les nouveaux sous-domaines exact, et les enregistrements existants restent en subtree pour préserver la compatibilité. Valeurs autorisées : exact, subtree.
data[].status	chaîne	Statut de vérification du domaine. Valeurs autorisées : pending, verified.
data[].team_id	chaîne
data[].updated_at	entier	(horodatage Unix)
data[].verification_hostname	chaîne	Nom DNS à configurer comme CNAME pour vérifier la propriété
data[].verification_parent_id	chaîne	Domaine parent vérifié dont ce nom d’hôte a hérité la vérification ; vide en cas de vérification DNS directe
data[].verification_value	chaîne	Valeur CNAME attendue pour la vérification de propriété
data[].verified_at	entier	(horodatage Unix)
data[].workload_id	chaîne
pagination	objet
pagination.page	entier	Numéro de page actuel
pagination.per_page	entier	Nombre d’éléments par page
pagination.total	entier	Nombre total d’éléments

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

{
  "data": [
    {
      "created_at": 1791072000,
      "deleted_at": 0,
      "domain_id": "000000000000000000000000001",
      "hostname": "app.example.com",
      "redirect_to": "example",
      "scope": "exact",
      "status": "pending",
      "team_id": "000000000000000000000000001",
      "updated_at": 1791072000,
      "verification_hostname": "example",
      "verification_parent_id": "000000000000000000000000001",
      "verification_value": "example",
      "verified_at": 0,
      "workload_id": "000000000000000000000000001"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Créer un domaine

POST /v1/domain

Crée un nouvel objet Domain

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Champs de la requête (le corps contient un exemple modifiable) :

Champ	Type	Requis	Description
hostname	chaîne	oui	Nom d’hôte personnalisé appartenant à l’utilisateur ; les espaces de noms adios.dev et adios.run sont réservés aux routes gérées par la plateforme
redirect_to	chaîne	non	URL ou nom d’hôte facultatif vers lequel rediriger (par exemple https://www.adios.dev)
scope	chaîne	non	Portée autorisée du nom d’hôte : exact autorise uniquement hostname ; subtree autorise aussi les noms d’hôtes descendants. Les nouveaux domaines enregistrables utilisent subtree par défaut, les nouveaux sous-domaines exact, et les enregistrements existants restent en subtree pour préserver la compatibilité. Valeurs autorisées : exact, subtree.
status	chaîne	non	Statut de vérification du domaine. Valeurs autorisées : pending, verified. Valeur par défaut : "pending".
team_id	chaîne	oui
verification_hostname	chaîne	non	Nom DNS à configurer comme CNAME pour vérifier la propriété
verification_parent_id	chaîne	non	Domaine parent vérifié dont ce nom d’hôte a hérité la vérification ; vide en cas de vérification DNS directe
verification_value	chaîne	non	Valeur CNAME attendue pour la vérification de propriété
verified_at	entier	non	(horodatage Unix) Valeur par défaut : 0.
workload_id	chaîne	non

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

Nom	Emplacement	Requis	Description
X-Tenant-ID	en-tête	oui	ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/domain" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "team_id": "YOUR_TEAM_ID",
  "hostname": "YOUR_HOSTNAME"
}
JSON

Remplacez YOUR_* du corps avant l’envoi. Le heredoc entre guillemets préserve le JSON littéral.

Réponse : HTTP 201

Domaine créé

Champs de réponse

Champ	Type	Description
created_at	entier	(horodatage Unix)
deleted_at	entier	(horodatage Unix)
domain_id	chaîne
hostname	chaîne	Nom d’hôte personnalisé appartenant à l’utilisateur ; les espaces de noms adios.dev et adios.run sont réservés aux routes gérées par la plateforme
redirect_to	chaîne	URL ou nom d’hôte facultatif vers lequel rediriger (par exemple https://www.adios.dev)
scope	chaîne	Portée autorisée du nom d’hôte : exact autorise uniquement hostname ; subtree autorise aussi les noms d’hôtes descendants. Les nouveaux domaines enregistrables utilisent subtree par défaut, les nouveaux sous-domaines exact, et les enregistrements existants restent en subtree pour préserver la compatibilité. Valeurs autorisées : exact, subtree.
status	chaîne	Statut de vérification du domaine. Valeurs autorisées : pending, verified.
team_id	chaîne
updated_at	entier	(horodatage Unix)
verification_hostname	chaîne	Nom DNS à configurer comme CNAME pour vérifier la propriété
verification_parent_id	chaîne	Domaine parent vérifié dont ce nom d’hôte a hérité la vérification ; vide en cas de vérification DNS directe
verification_value	chaîne	Valeur CNAME attendue pour la vérification de propriété
verified_at	entier	(horodatage Unix)
workload_id	chaîne

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

{
  "created_at": 1791072000,
  "deleted_at": 0,
  "domain_id": "000000000000000000000000001",
  "hostname": "app.example.com",
  "redirect_to": "example",
  "scope": "exact",
  "status": "pending",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "verification_hostname": "example",
  "verification_parent_id": "000000000000000000000000001",
  "verification_value": "example",
  "verified_at": 0,
  "workload_id": "000000000000000000000000001"
}

Obtenir le domaine

GET /v1/domain/{id}

Renvoie un seul Domain

Définissez domain_id en utilisant les ID de vos propres réponses API.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

Nom	Emplacement	Requis	Description
id	chemin	oui	Identifiant de ressource issu des résultats API de votre équipe.
X-Tenant-ID	en-tête	oui	ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/domain/${ADIOS_DOMAIN_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Réponse : HTTP 200

Domaine

Champs de réponse

Champ	Type	Description
created_at	entier	(horodatage Unix)
deleted_at	entier	(horodatage Unix)
domain_id	chaîne
hostname	chaîne	Nom d’hôte personnalisé appartenant à l’utilisateur ; les espaces de noms adios.dev et adios.run sont réservés aux routes gérées par la plateforme
redirect_to	chaîne	URL ou nom d’hôte facultatif vers lequel rediriger (par exemple https://www.adios.dev)
scope	chaîne	Portée autorisée du nom d’hôte : exact autorise uniquement hostname ; subtree autorise aussi les noms d’hôtes descendants. Les nouveaux domaines enregistrables utilisent subtree par défaut, les nouveaux sous-domaines exact, et les enregistrements existants restent en subtree pour préserver la compatibilité. Valeurs autorisées : exact, subtree.
status	chaîne	Statut de vérification du domaine. Valeurs autorisées : pending, verified.
team_id	chaîne
updated_at	entier	(horodatage Unix)
verification_hostname	chaîne	Nom DNS à configurer comme CNAME pour vérifier la propriété
verification_parent_id	chaîne	Domaine parent vérifié dont ce nom d’hôte a hérité la vérification ; vide en cas de vérification DNS directe
verification_value	chaîne	Valeur CNAME attendue pour la vérification de propriété
verified_at	entier	(horodatage Unix)
workload_id	chaîne

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

{
  "created_at": 1791072000,
  "deleted_at": 0,
  "domain_id": "000000000000000000000000001",
  "hostname": "app.example.com",
  "redirect_to": "example",
  "scope": "exact",
  "status": "pending",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "verification_hostname": "example",
  "verification_parent_id": "000000000000000000000000001",
  "verification_value": "example",
  "verified_at": 0,
  "workload_id": "000000000000000000000000001"
}

Mettre à jour le domaine

PUT /v1/domain/{id}

Met à jour un objet Domain existant

Définissez domain_id en utilisant les ID de vos propres réponses API.

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Champs de la requête (le corps contient un exemple modifiable) :

Champ	Type	Requis	Description
hostname	chaîne	oui	Nom d’hôte personnalisé appartenant à l’utilisateur ; les espaces de noms adios.dev et adios.run sont réservés aux routes gérées par la plateforme
redirect_to	chaîne	non	URL ou nom d’hôte facultatif vers lequel rediriger (par exemple https://www.adios.dev)
scope	chaîne	non	Portée autorisée du nom d’hôte : exact autorise uniquement hostname ; subtree autorise aussi les noms d’hôtes descendants. Les nouveaux domaines enregistrables utilisent subtree par défaut, les nouveaux sous-domaines exact, et les enregistrements existants restent en subtree pour préserver la compatibilité. Valeurs autorisées : exact, subtree.
status	chaîne	non	Statut de vérification du domaine. Valeurs autorisées : pending, verified. Valeur par défaut : "pending".
team_id	chaîne	oui
verification_hostname	chaîne	non	Nom DNS à configurer comme CNAME pour vérifier la propriété
verification_parent_id	chaîne	non	Domaine parent vérifié dont ce nom d’hôte a hérité la vérification ; vide en cas de vérification DNS directe
verification_value	chaîne	non	Valeur CNAME attendue pour la vérification de propriété
verified_at	entier	non	(horodatage Unix) Valeur par défaut : 0.
workload_id	chaîne	non

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

Nom	Emplacement	Requis	Description
id	chemin	oui	Identifiant de ressource issu des résultats API de votre équipe.
X-Tenant-ID	en-tête	oui	ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

curl --fail-with-body --request PUT "$ADIOS_API_URL/v1/domain/${ADIOS_DOMAIN_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "team_id": "YOUR_TEAM_ID",
  "hostname": "YOUR_HOSTNAME"
}
JSON

Remplacez YOUR_* du corps avant l’envoi. Le heredoc entre guillemets préserve le JSON littéral.

Réponse : HTTP 200

Domaine mis à jour

Champs de réponse

Champ	Type	Description
created_at	entier	(horodatage Unix)
deleted_at	entier	(horodatage Unix)
domain_id	chaîne
hostname	chaîne	Nom d’hôte personnalisé appartenant à l’utilisateur ; les espaces de noms adios.dev et adios.run sont réservés aux routes gérées par la plateforme
redirect_to	chaîne	URL ou nom d’hôte facultatif vers lequel rediriger (par exemple https://www.adios.dev)
scope	chaîne	Portée autorisée du nom d’hôte : exact autorise uniquement hostname ; subtree autorise aussi les noms d’hôtes descendants. Les nouveaux domaines enregistrables utilisent subtree par défaut, les nouveaux sous-domaines exact, et les enregistrements existants restent en subtree pour préserver la compatibilité. Valeurs autorisées : exact, subtree.
status	chaîne	Statut de vérification du domaine. Valeurs autorisées : pending, verified.
team_id	chaîne
updated_at	entier	(horodatage Unix)
verification_hostname	chaîne	Nom DNS à configurer comme CNAME pour vérifier la propriété
verification_parent_id	chaîne	Domaine parent vérifié dont ce nom d’hôte a hérité la vérification ; vide en cas de vérification DNS directe
verification_value	chaîne	Valeur CNAME attendue pour la vérification de propriété
verified_at	entier	(horodatage Unix)
workload_id	chaîne

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

{
  "created_at": 1791072000,
  "deleted_at": 0,
  "domain_id": "000000000000000000000000001",
  "hostname": "app.example.com",
  "redirect_to": "example",
  "scope": "exact",
  "status": "pending",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "verification_hostname": "example",
  "verification_parent_id": "000000000000000000000000001",
  "verification_value": "example",
  "verified_at": 0,
  "workload_id": "000000000000000000000000001"
}

Supprimer le domaine

DELETE /v1/domain/{id}

Supprime un objet Domain

Définissez domain_id en utilisant les ID de vos propres réponses API.

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

Nom	Emplacement	Requis	Description
id	chemin	oui	Identifiant de ressource issu des résultats API de votre équipe.
X-Tenant-ID	en-tête	oui	ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

curl --fail-with-body --request DELETE "$ADIOS_API_URL/v1/domain/${ADIOS_DOMAIN_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Réponse : HTTP 200

Ressource supprimée.

Champs de réponse

Champ	Type	Description
message	chaîne

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

{
  "message": "Deleted successfully"
}

Vérifier le domaine

POST /v1/domain/{id}/verify

Vérifiez le CNAME de propriété fourni lors de la création du domaine. Configurez le DNS avant d’envoyer cette requête.

Définissez domain_id en utilisant les ID de vos propres réponses API.

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

Nom	Emplacement	Requis	Description
id	chemin	oui	Identifiant de ressource issu des résultats API de votre équipe.
X-Tenant-ID	en-tête	oui	ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/domain/${ADIOS_DOMAIN_ID}/verify" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.