HelipodDocs

Errors

Error codes of the Container API.

Errors use the shared envelope: { "success": false, "error": "...", "code": "..." }.

StatuscodeWhen
400INVALID_SPECThe service definition or stack spec is invalid; error names the first problem
400INVALID_SOURCEregistryUsername without registryPassword (or the other way round)
400INVALID_VARIABLESA key is not a valid variable name, or too many variables
400INVALID_DOMAINCustom domain missing or not allowed
400INVALID_VOLUMEThe mount path is not a valid absolute path
400INVALID_NAMEA project name shorter than 3 characters
400INVALID_CODEFunction code over 512 KB
400INVALID_FILEA secret file is not valid base64, is empty or is over 10 MB
400NOTHING_TO_UPDATEA PATCH or PUT without any field to change
400CONFIRMATION_REQUIREDDeleting a project or environment without its exact name in confirm
400MISSING_INPUTSA required stack or template input is empty
400INVALID_IDEMPOTENCY_KEYThe Idempotency-Key header has the wrong format
400INVALID_REQUEST / REQUEST_ERRORAnother business rule, error explains
401NO_API_KEY, INVALID_API_KEY, API_KEY_EXPIREDAuthentication failed
402PLAN_LIMIT (or a specific plan code)Your plan does not allow it: number of services, CPU, memory, storage, custom domains
403SCOPE_NOT_ALLOWEDThe key was not given the Container API
403KEY_PROJECT_SCOPEDCreating or deleting a project with a key limited to one project
403FORBIDDENOnly the project's owner can do this
404PROJECT_NOT_FOUND, ENVIRONMENT_NOT_FOUND, SERVICE_NOT_FOUND, DEPLOYMENT_NOT_FOUND, VARIABLE_NOT_FOUND, DOMAIN_NOT_FOUND, VOLUME_NOT_FOUND, FILE_NOT_FOUND, SCALE_NOT_FOUND, NOT_FOUNDDoesn't exist, or the key can't reach it
409DEPLOY_IN_PROGRESSA deployment of this service is already running
409NOT_RUNNINGRestart needs a running service
409PROJECT_NOT_EMPTYThe project still has services, VPS, databases or an email plan; error lists them
409ENVIRONMENT_EXISTSThe project already has an environment with that name
409ENVIRONMENT_NOT_EMPTYThe environment still has services
409SERVICE_NAME_TAKENAnother service in the environment has that name
409VOLUME_TOO_SMALLA volume can't be made smaller than the space it uses
409NOT_A_FUNCTIONFunction code on a service that is not a function
409REQUEST_IN_PROGRESSA request with the same Idempotency-Key is still running
422VALIDATION_ERRORThe body or query does not match the schema; error names the field
429RATE_LIMITEDToo many requests, see Retry-After
500INTERNAL_ERRORSomething went wrong on our side. Retry later