Skip to content
Stolen credential detecti...

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

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

Add new stolen credentials

Request

Add stolen credentials sourced from other threat intelligence feeds within your organization.

Security
x-api-key
Bodyapplication/jsonrequired

A list of stolen credentials

Array [
emailstring

Email address of employee.

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

Plain text password. Note that uploading hashes will never match and only plain text passwords can be used.

Example: "myAm@z!ngP4$$w0rdTh4tUcantGu3$$"
metadataobject or null(Metadata)

Metadata provided from the TI provider about where these credentials were found. This will be attached to any Stolen Credentials finding that matched with these credentials

]
curl -i -X POST \
https://api.pushsecurity.com/v1/controls/stolenCredentials \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '[{
  "email": "john.hill@example.com",
  "password": "myAm@z!ngP4$$w0rdTh4tUcantGu3$$",
  "metadata": {
    "key": "value"
  }
}]'

Responses

OK

Bodyapplication/json
resultArray of objects(Stolen Credential)[ 1 .. 500 ] items
result[].​emailstring

Email address of employee.

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

Plain text password. Note that uploading hashes will never match and only plain text passwords can be used.

Example: "myAm@z!ngP4$$w0rdTh4tUcantGu3$$"
result[].​metadataobject or null(Metadata)

Metadata provided from the TI provider about where these credentials were found. This will be attached to any Stolen Credentials finding that matched with these credentials

Response
application/json
{
  "result": [
    {
      "email": "john.hill@example.com",
      "password": "myAm@z!ngP4$$w0rdTh4tUcantGu3$$",
      "metadata": {}
    }
  ]
}

Delete all stolen credentials

Request

Delete all the custom stolen credentials that you have added to your organization.

Security
x-api-key
curl -i -X DELETE \
  https://api.pushsecurity.com/v1/controls/stolenCredentials \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK