Overview
This document describes the HTTP actions available to automate Jahia Cloud operations from your CI/CD pipelines. Each action is a standard HTTP endpoint that can be called with any tool (such as curl) capable of making HTTP requests with customizable payloads, and returns standard HTTP status codes.
These API calls bypass the confirmation prompts present in the Jahia Cloud UI. Use extra care when targeting production environments — destructive operations such as deleteEnv.do are executed immediately and cannot be undone.
Before you begin
Base URL
Throughout this document, <CLOUD_URL> refers to https://jahia.cloud.
All endpoints, with the exception of token generation and deletion, follow the pattern <CLOUD_URL>/modules/cloudAction/<ACTION_NAME>.do, where <ACTION_NAME> is the action to perform (for example createJahiaEnv for environment creation).
Case-sensitivy and accuracy
Limited back-end validations is performed on the parameters you will be sending, make sure to review carefully the instructions for each action and provide accurate values (in particular in regards to case sensitivity), this is especially important for parameters such as envName and shortDomain that are used to identify the target environment for the action.
Collect context data
Some parameters required by the actions (such as subscriptionItemId or regionId) are specific to your organization while others are specific to an environment.
A dedicated getContext endpoint is available for providing these variables, please refer to the Context Variables page of the documentation.
Specify your organization
Your account can potentially give you access to multiple organizations, and you need to specify which one you want to target when performing the API calls.
This is done by including an orgName parameter in the request body of your API calls, with the value being the name of your organization as assigned by Jahia (for example jahiacloud).
REST API
A REST API is planned for an upcoming major version of Jahia Cloud.
In the meantime, the actions described on the Academy cover the most common operations available from the Jahia Cloud UI. Although we aim at limiting breaking changes, we reserve the right to modify the endpoints and parameters of these actions in upcoming releases. If you rely on these actions for your CI/CD pipelines, please make sure to review Jahia Cloud release notes regularly.
If an operation you need is missing, contact our support team.
TL;DR
If you're eager to get started, simply:
- Step 1: Generate a Token
- Step 2: Identify your
subscriptionItemId,regionId,bandIdin Context Variables - Step 3: Create an environment programmatically
Be mindful about changes
The API calls documented in this section can perform destructive operations on your environment.
There will be NO validation on the requested operation. If you perform an operation requesting your production environment to be deleted, IT WILL BE DELETED.
Available operations
This list is expected to evolve over time. If you need an operation not yet documented here, contact Jahia Support.
For the time being, these operations are limited to Jahia, and do not support jCustomer and Augmented Search.
The following operations are currently available:
- Create an environment
- Delete an environment
- Start an environment
- Stop an environment
- Get Jahia properties
- Set Jahia properties
- Perform a rolling restart of a cluster
- Restart a single Jahia node
- Backup an environment
- Restore a backup
- Bind a custom domain
- Swap domains between environments
- Install an SSL certificate
- Update an SSL certificate
- Bind an SSL certificate
- Delete an SSL certificate
- Add Basic Authentication