Backup and Restore

Backup an environment

Creates a backup of an existing Jahia Cloud environment. Commonly used to preserve the state of an environment before making significant changes.

Endpoint

POST <CLOUD_URL>/modules/cloudAction/backupEnv.do

Example

CLOUD_URL="https://jahia.cloud" # Base URL of your Jahia Cloud instance
CLOUD_ENVNAME="my-env" # Must be unique across your organization, and can only contain lowercase letters, numbers and hyphens
CLOUD_ORG="jahiacloud" # Assigned to your organization by Jahia, used to construct the shortDomain
CLOUD_SHORTDOMAIN="${CLOUD_ENVNAME}-${CLOUD_ORG}" # Short domain for the new environment

APP_ID="1e79ec38d72494da07850bea13b2856093" # The AppId corresponding to the environment you are performing an action against.

CLOUD_PAT="PRIVATE_TOKEN" # Cloud Perstonal API Token generated from the Jahia Cloud UI.

curl -i "${CLOUD_URL}/modules/cloudAction/backupEnv.do" \
  -X POST \
  -H "Authorization: APIToken ${CLOUD_PAT}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/x-www-form-urlencoded; charset=UTF-8" \
  --data-raw "orgName=${CLOUD_ORG}&envName=${CLOUD_SHORTDOMAIN}&targetAppid=${APP_ID}"

Expected result

HTTP 200 on success. The backup runs asynchronously in the background; the 200 response only confirms the backup was triggered.

{
  "jcResponse": 0
}

Restore a backup

Restores a previously created backup of an existing Jahia Cloud environment.

Endpoint

POST <CLOUD_URL>/modules/cloudAction/restoreBackup.do

Example

CLOUD_URL="https://jahia.cloud" # Base URL of your Jahia Cloud instance
CLOUD_ENVNAME="my-env" # Must be unique across your organization, and can only contain lowercase letters, numbers and hyphens
CLOUD_ORG="jahiacloud" # Assigned to your organization by Jahia, used to construct the shortDomain
CLOUD_SHORTDOMAIN="${CLOUD_ENVNAME}-${CLOUD_ORG}" # Short domain for the new environment

BACKUP_NAME="jsn-env-jahiadev" # A name for the backup, used for your reference
APP_ID="1e79ec38d72494da07850bea13b2856093" # The AppId corresponding to the environment you are performing an action against. This variable can be fetched using the getContext.do endpoint.
TIMESTAMP="2026-03-16T13%3A57%3A00" # A timestamp for the restore point
BACKUP_TYPE="manual" # The type of the backup, can be "manual" or "scheduled" depending on whether the backup was created with the backup action or by a scheduled backup plan.
CLOUD_PROVIDER="aws" # The cloud provider where the backup was created, for example "aws" or "ovh". This variable can be fetched using the getContext.do endpoint.
CLOUD_REGION="eu-west-1" # The region where the backup was created, for example "eu-west-1". This variable can be fetched using the getContext.do endpoint.
ENV_ROLE="dev" # The role of the environment, can be "dev" or "prod"

CLOUD_PAT="PRIVATE_TOKEN" # Cloud Perstonal API Token generated from the Jahia Cloud UI.

curl -i "${CLOUD_URL}/modules/cloudAction/restoreBackup.do" \
  -X POST \
  -H "Authorization: APIToken ${CLOUD_PAT}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/x-www-form-urlencoded; charset=UTF-8" \
  --data-raw "orgName=${CLOUD_ORG}&envName=${CLOUD_SHORTDOMAIN}&backupName=${BACKUP_NAME}&targetAppid=${APP_ID}&timestamp=${TIMESTAMP}&backupType=${BACKUP_TYPE}&cloudProvider=${CLOUD_PROVIDER}&region=${CLOUD_REGION}&envRole=${ENV_ROLE}"

Expected result

HTTP 200 on success.