deployment.hook.create
Markdownv0.3.0
Créer un crochet de déploiement : une adresse à appeler, signée, qui déploie une branche dans un environnement. Son secret est rendu une seule fois.
- API
POST /v1/projects/{projectId}/deploy-hooks - CLI
bastide deployment hook create
EX-BUILD-040. Lié à un couple branche-environnement et à lui seul ; chaque appel est signé en HMAC-SHA256 avec un horodatage, refusé au-delà de cinq minutes ; soixante déclenchements par heure et par projet ; révocable. Sur un aperçu, la branche est celle qu'il suit. Vingt crochets en vigueur au plus par projet.
| Propriété | Valeur |
|---|---|
| Niveau | project |
| Rang minimal | maintainer |
| Rôle transversal | — |
| Portées | deploy:write |
| Compte de service | ne la mène pas : elle est réservée à une personne |
| Réversibilité | R — réversible : exécution directe, tracée, annulable |
| 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}/deploy-hooks — 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 |
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. |
environmentId | corps | texte, motif ^env_[0-9A-HJKMNP-TV-Z]{26}$ | oui | Identifiant de environnement |
branch | corps | texte, motif ^(?!-)[A-Za-z0-9._/@+-]{1,255}$ | oui | La branche que ce crochet déploie, et la seule. |
name | corps | texte, de 1 à 80 caractères | oui | À quoi sert ce crochet : il se relit dans la liste. |
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 |
|---|---|---|
hookId | texte, motif ^dhk_[0-9A-HJKMNP-TV-Z]{26}$ | Identifiant de crochet de déploiement |
environmentId | texte, motif ^env_[0-9A-HJKMNP-TV-Z]{26}$ | Identifiant de environnement |
branch | texte, motif ^(?!-)[A-Za-z0-9._/@+-]{1,255}$ | La branche que ce crochet déploie. |
name | objet (untrusted, source, content) | |
path | texte, motif ^\/v1\/deploy-hooks\/dhk_[0-9A-HJKMNP-TV-Z]{26}$ | Le chemin à appeler, sur l'adresse de l'API. Il n'est pas un secret. |
createdAt | texte, format date-time | |
secret | texte | Le secret de signature, préfixé « dhsec_ ». Rendu une seule fois, jamais relu. |
signatureHeader | toujours Bastide-Signature | L'en-tête où la signature se présente : « t=<secondes>,v1=<hex> ». |
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 deployment hook create --project-id <valeur> --environment-id <valeur> --branch <valeur> --name <valeur>
| Option | Type | Requise | Défaut | Description |
|---|---|---|---|---|
--project-id | texte | oui | — | Identifiant de projet |
--environment-id | texte | oui | — | Identifiant de environnement |
--branch | texte | oui | — | La branche que ce crochet déploie, et la seule. |
--name | texte | oui | — | À quoi sert ce crochet : il se relit dans la liste. |
--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 s'exécute sans confirmation.
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 |
|---|---|---|
quota_de_crochets_atteint | les deux | Le projet porte déjà le nombre publié de crochets de déploiement en vigueur : vingt. |
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. |
secret_store_unavailable | les deux | Le magasin de secrets est injoignable. |
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
Laisser un gestionnaire de contenu redéployer la production à chaque publication :
{
"projectId": "prj_01JQ8ZK4M7NP2RSTVWXYZ34567",
"environmentId": "env_01JQ8ZK4M7NP2RSTVWXYZ34567",
"branch": "main",
"name": "publication du gestionnaire de contenu",
"idempotencyKey": "crochet-de-deploiement-2026-10-02"
}