Push Security REST API (v1)
The Push Security REST API provides programmatic access to the administrative functionality of the Push platform. This API adheres to RESTful principles, featuring resource-oriented URLs that are predictable and easy to navigate.
The API uses JSON-formatted request bodies and responses along with standard HTTP response codes, authentication methods, and HTTP verbs.
Rate limits are in place to ensure consistent performance for all users.
To interact with the Push Security API, you'll need an API key for authentication. To create or manage your API keys, go to the Settings page in the Push admin console.
When generating a new key, you have two permission levels to choose from: Read only and Full access. A Read only key lets you make GET requests, while Full access allows for all types of requests.
To authenticate your API requests, include a header named x-api-key and set its value to your API key.
All API calls must be made over HTTPS.
The Push Security API enforces rate limiting to ensure equitable access and maintain performance. Each user is permitted up to 10 API requests per second, with a temporary burst capacity that allows an additional 10 requests for brief intervals.
If you surpass these limits, the API will return a 429 status code as an indication.
Responses are limited to 1MB. A request to a list endpoint that would return more than 1MB of data is rejected with a 422 status code and the status RESULT_SIZE_EXCEEDED. Lower the limit parameter and make the request again.
The Push Security API uses standard HTTP response codes to signal the outcome of an API call. Here's what you need to know:
2xx codes: These indicate that your request was successful.
4xx codes: A client-side issue, usually because something is missing or incorrect in your request.
5xx codes: These suggest a problem on our end, although these occurrences are infrequent.
| HTTP Code | Description |
|---|---|
| 200 OK | Your request was successfully processed. |
| 400 Bad Request | Your request is missing something or is incorrect. Double-check your parameters. |
| 422 Unprocessable Content | The requested page of results is larger than the 1MB response size limit. Lower the limit parameter. |
| 429 Too Many Requests | You've exceeded the rate limits. Consider implementing exponential backoffs in your API calls. |
| 500 Server Error | Something's not right on our end. |