Introduction
Understand general concepts, response codes, and authentication strategies.
Base URL
The Illusory API is built on REST principles. We enforce HTTPS in every request to improve data security, integrity, and privacy. The API does not support HTTP.
All requests contain the following base URL:
Authentication
To authenticate you need to add an Authorization header with the contents of the header being Bearer zpka_12345
where zpka_12345
is your API Key.
Types of API Keys
API keys come in two types:
Master
Limited
Each key type is designed with certain permissions, enabling or restricting it from executing particular tasks. Here’s a breakdown of the capabilities associated with each key type.
Type | Scope | Description |
---|---|---|
Master | account.all , proxies.all | Full access to all endpoints |
Limited | proxies.change_ip | Can change IP of proxies |
Rate Limiting
Different endpoints have different rate limits. If you exceed the rate limit you will receive a 429
response code.
Was this page helpful?