Skip to content
Browser Extensions

Push Security REST API (v1)

Overview

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.

Authentication

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.

Rate limits

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.

Errors

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.

Common Response Codes

HTTP CodeDescription
200 OKYour request was successfully processed.
400 Bad RequestYour request is missing something or is incorrect. Double-check your parameters.
429 Too Many RequestsYou've exceeded the rate limits. Consider implementing exponential backoffs in your API calls.
500 Server ErrorSomething's not right on our end.

Versioning

You'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.

Download OpenAPI description
rest-v1.json
rest-v1.yaml
Overview
URL
https://pushsecurity.com/contact/
support
support@pushsecurity.com
License
Commercial
Terms of Service
Languages
Servers
https://api.pushsecurity.com/

Accounts

These objects represent the accounts (owned by employees) in your organization.

Operations

Accounts (Other)

These objects represent the accounts (other) (owned by employees) in your organization.

Operations

Apps

These objects represent the apps that have been found in your organization.

Operations

Apps (Other)

These objects represent the apps (other) that have been found in your organization.

Operations

Browsers

These objects represent the browsers (used by employees) in your organization.

Operations

Browser Extensions

Operations

List browser extensions

Request

Retrieve a list of browser extension objects

Security
x-api-key
Query
extensionIdstring

Filter by the ID of the extension

employeeIdstring

Filter by an employee ID associated with this extension.

browserIdstring

Filter by a browserId associated with this extension.

deploymentModestring(DeploymentMode)

Filter by the deployment mode of the extension.

Enum"MANAGED""DEVELOPMENT""MANUAL""SIDELOAD""OTHER"
permissionsArray of strings

Filter for browser extensions that have certain permissions.

hostPermissionsArray of strings

Filter for browser extensions that have certain host permission patterns.

enabledboolean

Filter for extension that are enabled or disabled.

limitinteger[ 1 .. 500 ]

Used for pagination. Number of objects to return.

Default 500
nextTokenstring

Used for pagination. Token to be used for the next request. Cannot be set when offset is also set.

offsetintegerDeprecated

Used for pagination. Number of objects to skip. Cannot be set when nextToken is also set.

curl -i -X GET \
  https://api.pushsecurity.com/v1/browserExtensions \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
resultArray of objects(BrowserExtension)
result[].​idstring

Unique ID of this browser extension record

Example: "72d0347a-2663-4ef5-b1c5-df39163f1603"
result[].​extensionIdstring

Static identifier for the extension.

Example: "gmbgaklkmjakoegficnlkhebmhkjfich"
result[].​employeeIdstring

Identifier of primary employee that this extension belongs to

Example: "72d0347a-2663-4ef5-b1c5-df39163f1603"
result[].​browserIdstring

Identifier of the employee's Push extension

Example: "72d0347a-2663-4ef5-b1c5-df39163f1603"
result[].​namestring

Name of the browser extension

Example: "Privacy Badger"
result[].​descriptionstring

Description of the browser extension

Example: "Privacy Badger automatically learns to block invisible trackers."
result[].​deploymentModestring(DeploymentMode)

Which method was used to install this extension

Enum"MANAGED""DEVELOPMENT""MANUAL""SIDELOAD""OTHER"
result[].​permissionsArray of strings

Permissions required by the browser extension

Example: ["activeTab","contextMenus","storage"]
result[].​hostPermissionsArray of strings

Host permissions allow extensions to interact with the URLs matching these patterns.

Example: ["https://*/*","http://*/*"]
result[].​versionstring

Version of the browser extension

Example: "3.1.5.2"
result[].​versionNamestring

Version number shown to the user

Example: "build rc2"
result[].​enabledboolean

Whether the browser extension is enabled

Example: true
result[].​disabledReasonstring

Reason why the browser extension was disabled

Example: "NEW_PERMISSION_REQUIRED"
result[].​updateUrlstring

The URL where the browser extension gets updates from

Example: "http://clients2.google.com/service/update2/crx"
result[].​homePageUrlstring

Link to the browser extensions home page

Example: "http://www.eff.org/"
result[].​creationTimestampinteger

When this browser extension was created, formatted as a UNIX timestamp (in seconds)

Example: 1698064423
result[].​lastUpdatedTimestampinteger

When the browser extension was last used by an employee, formatted as a UNIX timestamp (in seconds)

Example: 1698064423
pagingobject
paging.​moreResultsboolean

Whether there are more results available

Example: true
paging.​nextTokenstring or null

Start of the next page that can be used as the nextToken for the next request.

Example: "0b9972aa-fe8d-4095-82d3-2e13cf3cfd43"
paging.​nextstring or nullDeprecated

Start of the next page that can be used as the offset for the next request

Example: "501"
Response
application/json
{
  "result": [
    {
      "id": "72d0347a-2663-4ef5-b1c5-df39163f1603",
      "extensionId": "gmbgaklkmjakoegficnlkhebmhkjfich",
      "employeeId": "72d0347a-2663-4ef5-b1c5-df39163f1603",
      "browserId": "72d0347a-2663-4ef5-b1c5-df39163f1603",
      "name": "Privacy Badger",
      "description": "Privacy Badger automatically learns to block invisible trackers.",
      "deploymentMode": "MANAGED",
      "permissions": [
        "activeTab",
        "contextMenus",
        "storage"
      ],
      "hostPermissions": [
        "https://*/*",
        "http://*/*"
      ],
      "version": "3.1.5.2",
      "versionName": "build rc2",
      "enabled": true,
      "disabledReason": "NEW_PERMISSION_REQUIRED",
      "updateUrl": "http://clients2.google.com/service/update2/crx",
      "homePageUrl": "http://www.eff.org/",
      "creationTimestamp": 1698064423,
      "lastUpdatedTimestamp": 1698064423
    }
  ],
  "paging": {
    "moreResults": true,
    "next": "501",
    "nextToken": "0b9972aa-fe8d-4095-82d3-2e13cf3cfd43"
  }
}

Detections

Operations

Employees

These objects represent the employees in your organization.

Operations

Findings

These objects represent the findings that have been found in your organization.

Operations

URL blocking

These objects represent the blocked URLs configured in your organization.

Operations

Stolen credential detection

Manage custom stolen credentials that you have added to your organization for monitoring and enforcement.

Operations