You can find our complete REST API documentation here.
You can find our API Libraries here.
Create Additional API Key
Note: Each account can store up to 15 unique API Keys
An API key is a 96-character GUID that serves as a secure credential for accessing your account and making API calls outside of the user interface. Every API call requires this unique key, which is distinct from the credentials used for SMTP relay communication.
New accounts don't contain any pre-generated API keys. To create a new key, simply click the button below:
At this stage, you can configure custom permissions for the API key and define optional access restrictions. These restrictions limit the API key's functionality to a specific IP address or range, as specified in the designated field.
After clicking the "Create" button, a popup will display your newly created API key. Be sure to copy and save it in a secure location, as you will not be able to retrieve it once the window is closed. For security purposes, the system will obfuscate the key after creation, showing only the last five characters.
You can create additional API keys as needed. This can be particularly useful if you need to share a key with someone while assigning different permissions for its use.
Manage API Keys
This screen contains every API Key that was already created. You can modify their properties or delete them here.
Edit
This option will allow you to change the details of your API Key like permissions or name.
Change API Key
This will generate a new API Key for the particular credentials you chose. This way only the API Key will be changed and the permissions you chose for it will stay the same. This is the only way to regain access to this particular credential if you somehow misplaced the key.
Delete
This option allows you to delete an API Key that you no longer need.
Default API key for subaccounts created through the API
When you create a subaccount through the API, a default API key for that subaccount is generated automatically. This key is created with a 48 hour expiration period.
The default key can be retrieved through the API, so a key of this kind with full access and no expiration date would stay retrievable indefinitely. The limited lifetime is a security measure that prevents this.
Within those 48 hours, generate a new API key for the subaccount with the privileges your integration requires, which can also be full access. A key you generate yourself does not need an expiration date.
If the 48 hour period passes, a new default key is generated.
Security Information
We support TLS 1.2 and SSL connections.
API connection limits
20 concurrent requests from single IP
Connection time-out = 600 seconds