Patchstack

<SYSTEM>This is the full developer documentation for Patchstack Docs</SYSTEM>

# Welcome to Patchstack Docs

> Patchstack is a powerful tool that helps to protect your WordPress applications from attacks and identify security vulnerabilities within all your WordPress plugins, themes, and core. It is powered by the WordPress ecosystem's most active community of ethical hackers. Patchstack is trusted by leading WordPress experts such as GoDaddy, Hostinger, Pagely, GridPane, Plesk, and others.

## Learn more

[Section titled “Learn more”](#learn-more)

[](/getting-started/start-using-patchstack/)

Get started: protect your site

[](/patchstack-plugin/patchstack-connector/introduction/)

Solutions for WordPress, Joomla & Drupal

[](/api-solutions/)

API solutions for custom tools

[](/faq-troubleshooting/)

Frequently asked questions

# Patchstack API solutions

Patchstack offers two different APIs for building custom tools and integrating our data to third party solutions.

## App API

[Section titled “App API”](#app-api)

Patchstack App API can be used commercially for building custom tools and integrating third party platforms with Patchstack App; Patchstack App API enables users to run all the Patchstack App account actions remotely. For example, it allows you to retrieve protection logs, generate security reports, manage site settings, add new sites, create custom rules, and much more. This API has unlimited requests and can be used by all Developer plan users for free.

[Read more here](/api-solutions/app-api/patchstack-app-api/)

## Threat Intelligence API

[Section titled “Threat Intelligence API”](#threat-intelligence-api)

Query our vulnerability database and retrieve information about all published vulnerabilities. Threat Intelligence API is available in two tiers:

### Standard tier

[Section titled “Standard tier”](#standard-tier)

Fetch the latest vulnerability information for a single version of a particular plugin, theme or WordPress core. API is limited for 5000 calls / 24 hours. Price for that API is $249 / month.

[Read more here](/api-solutions/threat-intelligence-api/standard/)

### Extended tier

[Section titled “Extended tier”](#extended-tier)

Access everything included in the Standard tier, bulk-request data for multiple plugins with one API call, and have additional endpoints with more information about vulnerabilities. Extended tier has custom pricing and is activated on request only.

[Read more here](/api-solutions/threat-intelligence-api/extended/)

# Patchstack App API

*Patchstack App API is available for the Developer and Enterprise plan users*

Patchstack App API enables users to run all the Patchstack App account actions remotely over an API. It allows you to access protection logs, generate security reports, manage site settings, add new sites, create custom rules, and much more.

### Documentation and endpoints

[Section titled “Documentation and endpoints”](#documentation-and-endpoints)

Find all the Patchstack App API endpoints with examples from the documentation here: <https://api.patchstack.com/app-api/documentation>

### Example use cases

[Section titled “Example use cases”](#example-use-cases)

Some example use cases for Patchstack App API are listed below:

* Integrate Patchstack to your email marketing software to send out monthly security reports to your customers.
* Integrate Patchstack inside your own product and let your customers enable (and control) Patchstack directly from your platform without them leaving your service.
* Pull IP addresses of attackers that try to exploit vulnerabilities into your DNS firewall to block them on the network layer.
* Integrate with Enterprise SIEM/SOC tools and pull vulnerability data and logs directly into it.
* Build any kind of automations with Zapier, IFTTT, etc.

### How to get Patchstack App API key?

[Section titled “How to get Patchstack App API key?”](#how-to-get-patchstack-app-api-key)

To get the API key, log in to your Patchstack account, go to account settings and navigate to the [**Integrations**](https://app.patchstack.com/settings/integrations) page.

![](/_astro/patchstack-integration-settings-api-key.B4jDD-yq_Z22WDNR.webp)

# API properties

*This document will provide information on the properties of the different endpoints as part of the API of the vulnerability database and will also provide an example on a potential integration to match the result set against WordPress software.*

*These examples will be shown using PHP, but can easily be implemented using any programming language. If you have any questions, feel free to send an email to <[email protected]>.*

## Data Structure