preview.session.create
Markdownv0.3.0
Ouvrir un aperçu en tant que membre du projet : rend l'adresse où entrer, à usage unique.
- API
POST /v1/projects/{projectId}/environments/{environmentId}/preview-sessions - CLI
bastide preview session create
EX-RUN-180, mode « membres du projet ». L'adresse porte un code valable une minute, que l'edge échange contre une session d'une heure ; hors de ce mode, elle est celle de l'aperçu. « address » choisit l'adresse d'un déploiement de cet aperçu : elle se visite pendant sa rétention, même l'aperçu détruit.
| Propriété | Valeur |
|---|---|
| Niveau | project |
| Rang minimal | reader |
| Rôle transversal | — |
| Portées | project:read |
| Compte de service | ne la mène pas : elle est réservée à une personne |
| Réversibilité | E — réversible avec effort : validation d'une personne avant l'appel, puis cinq minutes pour tout défaire d'un seul appel |
| Idempotence | une clé d'idempotence est acceptée : le rejeu rend la première réponse |
| Limites de débit, par jeton | 600 appels par 60 secondes (general), et 60 appels par 60 secondes (sensitive) |
API
POST /v1/projects/{projectId}/environments/{environmentId}/preview-sessions — succès en 201.
| Paramètre | Où | Type | Requis | Description |
|---|---|---|---|---|
projectId | chemin | texte, motif ^prj_[0-9A-HJKMNP-TV-Z]{26}$ | oui | Identifiant de projet |
environmentId | chemin | texte, motif ^env_[0-9A-HJKMNP-TV-Z]{26}$ | oui | Identifiant de environnement |
Idempotency-Key | en-tête | texte, de 8 à 128 caractères | non | Clé d'idempotence. Un rejeu portant la même clé retourne le résultat initial sans nouvel effet de bord, et la réponse porte alors « Idempotency-Replayed: true ». Équivaut au champ « idempotencyKey » du corps ; les deux à la fois ne sont acceptés que s'ils sont identiques. |
returnTo | corps | texte, 2048 caractères au plus | non | Le chemin de l'aperçu où arriver. Tout autre chose qu'un chemin local vaut « / ». |
address | corps | texte, 253 caractères au plus, motif ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+$ | non | L'adresse où entrer : celle de la branche, ou celle d'un déploiement de cet aperçu. Absente : celle de la branche. |
idempotencyKey | corps | texte, de 8 à 128 caractères | non | Clé d'idempotence, obligatoire. Un rejeu portant la même clé rend le résultat initial, sans nouvel effet de bord. |
La réponse :
| Champ | Type | Description |
|---|---|---|
url | texte, format uri | L'adresse à ouvrir. Avec un code : une fois, dans la minute. |
singleUse | booléen | Vrai quand l'adresse porte un code d'entrée. |
expiresAt | texte, format date-time, ou nul | |
undoToken | nul |
En-têtes de la réponse : RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, RateLimit-Policy, Idempotency-Replayed.
Autres réponses : 400, 401, 403, 404, 409, 429, 500, 503 — communes à toute opération.
Ligne de commande
bastide preview session create --project-id <valeur> --environment-id <valeur>
| Option | Type | Requise | Défaut | Description |
|---|---|---|---|---|
--project-id | texte | oui | — | Identifiant de projet |
--environment-id | texte | oui | — | Identifiant de environnement |
--return-to | texte | non | — | Le chemin de l'aperçu où arriver. Tout autre chose qu'un chemin local vaut « / ». |
--address | texte | non | — | L'adresse où entrer : celle de la branche, ou celle d'un déploiement de cet aperçu. Absente : celle de la branche. |
--idempotency-key | texte | non | — | Clé d'idempotence, obligatoire. Un rejeu portant la même clé rend le résultat initial, sans nouvel effet de bord. |
La commande demande une confirmation avant d'agir, sauf avec « --yes ».
MCP
Aucun outil : elle rend la valeur d'un secret, une seule fois, ou la refuse à tous : aucun outil MCP ne renvoie la valeur d'un secret, quelle que soit la portée du jeton (EX-MCP-070, EX-SEC-270).
Erreurs
| Code | Surface | Cause |
|---|---|---|
conflict | les deux | La demande contredit l'état courant de la ressource. |
idempotency_key_conflict | API | Deux clés d'idempotence différentes ont été présentées, dans le corps et dans l'en-tête. |
valeur_rendue_une_fois | API | Ce que l'opération crée n'est rendu qu'au premier appel : la plateforme n'en garde pas de copie, et un rejeu ne peut pas le rendre. |
S'y ajoutent les refus communs à toute opération — entrée invalide, authentification, autorisation, cible introuvable, conflit, limite de débit, indisponibilité — que le catalogue des erreurs décrit.
Exemples
Ouvrir l'aperçu d'une branche depuis la console :
{
"projectId": "prj_01JQ8ZK4M7NP2RSTVWXYZ34567",
"environmentId": "env_01JQ8ZK4M7NP2RSTVWXYZ34567",
"returnTo": "/",
"idempotencyKey": "entree-apercu-2026-10-01"
}