Authentication

In order to authenticate with Aptranet APIs, you are going to need 2 headers.

• Authorization
• Aptranet-Secret

In the Authorization header you will use the access key, and in the Aptranet-Secret header, you will use the secret that was generated when you created your API key via the Aptranet Management Console developer settings.

Rate Limiting

The Aptranet API has a general rate limit of 10 requests per second. If you hit the rate limit, the Aptranet Shield is going to return a response with HTTP Status 429, an error object as the response body, and a header named retry-after specifying the number of seconds left until you are allowed to perform a request again.

📘

Note

This rate limit is applied on the requester IP address, so if you have multiple servers this rate limit will be distinct for each individual server.