Référence de l'API
Secrets
Listez, créez, mettez à jour et supprimez les secrets de projet via l'API. Les valeurs sont en écriture seule — elles ne sont jamais retournées en clair.
Dernière mise à jour :
API Secrets
Gérez les secrets de projet — clés API, jetons et autres identifiants que votre projet déployé lit depuis process.envà l'exécution. Les valeurs sont en écriture seule : elles entrent via ces endpoints et sortent via le runtime du projet déployé, et ne sont jamais retournées dans aucune réponse API.
Pour en savoir plus sur le fonctionnement des secrets et leur stockage, consultez le guide Secrets & Variables d'environnement.
Lister les secrets
GET /api/v1/projects/{projectId}/secretsRetourne l'ensemble des secrets définis sur un projet. Seuls le nom de la clé, les quatre derniers caractères de la valeur et les horodatages sont retournés.
Réponse :
{
"data": {
"secrets": [
{
"key": "STRIPE_SECRET_KEY",
"lastFour": "aB3x",
"createdAt": "2026-04-18T09:12:44.000Z",
"updatedAt": "2026-04-21T15:03:10.000Z"
}
]
}
}Créer ou mettre à jour un secret
POST /api/v1/projects/{projectId}/secrets{ "key": "STRIPE_SECRET_KEY", "value": "sk_live_..." }Idempotent par (projectId, key)— republier la même clé écrase la valeur stockée. Les mises à jour ne comptent pas dans le plafond par projet ; seul l'ajout d'une nouvelle clé le fait.
Format de clé : UPPER_SNAKE_CASE, 1–64 caractères, doit commencer par une lettre. Longueur de la valeur : 1–4096 caractères.
Réponse :
{
"data": {
"secret": {
"key": "STRIPE_SECRET_KEY",
"lastFour": "aB3x",
"createdAt": "2026-04-18T09:12:44.000Z",
"updatedAt": "2026-04-21T15:03:10.000Z"
}
}
}Supprimer un secret
DELETE /api/v1/projects/{projectId}/secrets/{key}Supprime un secret. Idempotent — supprimer une clé qui n'existe pas retourne quand même success: true, avec existedindiquant si une ligne a effectivement été supprimée.
Réponse :
{ "data": { "success": true, "existed": true } }Erreurs
- 400
VALIDATION_ERROR— La forme du corps est incorrecte, la clé échoue à la vérification de format, ou la valeur est vide ou dépasse 4096 caractères. - 404
NOT_FOUND— Le projet n'existe pas ou la clé API de l'appelant n'y est pas associée. Pour les écritures/suppressions, l'appelant doit également avoir le rôle adminsur l'équipe propriétaire. - 409
SECRET_LIMIT_EXCEEDED— Le projet possède déjà 25 secrets. Supprimez-en un ou mettez à jour une clé existante plutôt que d'en ajouter une nouvelle. - 429
RATE_LIMITED— Limite de débit API dépassée. Consultez Gestion des erreurs pour plus de détails.