API des routes de passerelle

Acheminez un nom d’hôte vérifié vers un workload, un workflow, une URL ou un bucket d’objets. Définissez l’identifiant correspondant à target_kind.

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/gateway_route	Lister les routes de passerelle
POST	/v1/gateway_route	Créer une route de passerelle
GET	/v1/gateway_route/{id}	Obtenir la route de passerelle
PUT	/v1/gateway_route/{id}	Mettre à jour la route de passerelle
DELETE	/v1/gateway_route/{id}	Supprimer la route de passerelle

Lister les routes de passerelle

GET /v1/gateway_route

Renvoie une liste paginée de GatewayRoute

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/gateway_route" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Réponse : HTTP 200

Liste de GatewayRoute

Champs de réponse

Champ	Type	Description
data	tableau
data[].auth_policy	objet	Politique d’authentification des utilisateurs de la passerelle. Elle concerne l’authentification de l’application, pas celle de l’API ou de l’administration.
data[].created_at	entier	(horodatage Unix)
data[].deleted_at	entier	(horodatage Unix)
data[].enabled	booléen
data[].exposure	chaîne	Valeurs autorisées : public, auth, private.
data[].geo_policy	objet	Politique facultative d’autorisation ou de blocage par pays
data[].hostname	chaîne
data[].object_bucket_id	chaîne
data[].path_prefix	chaîne
data[].priority	entier
data[].rewrite_to	chaîne	Chemin de réécriture facultatif appliqué avant le proxy (par exemple /v1)
data[].route_id	chaîne
data[].security_policy	objet	Surcharge facultative des paramètres de sécurité HTTP au niveau de la route
data[].strip_prefix	booléen
data[].target_kind	chaîne	Valeurs autorisées : workload, workflow, url, object_storage.
data[].target_url	chaîne	URL absolue utilisée lorsque target_kind=url
data[].team_id	chaîne
data[].traffic_policy	objet	Politique régionale de trafic facultative au niveau de la route, pour sélectionner la cible de passerelle
data[].trigger_name	chaîne
data[].updated_at	entier	(horodatage Unix)
data[].workflow_id	chaîne
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": [
    {
      "auth_policy": {},
      "created_at": 1791072000,
      "deleted_at": 0,
      "enabled": true,
      "exposure": "public",
      "geo_policy": {},
      "hostname": "app.example.com",
      "object_bucket_id": "000000000000000000000000001",
      "path_prefix": "/",
      "priority": 0,
      "rewrite_to": "example",
      "route_id": "000000000000000000000000001",
      "security_policy": {},
      "strip_prefix": false,
      "target_kind": "workload",
      "target_url": "example",
      "team_id": "000000000000000000000000001",
      "traffic_policy": {},
      "trigger_name": "example",
      "updated_at": 1791072000,
      "workflow_id": "example",
      "workload_id": "000000000000000000000000001"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Créer une route de passerelle

POST /v1/gateway_route

Crée un nouvel objet GatewayRoute

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
auth_policy	objet	non	Politique d’authentification des utilisateurs de la passerelle. Elle concerne l’authentification de l’application, pas celle de l’API ou de l’administration.
enabled	booléen	oui	Valeur par défaut : true.
exposure	chaîne	oui	Valeurs autorisées : public, auth, private. Valeur par défaut : "public".
geo_policy	objet	non	Politique facultative d’autorisation ou de blocage par pays
hostname	chaîne	oui
object_bucket_id	chaîne	non
path_prefix	chaîne	oui	Valeur par défaut : "/".
priority	entier	oui	Valeur par défaut : 0.
rewrite_to	chaîne	non	Chemin de réécriture facultatif appliqué avant le proxy (par exemple /v1)
security_policy	objet	non	Surcharge facultative des paramètres de sécurité HTTP au niveau de la route
strip_prefix	booléen	oui	Valeur par défaut : false.
target_kind	chaîne	oui	Valeurs autorisées : workload, workflow, url, object_storage. Valeur par défaut : "workload".
target_url	chaîne	non	URL absolue utilisée lorsque target_kind=url
team_id	chaîne	oui
traffic_policy	objet	non	Politique régionale de trafic facultative au niveau de la route, pour sélectionner la cible de passerelle
trigger_name	chaîne	non
workflow_id	chaîne	non
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/gateway_route" \
  -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",
  "path_prefix": "/",
  "target_kind": "workload",
  "workload_id": "YOUR_WORKLOAD_ID",
  "exposure": "public",
  "priority": 0,
  "strip_prefix": false,
  "enabled": true
}
JSON

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

Réponse : HTTP 201

GatewayRoute créé

Champs de réponse

Champ	Type	Description
auth_policy	objet	Politique d’authentification des utilisateurs de la passerelle. Elle concerne l’authentification de l’application, pas celle de l’API ou de l’administration.
created_at	entier	(horodatage Unix)
deleted_at	entier	(horodatage Unix)
enabled	booléen
exposure	chaîne	Valeurs autorisées : public, auth, private.
geo_policy	objet	Politique facultative d’autorisation ou de blocage par pays
hostname	chaîne
object_bucket_id	chaîne
path_prefix	chaîne
priority	entier
rewrite_to	chaîne	Chemin de réécriture facultatif appliqué avant le proxy (par exemple /v1)
route_id	chaîne
security_policy	objet	Surcharge facultative des paramètres de sécurité HTTP au niveau de la route
strip_prefix	booléen
target_kind	chaîne	Valeurs autorisées : workload, workflow, url, object_storage.
target_url	chaîne	URL absolue utilisée lorsque target_kind=url
team_id	chaîne
traffic_policy	objet	Politique régionale de trafic facultative au niveau de la route, pour sélectionner la cible de passerelle
trigger_name	chaîne
updated_at	entier	(horodatage Unix)
workflow_id	chaîne
workload_id	chaîne

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

{
  "auth_policy": {},
  "created_at": 1791072000,
  "deleted_at": 0,
  "enabled": true,
  "exposure": "public",
  "geo_policy": {},
  "hostname": "app.example.com",
  "object_bucket_id": "000000000000000000000000001",
  "path_prefix": "/",
  "priority": 0,
  "rewrite_to": "example",
  "route_id": "000000000000000000000000001",
  "security_policy": {},
  "strip_prefix": false,
  "target_kind": "workload",
  "target_url": "example",
  "team_id": "000000000000000000000000001",
  "traffic_policy": {},
  "trigger_name": "example",
  "updated_at": 1791072000,
  "workflow_id": "example",
  "workload_id": "000000000000000000000000001"
}

Obtenir la route de passerelle

GET /v1/gateway_route/{id}

Renvoie un seul GatewayRoute

Définissez gateway_route_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/gateway_route/${ADIOS_GATEWAY_ROUTE_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Réponse : HTTP 200

GatewayRoute

Champs de réponse

Champ	Type	Description
auth_policy	objet	Politique d’authentification des utilisateurs de la passerelle. Elle concerne l’authentification de l’application, pas celle de l’API ou de l’administration.
created_at	entier	(horodatage Unix)
deleted_at	entier	(horodatage Unix)
enabled	booléen
exposure	chaîne	Valeurs autorisées : public, auth, private.
geo_policy	objet	Politique facultative d’autorisation ou de blocage par pays
hostname	chaîne
object_bucket_id	chaîne
path_prefix	chaîne
priority	entier
rewrite_to	chaîne	Chemin de réécriture facultatif appliqué avant le proxy (par exemple /v1)
route_id	chaîne
security_policy	objet	Surcharge facultative des paramètres de sécurité HTTP au niveau de la route
strip_prefix	booléen
target_kind	chaîne	Valeurs autorisées : workload, workflow, url, object_storage.
target_url	chaîne	URL absolue utilisée lorsque target_kind=url
team_id	chaîne
traffic_policy	objet	Politique régionale de trafic facultative au niveau de la route, pour sélectionner la cible de passerelle
trigger_name	chaîne
updated_at	entier	(horodatage Unix)
workflow_id	chaîne
workload_id	chaîne

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

{
  "auth_policy": {},
  "created_at": 1791072000,
  "deleted_at": 0,
  "enabled": true,
  "exposure": "public",
  "geo_policy": {},
  "hostname": "app.example.com",
  "object_bucket_id": "000000000000000000000000001",
  "path_prefix": "/",
  "priority": 0,
  "rewrite_to": "example",
  "route_id": "000000000000000000000000001",
  "security_policy": {},
  "strip_prefix": false,
  "target_kind": "workload",
  "target_url": "example",
  "team_id": "000000000000000000000000001",
  "traffic_policy": {},
  "trigger_name": "example",
  "updated_at": 1791072000,
  "workflow_id": "example",
  "workload_id": "000000000000000000000000001"
}

Mettre à jour la route de passerelle

PUT /v1/gateway_route/{id}

Met à jour un objet GatewayRoute existant

Définissez gateway_route_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
auth_policy	objet	non	Politique d’authentification des utilisateurs de la passerelle. Elle concerne l’authentification de l’application, pas celle de l’API ou de l’administration.
enabled	booléen	oui	Valeur par défaut : true.
exposure	chaîne	oui	Valeurs autorisées : public, auth, private. Valeur par défaut : "public".
geo_policy	objet	non	Politique facultative d’autorisation ou de blocage par pays
hostname	chaîne	oui
object_bucket_id	chaîne	non
path_prefix	chaîne	oui	Valeur par défaut : "/".
priority	entier	oui	Valeur par défaut : 0.
rewrite_to	chaîne	non	Chemin de réécriture facultatif appliqué avant le proxy (par exemple /v1)
security_policy	objet	non	Surcharge facultative des paramètres de sécurité HTTP au niveau de la route
strip_prefix	booléen	oui	Valeur par défaut : false.
target_kind	chaîne	oui	Valeurs autorisées : workload, workflow, url, object_storage. Valeur par défaut : "workload".
target_url	chaîne	non	URL absolue utilisée lorsque target_kind=url
team_id	chaîne	oui
traffic_policy	objet	non	Politique régionale de trafic facultative au niveau de la route, pour sélectionner la cible de passerelle
trigger_name	chaîne	non
workflow_id	chaîne	non
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/gateway_route/${ADIOS_GATEWAY_ROUTE_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",
  "path_prefix": "/",
  "target_kind": "workload",
  "workload_id": "YOUR_WORKLOAD_ID",
  "exposure": "public",
  "priority": 0,
  "strip_prefix": false,
  "enabled": true
}
JSON

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

Réponse : HTTP 200

GatewayRoute mis à jour

Champs de réponse

Champ	Type	Description
auth_policy	objet	Politique d’authentification des utilisateurs de la passerelle. Elle concerne l’authentification de l’application, pas celle de l’API ou de l’administration.
created_at	entier	(horodatage Unix)
deleted_at	entier	(horodatage Unix)
enabled	booléen
exposure	chaîne	Valeurs autorisées : public, auth, private.
geo_policy	objet	Politique facultative d’autorisation ou de blocage par pays
hostname	chaîne
object_bucket_id	chaîne
path_prefix	chaîne
priority	entier
rewrite_to	chaîne	Chemin de réécriture facultatif appliqué avant le proxy (par exemple /v1)
route_id	chaîne
security_policy	objet	Surcharge facultative des paramètres de sécurité HTTP au niveau de la route
strip_prefix	booléen
target_kind	chaîne	Valeurs autorisées : workload, workflow, url, object_storage.
target_url	chaîne	URL absolue utilisée lorsque target_kind=url
team_id	chaîne
traffic_policy	objet	Politique régionale de trafic facultative au niveau de la route, pour sélectionner la cible de passerelle
trigger_name	chaîne
updated_at	entier	(horodatage Unix)
workflow_id	chaîne
workload_id	chaîne

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

{
  "auth_policy": {},
  "created_at": 1791072000,
  "deleted_at": 0,
  "enabled": true,
  "exposure": "public",
  "geo_policy": {},
  "hostname": "app.example.com",
  "object_bucket_id": "000000000000000000000000001",
  "path_prefix": "/",
  "priority": 0,
  "rewrite_to": "example",
  "route_id": "000000000000000000000000001",
  "security_policy": {},
  "strip_prefix": false,
  "target_kind": "workload",
  "target_url": "example",
  "team_id": "000000000000000000000000001",
  "traffic_policy": {},
  "trigger_name": "example",
  "updated_at": 1791072000,
  "workflow_id": "example",
  "workload_id": "000000000000000000000000001"
}

Supprimer la route de passerelle

DELETE /v1/gateway_route/{id}

Supprime un objet GatewayRoute

Définissez gateway_route_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/gateway_route/${ADIOS_GATEWAY_ROUTE_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"
}