Parameters Reference
This section lists the most common parameters used across the available actions, and provides details about some of their peculiarities.
Store sensitive values (rootPassword, password, API tokens) in your CI/CD platform's secret manager rather than in plain-text scripts.
envName
The environment name you choose when creating the environment.
The maximum length for envName is 20 characters. It must be unique across your organization, and can only contain lowercase letters, numbers and hyphens.
In most follow-up actions, the envName is used as part of the shortDomain parameter instead of alone. The shortDomain is composed as <envName>-<organization>, where the organization is assigned by Jahia (for example jahiacloud).
Before proceeding, make sure to take note of what your organization is, as you will need it to construct the shortDomain for all subsequent actions.
shortDomain
The short domain is the unique identifier of your environment within Jahia Cloud. It is used in most API calls to specify the target environment, and is also part of the environment's URL.
It is composed of two parts: the envName you choose when creating the environment, and the organization assigned by Jahia. The format is <envName>-<organization> (for example my-env-jahiacloud).
productVersion
The Jahia release version to deploy (for example 8.2.3.0).
The value must be a version currently supported by Jahia Cloud. Available versions are listed in the Jahia Cloud UI when creating an environment.
Note that the version you need to provide when performing the API call, and the version you will see in getContext.do response might follow a different naming convention. For example, version 8.2.3.0 in the UI might appear as dx_8-2-3-0 in some of the API responses.
rootPassword
Chosen by you. This will become the root user password on the new environment. Store this value securely.
subscriptionItemId
A numeric ID referring to your subscription.
Contact Jahia Support team for obtaining your ID.
regionId
Identifies the cloud region where the environment will be deployed (for example ovh-fr-1).
Regions availability depends on your subscription.
bandId
A numeric ID that identifies the sizing tier for the environment.
targetAppid
Various operations require a targetAppid parameter that identifies the target application. Refer to the Context Variables page in the documentation for instructions on how to retrieve this value.
certificateId
The ID of the SSL certificate to attach. Found in the Jahia Cloud UI under your organization's SSL certificates.