Source: https://docs.planekeeper.com/reference/
Title: Reference
Description: Planekeeper technical reference — API endpoints, API keys, rule types, parser types, cron expressions, version transforms, and IAM policies.
Kind: section

***

# Reference

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


## Pages in this section

- [API keys](https://docs.planekeeper.com/reference/api-keys/index.md) — API key format, creation, permissions, and best practices for authenticating agents and external integrations.
- [API reference](https://docs.planekeeper.com/reference/api/index.md) — Interactive API documentation, OpenAPI specs, and how to authenticate requests via Swagger UI.
- [Cron expressions](https://docs.planekeeper.com/reference/cron-expressions/index.md) — Cron expression format reference for scheduling gather and scrape jobs, with common examples and tips for choosing intervals.
- [IAM Policy Documents](https://docs.planekeeper.com/reference/iam-policies/index.md) — Reference guide for IAM-style policy documents used in Planekeeper role management.
- [Parser types](https://docs.planekeeper.com/reference/parser-types/index.md) — Reference for the four parser types — YQ, JQ, Regex, and Manual — used by scrape jobs to extract or set version strings.
- [Rule types](https://docs.planekeeper.com/reference/rule-types/index.md) — Detailed reference for each rule type — days behind, majors behind, and minors behind — including threshold configuration, stable-only filtering, and calculation examples.
- [Settings reference](https://docs.planekeeper.com/reference/settings-reference/index.md) — Reference for organization-level settings including default notification channels, template defaults, and task execution configuration.
- [Template variables](https://docs.planekeeper.com/reference/template-variables/index.md) — Complete reference of template variables available in notification templates, organized by event category with example snippets.
- [Version Transforms](https://docs.planekeeper.com/reference/version-transforms/index.md) — Reference for version transform options that normalize version strings extracted by scrape jobs.