List of general and specific errors you may encounter when using the REST API.
These error codes are consistent for all endpoints.
You’re not authorized to use the endpoint. This usually happens due to missing an user token.
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.
There was an error with the request, the error.message
would contain information about the issue.
This errors is similar to the HTTP 500 Internal Server Error error code.
The requested resource could not be found
The endpoint you’re requesting does not handle the method you defined. The error message will contain the methods the endpoint responds to.
These error codes can happen when using any deployment related endpoint.
Some of the files you defined when creating the deployment are missing.
You tried to create an empty deployment.
The limit of environment variables per deployment is 100 and you defined more. The error message indicates the amount you define.
#
is your number of variables.
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.
An environment variable name is too long, the maximum permitted name is 256 characters.
The error message contains the environment KEY
.
An environment variable value contains a value too long, the maximum permitted value is 65536 characters.
The error message contains the environment KEY
.
The value of an environment variable is object but it doesn’t have a uid
.
The error message contains the environment KEY
which has the error.
The value of an environment variable is an object with unknown attributes, it only can have a uid
key inside the object.
An environment variable value passed is of an unsupported type.
The error message contains the environment KEY
.
You’re trying to use a secret but you don’t have access to it.
You’re trying to use a secret as an environment value and it doesn’t exists.
These error code could happen when using any domains related endpoints.
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 the DOMAIN
key.
The domain name could not be found in our system. Try to add it first.
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.
You must remove the certificates described in the error before removing the domains.
The certificates are specified in the CERT_CNS
key.
You must remove the aliases described in the error before removing the domains.
The aliases are specified in the ALIASES
key.
When trying to modify a domain nothing was required to change.
When trying to add a domain the name wasn’t present in the request body.
The domain name defined in the request body is invalid.
The name is specified in the error as the NAME
key.
In order to add a custom domain to your account or team you need to upgrade to a paid plan.
The domain name you’re trying to add already exists.
The domain name and its current ID are received in the NAME
and DOMAIN_ID
keys.
The domain name can’t be created. Most probably it couldn’t be verified.
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.
We’re unable to determine the domain price of a domain.
The expectedPrice
supplied in the request body does not match the actual domain price, which is specified in the actualPrice
key.
The domain name is not available to be purchased.
The domain name or TLD is invalid or not supported.
The DNS record key name
is required and was not provided. It could be any valid DNS record.
These error code could happen when using any DNS related endpoint.
The DNS record key name
is required and was not provided. It should be either a subdomain or @
for the domain itself.
The DNS record key name
is required and was not provided. It could be any valid DNS record.
These errors could occur when using any OAuth2 related endpoint.
The OAuth2 client ID could not be found or doesn’t exist.
List of general and specific errors you may encounter when using the REST API.
These error codes are consistent for all endpoints.
You’re not authorized to use the endpoint. This usually happens due to missing an user token.
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.
There was an error with the request, the error.message
would contain information about the issue.
This errors is similar to the HTTP 500 Internal Server Error error code.
The requested resource could not be found
The endpoint you’re requesting does not handle the method you defined. The error message will contain the methods the endpoint responds to.
These error codes can happen when using any deployment related endpoint.
Some of the files you defined when creating the deployment are missing.
You tried to create an empty deployment.
The limit of environment variables per deployment is 100 and you defined more. The error message indicates the amount you define.
#
is your number of variables.
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.
An environment variable name is too long, the maximum permitted name is 256 characters.
The error message contains the environment KEY
.
An environment variable value contains a value too long, the maximum permitted value is 65536 characters.
The error message contains the environment KEY
.
The value of an environment variable is object but it doesn’t have a uid
.
The error message contains the environment KEY
which has the error.
The value of an environment variable is an object with unknown attributes, it only can have a uid
key inside the object.
An environment variable value passed is of an unsupported type.
The error message contains the environment KEY
.
You’re trying to use a secret but you don’t have access to it.
You’re trying to use a secret as an environment value and it doesn’t exists.
These error code could happen when using any domains related endpoints.
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 the DOMAIN
key.
The domain name could not be found in our system. Try to add it first.
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.
You must remove the certificates described in the error before removing the domains.
The certificates are specified in the CERT_CNS
key.
You must remove the aliases described in the error before removing the domains.
The aliases are specified in the ALIASES
key.
When trying to modify a domain nothing was required to change.
When trying to add a domain the name wasn’t present in the request body.
The domain name defined in the request body is invalid.
The name is specified in the error as the NAME
key.
In order to add a custom domain to your account or team you need to upgrade to a paid plan.
The domain name you’re trying to add already exists.
The domain name and its current ID are received in the NAME
and DOMAIN_ID
keys.
The domain name can’t be created. Most probably it couldn’t be verified.
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.
We’re unable to determine the domain price of a domain.
The expectedPrice
supplied in the request body does not match the actual domain price, which is specified in the actualPrice
key.
The domain name is not available to be purchased.
The domain name or TLD is invalid or not supported.
The DNS record key name
is required and was not provided. It could be any valid DNS record.
These error code could happen when using any DNS related endpoint.
The DNS record key name
is required and was not provided. It should be either a subdomain or @
for the domain itself.
The DNS record key name
is required and was not provided. It could be any valid DNS record.
These errors could occur when using any OAuth2 related endpoint.
The OAuth2 client ID could not be found or doesn’t exist.