Welcome to Janus API Documentation
Welcome to the Janus API documentation. This site provides comprehensive guidance for integrating with and upgrading the Janus platform. You can navigate the documentation using the menu on the left.
New Integrations:
If you are integrating with Janus for the first time, begin with the Introductory Concepts page. This page introduces the core terminology and foundational concepts used throughout the documentation.
Once you are familiar with these Janus principles, refer to the Quick Start Guide, which outlines the recommended sequence of steps for completing a Janus API integration. From there, the Main Documentation provides deeper detail on specific features, workflows, and capabilities of the platform.
For a complete technical reference, the Janus Schema describes all available endpoint descriptions, request schemas, and response schemas.
Upgrades from older versions:
If you are upgrading from an earlier version of Janus, the Introductory Concepts page is still a recommended starting point, as several new concepts were introduced in the 2022-10 release.
The Upgrade Guide walks through the steps required to migrate from Janus 2020-04 to Janus 2022-10. Additional detail on new or updated functionality can be found throughout the Main Documentation
As with new integrations, the Janus Schema serves as the authoritative reference for all available endpoints, including descriptions, request schemas, and response schemas.
Documentation Changelog
August 27th, 2026
- Updated the "Measures, Change Management, and Versioning" section of the "Introductory Concepts" for consistency with the "API Versioning" page.
August 14th, 2026
- Updated "Events" page with latest webhook header info from CloudEvents 1.0 schema.
June 17th, 2026
- Updated the list of errors on "Error Lookup" page.
- Added example failure responses to the API schema.
May 14th, 2026
- Added the "Retrieve Data Gathering Results" page.
- Added "resourceSubState" to the "Get DataGathering" schema.
March 25th, 2026
- Added documentation Home page and reorganized the Table of Contents.
- Added the "Creating a Proper Janus Integration" page.
- Removed unused item encoding schema from observation set schema.