Start or Stop an Environment

July 2, 2026

Start an environment

This commands starts an environment that was previously stopped

Endpoint

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

Example

CLOUD_URL="https://jahia.cloud" # Base URL of your Jahia Cloud instance
CLOUD_ENVNAME="my-env" # Must be unique across your organization, must be LOWERCASE 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

# Note that there is no typo in this script, the envName parameter in the CURL request does take the short domain as input.

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

curl -i "${CLOUD_URL}/modules/cloudAction/startEnv.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}"

Expected result

HTTP 200 on success.

Environment creation is asynchronous. After receiving a 200, poll the Jahia healthcheck endpoint until the environment reports a GREEN status before proceeding with other operations.

You can find more details about how to wait for Jahia by reviewing the documentation in the Create or Delete an environment page .

Stop an environment

Stops an existing Jahia Cloud environment.

Endpoint

POST <CLOUD_URL>/modules/cloudAction/stopEnv.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

# Note that there is no typo in this script, the envName parameter in the CURL request does take the short domain as input.

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

curl -i "${CLOUD_URL}/modules/cloudAction/stopEnv.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}"

Expected result

HTTP 200 on success. The environment shutdown is triggered immediately.