914 B
914 B
Server Authenticator
Authentication Headers
The following headers are used to identify yourself to the API client. These should be sent as standard HTTP headers with any API request.
Header:
X-Server-API-Key
The API token for a server that you wish to authenticate with.
Example:
f29a45f0d4e1744ebaee
Errors
The errors listed below may be raised if any issues occur when verifying your identity with the API.
Error:
InvalidServerAPIKey
The API token provided in X-Server-API-Key was not valid.
Attributes:
token
The token that was looked up
Error:
ServerSuspended
The mail server has been suspended
Attributes: none
| Error | Attributes |
|---|---|
| InvalidServerAPIKey | |
| The API token provided in X-Server-API-Key was not valid. | * token The token that was looked up |
| ServerSuspended The mail server has been suspended |