Info
The Caldera REST API is a way to interact with Caldera services by exchanging data (in JSON format) via HTTP protocol, which is common on the web. You may also want to read:
April 2025
Version 2.1.0
Warning
This version of the REST API is only compatible with CalderaRIP V18.1 or later.
Keep in mind that the REST API is exclusive to CalderaCare or GrandRIP MAX subscribers, which means that the use of any REST API service requires you to have the corresponding license.
|
New
|
Now CalderaRIP does not automatically save jobs sent via the REST API using the route POST /devices/{device}/jobs after execution. |
|
New
|
Caldera REST API is now included in the GrandRIP MAX subscription. |
Good to knowThe latest version of CalderaRIP includes fixes relevant to REST API users. For more information, see the changelog for that product. |
Documentation
|
Improved
|
Updated the Caldera REST API (OpenAPI) Definition. Learn more. |
November 2024
Version 2.0.0
Warning
This version of the REST API is only compatible with CalderaRIP V18 or later.
Keep in mind that the REST API is exclusive to CalderaCare subscribers, which means that the use of any REST API service requires you to have the corresponding license
|
New
|
macOS Sequoia (version 15) is now officially supported. |
|
New
|
Device endpoints now include printer (machine) statuses to enhance monitoring capabilities. |
|
Improved
|
This release includes improved security controls and enhanced protection of sensitive data for users of the Caldera RIP service. WarningAlong with these improvements, the Caldera RIP service port has been changed (to |
|
Improved
|
In some situations, the IDs of the REST API resources (service, device, job, etc.) may have changed over time. However, with this version of the Caldera REST API, the IDs remain stable over time. |
|
Fixed
|
With this version, the Caldera REST API keeps a fetched device cache. This means devices are still listed if the service they are coming from goes offline. |
|
Fixed
|
Fixed incorrect log directory permissions. |
|
Fixed
|
Image ID Encoding Fixes:
|
|
Fixed
|
Resolved setup problems on macOS Catalina (version 10.15) |
Routes
|
New
|
GET /devices/{device}/information (Gets information about a device) The new route is of special interest to users of workstations with CalderaRIP, as it exposes data about the loaded media, ink containers, waste ink containers, and heaters of some printers (except for HP, Canon Pro, Mutoh, and printers with a Grand license) in the REST API. An external system, such as an ERP can now query that data. |
Documentation
|
New
|
New articles available for you in HelpDesk: |
|
Improved
|
Updated the Caldera REST API (OpenAPI) Definition. Learn more. |