Context Variables

Some parameters required by the actions (such as subscriptionItemId or regionId) are specific to your organization while others (such as targetAppId) are specific to an environment .

This section of the documentation provides details on how to retrieve these.

This endpoint takes two parameters:

• orgName (required): Name of your organization as assigned by Jahia (for example jahiacloud).
• envName (optional): Name of the environment to retrieve environment-specific variables for.

Note that providing an incorrect or non-existing orgName will result in a 404 response

Endpoint

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

You will receive back a JSON payload containing organization-level and environment-level context variables that can be reused in subsequent API calls.

Sample response:

{
  "subscriptions": [
    {
      "subscriptionItemId": 122,
      "name": "Free choice"
    },
    {
      "subscriptionItemId": 126,
      "bandId": 17,
      "regionId": "ovh",
      "name": "Jahia Standalone"
    },
    {
      "subscriptionItemId": 127,
      "bandId": 16,
      "regionId": "ovh",
      "name": "Jahia Cluster"
    }
  ],
  "organisationName": "jahiadevs",
  "organisationId": 94,
  "environment": {
    "envName": "jsn-env",
    "productVersion": "dx_8-2-4-0",
    "nodes": [
      {
        "nodeName": "Jahia",
        "nodeGroup": "proc",
        "nodeId": 138255
      },
      {
        "nodeName": "Jahia",
        "nodeGroup": "cp",
        "nodeId": 138231
      }
    ],
    "subscriptionItemId": 122,
    "bandId": 1,
    "regionId": "aws",
    "id": 12790,
    "targetAppid": "e79ec38d72494da07850bea13b285609",
    "shortDomain": "jsn-env-jahiadevs",
    "status": "stopped"
  },
  "environments": [
    {
      "envName": "jsn-env",
      "envId": 12790,
      "shortDomain": "jsn-env-jahiadevs"
    },
    {
      "envName": "ark-jcclonees9",
      "envId": 12835,
      "shortDomain": "ark-jcclonees9-jahiadevs"
    }
  ],
  "backups": [
    {
      "mode": "manual",
      "product": "dx",
      "envRole": "dev",
      "envName": "jahiacomjahia-jahiadevs",
      "cloudProvider": "ovh",
      "region": "gra",
      "backupName": "jahiacomjahia-jahiadevs",
      "version": "8.2.1.0",
      "backupType": "manual",
      "timestamp": "2025-10-30T13:41:00"
    },
    {
      "mode": "manual",
      "product": "dx",
      "envRole": "dev",
      "envName": "jsn-env-jahiadevs",
      "cloudProvider": "aws",
      "region": "eu-west-1",
      "backupName": "jsn-env-jahiadevs",
      "version": "8.2.4.0",
      "backupType": "manual",
      "timestamp": "2026-03-16T13:57:00"
    },
    {
      "mode": "manual",
      "product": "dx",
      "envRole": "dev",
      "envName": "ark-cmsclonees9-jahiadevs",
      "cloudProvider": "ovh",
      "region": "gra",
      "backupName": "ark-cmsclonees9-jahiadevs",
      "version": "8.2.2.1",
      "backupType": "manual",
      "timestamp": "2026-03-26T13:24:00"
    }
  ],
  "currentOrgaName": "jahiadevs",
  "organizations": ["jahiadevs", "orgA", "orgB"]
}

Response fields

• organizations: List of organizations visible to your API token. Use orgName to specify the target organization in subsequent API calls.
• subscriptions: Available subscription items for the organization. Use subscriptionItemId (and when present bandId/regionId) when creating environments.
• environment: Details of the requested environment (envName), including:
  • deployment info (productVersion, subscriptionItemId, bandId, regionId, status)
  • environment identifiers (id, targetAppid, shortDomain) necessary for modifying the environment.
  • Jahia node list (nodes[]) with each node label and nodeId
• environments: Other environments visible in the same organization (envName, envId, shortDomain). Useful to quickly retrieve valid envName values. This only contains partial values compared to the environment object.
• backups: List of available backups for the organization, including details needed for restoring a backup.