| title | Patchstack App API | ||
|---|---|---|---|
| hidden | false | ||
| createdAt | Thu May 25 2023 13:54:05 GMT+0000 (Coordinated Universal Time) | ||
| updatedAt | Wed Jan 24 2024 13:52:09 GMT+0000 (Coordinated Universal Time) | ||
| sidebar |
|
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.
:::note[What the App API does not manage] The App API manages sites and their security on your Patchstack account — provisioning, plugin connection, protection, reporting and site settings. It does not manage trials, subscriptions, plan changes or billing for your own end customers. If you are reselling Patchstack (for example through WHMCS), run trials, subscriptions and invoicing in your own billing system and use the App API purely to provision and manage the underlying sites. Your Patchstack account's own subscription is handled separately in the Patchstack app UI. :::
Find all the Patchstack App API endpoints with examples from the documentation here: https://api.patchstack.com/app-api/documentation
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.
To get the API key, log in to your Patchstack account, go to account settings and navigate to the Integrations page. On this page, you are able to generate multiple App API keys for your account with the optional ability to:
- Bind an API key to IP addresses
- Make an API key read-only
- Set an expiration
- Rotate the API key
