Manage Jahia Properties

Get Jahia properties

Returns the list of Jahia properties and their values for a given environment.

Endpoint

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

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

curl -i "${CLOUD_URL}/modules/cloudAction/getJahiaProperties.do" \
  -H "Authorization: APIToken ${CLOUD_PAT}" \
  -X POST \
  -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 and a payload containing the list of properties and their values. Any other status code means the retrieval failed.

{
  "result": 0,
  "object": {
    "jahia_cfg_jahiaFileUploadMaxSize": "268435456",
    "jahia_cfg_org_jahia_ehcachemanager_maxBytesLocalHeap": "500M",
    "jahia_cfg_mvnPath": "/opt/apache-maven-3.8.9/bin/mvn",
    "jahia_cfg_org_jahia_ehcachemanager_big_maxBytesLocalHeap": "500M",
    "jahia_cfg_expandImportedFilesOnDisk": "true",
    "jahia_cfg_jahia_session_cookieName": "DISTRIBUTED_JSESSIONID",
    "jahia_cfg_elasticsearch_prefix": "jsn-env-jahiadevs",
    "jahia_cfg_imageService": "ImageMagickImageService",
    "jahia_cfg_imageMagickPath": "/usr/bin",
    "jahia_cfg_jahia_jackrabbit_datastore_path": "/share/datastore"
  }
}

Set properties

The endpoint takes two values, propertiesToUpdate and propertiesToDelete, as URL-encoded JSON.

If you want to submit propertiesToUpdate such as:

{
  "jahia_cfg_operatingMode": "development",
  "jahia_cfg_mail_maxRegroupingOfPreviousException": "50"
}

Then you can encode it using the command line tool jq and urlencode as follows:

echo -n '{"jahia_cfg_operatingMode":"development","jahia_cfg_mail_maxRegroupingOfPreviousException":"50"}' | jq -sRr @uri

Endpoint

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

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

PROPERTIES_TO_UPDATE=$(echo -n '{"jahia_cfg_operatingMode":"development","jahia_cfg_mail_maxRegroupingOfPreviousException":"50"}' | jq -sRr @uri)
PROPERTIES_TO_DELETE=$(echo -n '[]' | jq -sRr @uri)

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

Expected result

HTTP 200 on success. The properties are applied immediately.

{
  "result": 0
}