For the complete documentation index, see llms.txt. This page is also available as Markdown.

Job Examples

This section provides a library of ready-to-use JSON templates covering the most common job 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.

Job Examples

Job files are placed under Jobs/{id}.json on the agent. The examples below cover the most common trigger and scheduling patterns across all supported platforms.

Example
What It Covers

Minimal Job — Windows

The simplest valid job on Windows: interval schedule, Service task execution, and KeeperLogger output. Use this as your starting template on Windows.

Minimal Job — macOS

The same minimal job pattern adapted for macOS, including the correct binary paths and osFilter configuration.

Minimal Job — Linux

The same minimal job pattern adapted for Linux, including the correct binary paths and osFilter configuration.

A job that runs once immediately when the agent starts and then continues on a recurring interval. This is the recommended pattern for scanner-style integrations.

Job with Event Topic

A job that publishes progress updates over MQTT using a custom eventTopic. Demonstrates how to keep eventTopic and mqttTopics.allowedPublications in sync.

Before You Begin

  • Refer to the Custom Job Integration Guide 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.

Last updated