Error codes
Microlink API considers an unexpected situation any request performed on which
status
is different from 'success'.When this happens, the response payload includes some useful information in order to determine the root cause of the problem:
id: The unique identifier associated with the request.code: The error code that represents the final request state.message: A brief explanantion about why the error happened.more: A link pointing this documentation.report: A link for reporting the problem directly to us.
If you are experience any of these errors are you not sure how to proceed, please feel free to
reach us
.EAUTH
Message
Invalid API key. Make sure you are attaching your API key as
x-api-key header.Solution
Ensure to
authenticate
your requests providing an API key attached as x-api-key.EBRWSRTIMEOUT
Message
The URL provided reached the maximum browser navigation time allowed.
Solution
When the target
url
reached the timeout
associated with the request lifecycle, this error is thrown.In order to avoid this error, the request should be resolved before timeout.
EFATAL
Message
Resolved the target URL failed. Make sure your URL is valid and it has HTML content.
Solution
This is the generic error used when it wasn't possible to determine the root cause of the problem.
If you are experimenting with this error, please
contact us
, reporting the request id to make it possible to reproduce the original request.EFILENAME
Message
You need a
PRO
plan for using filename
query parameter.Solution
See pricing for upgrading your plan.
EFATALCLIENT
Message
(no message)
Solution
There is a network problem trying to reach the API
endpoint
.If you are experimenting with this error, please
contact us
.EFORBIDDENURL
Message
The URL is being resolved into an IP address whose range is not allowed.
Solution
The service will only resolve URLs that point to unicast IP addresses.
EHEADERS
Message
You need a
PRO
plan for using headers
query parameters.Solution
See pricing for upgrading your plan.
EINVALURL
Message
The target URL is considered not valid.
Solution
Ensure the
url
provided has protocol, hostname and follows WHATWG URL
standard.EINVALPROXY
Message
The proxy URL is considered not valid.
Solution
Ensure the
url
provided can be parsed as WHATWG URL
.EINVALURLCLIENT
Message
The target URL is considered not valid.
Solution
Ensure the
url
provided has protocol, hostname and follows WHATWG URL
standard.EINVALTTL
Message
The
ttl value is invalid.Solution
EINVALSTTL
Message
The
staleTtl value is invalid.Solution
EMAXREDIRECTS
Message
The target URL reached the maximum number of redirect after 10 times.
Solution
Ensure the
url
provided reaches the destination URL in less than 10 hops.EPRO
Message
The request has
x-api-key header present and it has been performed against api.microlink.io
endpoint.Solution
In order to
authenticate
your requests, you need to perform them against pro.microlink.io
. Check endpoint
to know more.EPROXY
Message
You need a
PRO
plan for using proxy
query parameter.Solution
See pricing for upgrading your plan.
ERATE
Message
Your daily rate limit has been reached. You need to wait or extend your plan.
Solution
You need to extend your
rate limit
quota or wait until you’re quota reset.ETIMEOUT
Message
The request reached maximum timeout.
Solution
When the target
url
reached the timeout
associated with the request lifecycle, this error is thrown.In order to avoid this error, the request should be resolved before timeout.
ETTL
Message
You need a
PRO
plan for using ttl
query parameter.Solution
See pricing for upgrading your plan.
ESTTL
Message
You need a
PRO
plan for using staleTtl
query parameter.Solution
See pricing for upgrading your plan.