{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-rest-v1.yaml","sidebar":"sidebar-sidebar.yaml__rest-v1"},"props":{"definitionId":"rest-v1.yaml","dynamicMarkdocComponents":[],"baseSlug":"/rest-v1","seo":{"title":"Push Security REST API","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Push Security REST API","description":"## Overview\n\nThe 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.\n\nThe API uses JSON-formatted request bodies and responses along with standard HTTP response codes, authentication methods, and HTTP verbs.\n\n[Rate limits](#section/Rate-limits) are in place to ensure consistent performance for all users.\n\n## Authentication\n\nTo 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](https://console.pushsecurity.com/app/settings/api-keys) page in the Push admin console.\n\nWhen 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.\n\nTo authenticate your API requests, include a header named `x-api-key` and set its value to your API key.\n\nAll API calls must be made over HTTPS.\n\n## Rate limits\n\nThe 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.\n\nIf you surpass these limits, the API will return a 429 status code as an indication.\n\n## Errors\n\nThe Push Security API uses standard HTTP response codes to signal the outcome of an API call. Here's what you need to know:\n\n2xx codes: These indicate that your request was successful.\n\n4xx codes: A client-side issue, usually because something is missing or incorrect in your request.\n\n5xx codes: These suggest a problem on our end, although these occurrences are infrequent.\n\n### Common Response Codes\n\n| HTTP Code | Description                                             |\n|-----------|---------------------------------------------------------|\n| 200 OK    | Your request was successfully processed.                 |\n| 400 Bad Request | Your request is missing something or is incorrect. Double-check your parameters.  |\n| 429 Too Many Requests | You've exceeded the rate limits. Consider implementing exponential backoffs in your API calls.  |\n| 500 Server Error | Something's not right on our end.                      |\n\n## Versioning\n\nYou're currently working with version 1 of the Push Security API. Should there be any breaking changes in the future, we'll bump up the API version number. If you hold an active API key, we'll send you notifications over email about the deprecation date for the older version."},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"push-security-prd-ba8f0f76-a2d2-42f5-aea2-d421.redocly.app","port":4000,"ipAddress":"216.73.216.197"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/rest-v1","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}