Référence de l'API

Erreurs

Format des erreurs de l'API et liste des codes.

Une erreur répond avec un statut HTTP 4xx ou 5xx et un objet error. code est stable et se teste dans votre code ; message est en français et s'affiche à une personne.

Format
{
  "error": {
    "code": "not_found",
    "message": "Projet introuvable."
  }
}

Codes

StatutCodeCauseQue faire
400bad_requestCorps ou paramètre invalide. Le message nomme le champ en cause.Corrigez la requête.
400missing_filesDes fichiers du déploiement ne sont pas encore envoyés. La réponse liste leurs empreintes dans missing.Envoyez-les par /v2/files, puis recréez le déploiement.
400invalid_digestLe contenu envoyé ne correspond pas à l'empreinte annoncée.Recalculez le SHA1 du fichier.
403forbiddenClé absente, inconnue ou révoquée, ou clé de projet utilisée pour un autre projet.Vérifiez la clé et sa portée.
404not_foundRessource introuvable, ou hors de la portée de la clé.Vérifiez l'identifiant ou le nom.
409conflictUn projet porte déjà ce nom.Choisissez un autre nom, ou utilisez le projet existant.
409deployment_closedLe build CI auquel ces fichiers étaient destinés a été annulé ou a échoué.Relancez le build.
413file_too_largeUn fichier dépasse 20 Mo.Allégez le fichier ou servez-le ailleurs.
413payload_too_largeLes fichiers inclus dans le corps dépassent 20 Mo au total.Envoyez-les par /v2/files.
429rate_limitedTrop de requêtes pour cette clé.Attendez un instant et réessayez.
500internal_server_errorErreur de la plateforme. Elle nous est signalée automatiquement.Réessayez. Si elle persiste, écrivez-nous.

Le cas de missing_files

Ce n'est pas une vraie erreur : c'est l'étape normale d'un déploiement. La CLI la traite toute seule. Si vous écrivez votre propre client, voici la réponse :

400
{
  "error": {
    "code": "missing_files",
    "message": "Fichiers à envoyer avant de créer le déploiement.",
    "missing": [
      "2ef7bde608ce5404e97d5f042f95f89f1c232871"
    ]
  }
}