Generic Errors
These error codes are consistent for all endpoints.Forbidden
You’re not authorized to use the endpoint. This usually happens due to missing an user token.Similar to the HTTP 403 Forbidden error.
error-response-forbidden
Rate Limited
You exceeded the maximum allotted requests. The limit of request is per endpoint basis so you could continue using another endpoints even if some of them give you this error.error-response-rate-limited
Bad Request
There was an error with the request, theerror.message
would contain information about the issue.
error-response-bad-request
Internal Server Error
This errors is similar to the HTTP 500 Internal Server Error error code.error-response-internal-server-error
Resource Not Found
The requested resource could not be founderror-response-not-Found
Method Unknown
The endpoint you’re requesting does not handle the method you defined. The error message will contain the methods the endpoint responds to.error-response-method-unknown
Deployment Errors
These error codes can happen when using any deployment related endpoint.Missing Files
Some of the files you defined when creating the deployment are missing.error-response-missing-files
No Files in the Deployment
You tried to create an empty deployment.error-response-no-files
Too Many Environment Variables
The limit of environment variables per deployment is 100 and you defined more. The error message indicates the amount you define.error-response-too-many-env-keys
#
is your number of variables.Environment Variable Key with Invalid Characters
Some environment variable name contains an invalid character. The only valid characters are letters, digits and_
.
The error message will contain the KEY
with the problem.
error-response-env-key-invalid-characters
Environment Variable Key with a Long Name
An environment variable name is too long, the maximum permitted name is 256 characters. The error message contains the environmentKEY
.
error-response-env-key-invalid-length
Environment Variable Value with a Long Name
An environment variable value contains a value too long, the maximum permitted value is 65536 characters. The error message contains the environmentKEY
.
error-response-env-value-invalid-length
Environment Variable Value Is an Object without UID
The value of an environment variable is object but it doesn’t have auid
.
The error message contains the environment KEY
which has the error.
error-response-env-value-invalid-type
Environment Variable Value Is an Object with Unknown Props
The value of an environment variable is an object with unknown attributes, it only can have auid
key inside the object.
error-response-env-value-invalid-type
Environment Variable Value with an Invalid Type
An environment variable value passed is of an unsupported type. The error message contains the environmentKEY
.
error-response-env-value-invalid-type
Not Allowed to Access a Secret
You’re trying to use a secret but you don’t have access to it.error-response-secret-forbidden
Missing Secret
You’re trying to use a secret as an environment value and it doesn’t exists.error-response-secret-missing
Domain Errors
These error code could happen when using any domains related endpoints.Domain Forbidden
You don’t have access to the domain, this usually mean this domains is owned by another account or team. The domain is specified in the message and theDOMAIN
key.
error-response-forbidden
Domain Not Found
The domain name could not be found in our system. Try to add it first.error-response-not-found
Missing Domain Name
The domain name wasn’t specified in the URL. This means you tried to use an endpoint which require you to define the domain name in the URL but didn’t defined it.error-response-missing-name
Conflicting Certificates
You must remove the certificates described in the error before removing the domains. The certificates are specified in theCERT_CNS
key.
error-response-conflict-certs
Conflicting Aliases
You must remove the aliases described in the error before removing the domains. The aliases are specified in theALIASES
key.
error-response-conflict-alias
Not Modified
When trying to modify a domain nothing was required to change.error-response-not-modified
Missing Name for Domain
When trying to add a domain the name wasn’t present in the request body.error-response-missing-name
Invalid Name for Domain
The domain name defined in the request body is invalid. The name is specified in the error as theNAME
key.
error-response-invalid-name
Custom Domain Needs a Plan Upgrade
In order to add a custom domain to your account or team you need to upgrade to a paid plan.error-response-domain-needs-upgrade
Domain Already Exists
The domain name you’re trying to add already exists. The domain name and its current ID are received in theNAME
and DOMAIN_ID
keys.
error-response-not-modified
Can’t Create the Domain
The domain name can’t be created. Most probably it couldn’t be verified.error-response-forbidden
Failed to Add Domain after Purchase
We were able to purchase a domain for you but we had an error when trying to add it to your account. Please contact us on Contact Support.error-response-failed-add-domain
Unable to Determine the Domain Price
We’re unable to determine the domain price of a domain.error-response-service-unavailable
Domain price mismatch
TheexpectedPrice
supplied in the request body does not match the actual domain price, which is specified in the actualPrice
key.
error-response-price-mismatch
Domain Is Not Available
The domain name is not available to be purchased.error-response-not-available
Invalid Domain Name
The domain name or TLD is invalid or not supported.error-response-invalid-domain
Missing DNS Record Name
The DNS record keyname
is required and was not provided. It could be any valid DNS record.
error-response-missing-type
DNS Errors
These error code could happen when using any DNS related endpoint.Missing DNS Record Name
The DNS record keyname
is required and was not provided. It should be either a subdomain or @
for the domain itself.
error-response-missing-Name
Missing DNS Record Type
The DNS record keyname
is required and was not provided. It could be any valid DNS record.
error-response-missing-type
OAuth2 errors
These errors could occur when using any OAuth2 related endpoint.Client Not Found
The OAuth2 client ID could not be found or doesn’t exist.error-response-not-found