This article explains how to install the Caldera REST API, which is included and managed through CalderaDock.
1. Install CalderaDock
Please refer to the article corresponding to your platform:
2. Install Caldera REST API
- Open CalderaDock (version 3.6 or later).
- If not previously installed, the Caldera REST API is installed automatically. The installation status is displayed on the splash screen:
Info
You only need to install and run the REST API on one station, as the services running on a fleet can be registered and requested from one API instance.
3. Update Caldera REST API
Caldera REST API can be managed directly from CalderaDock > Applications tab > Modules:
Like other Caldera products, is not automatically updated. You need to check if the application is up to date and, if not, click on the Ellipsis button ( ) to download the latest installer for your operating system.
4. Start Caldera REST API
Caldera's latest REST API runs as a standalone service (a daemon that starts automatically with the system), so it does not usually require manual intervention to start.
CalderaDock's Services (CalderaDock > Applications tab > Modules) is the suggested method for managing the Caldera REST API's status, which includes restarting it to implement changes (such as revisions to the configuration file, log level adjustments, etc.):
You might be interested in reading: