Reference

Planekeeper technical reference — API endpoints, API keys, rule types, parser types, cron expressions, version transforms, and IAM policies.

Technical reference for Planekeeper’s API, rule types, parsers, and configuration.

API keys

API key format, creation, permissions, and best practices for authenticating agents and external integrations.

API reference

Interactive API documentation, OpenAPI specs, and how to authenticate requests via Swagger UI.

Cron expressions

Cron expression format reference for scheduling gather and scrape jobs, with common examples and tips for choosing intervals.

IAM Policy Documents

Reference guide for IAM-style policy documents used in Planekeeper role management.

Parser types

Reference for the four parser types — YQ, JQ, Regex, and Manual — used by scrape jobs to extract or set version strings.

Rule types

Detailed reference for each rule type — days behind, majors behind, and minors behind — including threshold configuration, stable-only filtering, and calculation examples.

Settings reference

Reference for organization-level settings including default notification channels, template defaults, and task execution configuration.

Template variables

Complete reference of template variables available in notification templates, organized by event category with example snippets.

Version Transforms

Reference for version transform options that normalize version strings extracted by scrape jobs.

Pages in this section