> For the complete documentation index, see [llms.txt](https://docs.keeper.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/custom-plugin-guide/plugin-examples.md). # Plugin Examples

This section provides a library of ready-to-use JSON templates covering the most common plugin integration scenarios for Keeper Endpoint Privilege Manager. Each sub-page focuses on a single scenario, includes a complete, deployable JSON file, and explains what the example demonstrates and when to use it. All examples are self-describing — each file's `description` field begins with `SCENARIO:` so you can identify the purpose of the template at a glance without reading the entire file. Replace placeholder paths, IDs, and topic names before deploying to your environment. ## Plugin Examples Plugin files are placed under `Plugins/{id}.json` on the agent. The examples below cover the most common plugin registration and communication patterns.

Example	What It Covers
Minimal Plugin — Windows	The simplest valid managed plugin on Windows: `autoStart`, a primary MQTT `Subscription`, and KeeperLogger output. Use this as your starting template on Windows.
Minimal Plugin — macOS	The same minimal plugin pattern adapted for macOS, including the correct binary path and platform configuration.
Minimal Plugin — Linux	The same minimal plugin pattern adapted for Linux, including the correct binary path and platform configuration.
Plugin with Command/Response over MQTT	A plugin using a command/response topic pattern (`Commands/+`, `Responses/+`, `Status`). Use this when your plugin needs to receive instructions and reply over MQTT.
Plugin with Manual Start	A plugin registered with `autoStart: false`, meaning it is not launched automatically when the agent starts. Use this for on-demand or conditionally launched plugins.

## Before You Begin * Refer to the [Custom Plugin Integration Guide](/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/custom-plugin-guide.md) before deploying any example to ensure you understand the binary layout, signing requirements, and MQTT topic permission model. * For a richer Windows job sample with more fields filled in, see the `secrets-scanner-sample-job.json` reference in the parent integration bundle. * Use `POST /api/Jobs/validate` to validate your job JSON before deploying it to an endpoint. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/custom-plugin-guide/plugin-examples.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.