Skip to content
/
List employees

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

Detections

Operations

Employees

These objects represent the employees in your organization.

Operations

List employees

Request

Security
x-api-key
Query
chatopsEnabledboolean

Filter by whether they have ChatOps enabled

Note: this is a legacy value available for use by Push accounts that are using employee ChatOps topics. This value will be removed in a future version of the API, however, no timeline has been set. Push will provide ample notice of deprecation ahead of time, as well as a replacement option.

licensedboolean

Filter by whether they are licensed on the Push platform

groupsArray of strings

Filter by groups the employee is in.

emailstring

Filter by email address. Accepts partial email addresses for wildcard searches.

limitinteger[ 1 .. 1000 ]

Used for pagination. Number of objects to return.

Default 1000
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/employees \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

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

Unique identifier for the employee

Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"
result[].​emailstring(email)

Primary email address of the employee

Example: "john.hill@example.com"
result[].​firstNamestring

First name of the employee

Example: "John"
result[].​lastNamestring

Last name of the employee

Example: "Hill"
result[].​departmentstring

Department - as provided by connected API integrations

Example: "Security Engineering"
result[].​locationstring

Location - as provided by connected API integrations

Example: "New York"
result[].​licensedboolean

Whether the employee is licensed on the Push platform

Example: true
result[].​groupsArray of strings

Groups the employee is in

Example: ["engineering","marketing"]
result[].​creationTimestampinteger

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

Example: 1698669223
result[].​chatopsEnabledbooleanDeprecated

Whether the employee has ChatOps enabled

Deprecation notice: this value no longer does anything unless you still have access to the legacy Employee chat topics functionality on your account. It will be removed in the next API version.

Example: true
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": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
      "email": "john.hill@example.com",
      "firstName": "John",
      "lastName": "Hill",
      "department": "Security Engineering",
      "location": "New York",
      "licensed": true,
      "chatopsEnabled": true,
      "groups": [
        "engineering",
        "marketing"
      ],
      "creationTimestamp": 1698669223
    }
  ],
  "paging": {
    "moreResults": true,
    "next": "501",
    "nextToken": "0b9972aa-fe8d-4095-82d3-2e13cf3cfd43"
  }
}

Add an employee

Request

Security
x-api-key
Bodyapplication/jsonrequired

Create a new employee.

firstNamestringrequired

The first name of the employee.

Example: "John"
lastNamestringrequired

The last name of the employee.

Example: "Doe"
emailstringrequired

The email address of the employee.

Example: "john.doe@example.com"
enrolBrowserbooleanrequired

Whether the employee will be sent an email to ask them to install the Push browser extension.

Example: true
curl -i -X POST \
  https://api.pushsecurity.com/v1/employees \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "enrolBrowser": true
  }'

Responses

OK

Bodyapplication/json
idstring

Unique identifier for the employee

Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"
emailstring(email)

Primary email address of the employee

Example: "john.hill@example.com"
firstNamestring

First name of the employee

Example: "John"
lastNamestring

Last name of the employee

Example: "Hill"
departmentstring

Department - as provided by connected API integrations

Example: "Security Engineering"
locationstring

Location - as provided by connected API integrations

Example: "New York"
licensedboolean

Whether the employee is licensed on the Push platform

Example: true
creationTimestampinteger

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

Example: 1698669223
chatopsEnabledbooleanDeprecated

Whether the employee has ChatOps enabled

Deprecation notice: this value no longer does anything unless you still have access to the legacy Employee chat topics functionality on your account. It will be removed in the next API version.

Example: true
Response
application/json
{
  "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
  "email": "john.hill@example.com",
  "firstName": "John",
  "lastName": "Hill",
  "department": "Security Engineering",
  "location": "New York",
  "licensed": true,
  "chatopsEnabled": true,
  "creationTimestamp": 1698669223
}

Retrieve an employee

Request

Security
x-api-key
Path
idstringrequired

Unique identifier for the employee

curl -i -X GET \
  'https://api.pushsecurity.com/v1/employees/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring

Unique identifier for the employee

Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"
emailstring(email)

Primary email address of the employee

Example: "john.hill@example.com"
knownEmailsArray of strings

All the known email addresses of the employee

Example: ["john.hill@example.com","jhill@example.com"]
firstNamestring

First name of the employee

Example: "John"
lastNamestring

Last name of the employee

Example: "Hill"
departmentstring

Department - as provided by connected API integrations

Example: "Security Engineering"
locationstring

Location - as provided by connected API integrations

Example: "New York"
licensedboolean

Whether the employee is licensed on the Push platform

Example: true
groupsArray of strings

Groups the employee is in

Example: ["engineering","marketing"]
creationTimestampinteger

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

Example: 1698669223
chatopsEnabledbooleanDeprecated

Whether the employee has ChatOps enabled

Deprecation notice: this value no longer does anything unless you still have access to the legacy Employee chat topics functionality on your account. It will be removed in the next API version.

Example: true
Response
application/json
{
  "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
  "email": "john.hill@example.com",
  "knownEmails": [
    "john.hill@example.com",
    "jhill@example.com"
  ],
  "firstName": "John",
  "lastName": "Hill",
  "department": "Security Engineering",
  "location": "New York",
  "licensed": true,
  "chatopsEnabled": true,
  "groups": [
    "engineering",
    "marketing"
  ],
  "creationTimestamp": 1698669223
}

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