API error messages
Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Environment

9 minute readReference

createEnvironment

Creates a new environment.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

environmentName

String

(Required) The name of the environment.

applicationName

String

Create environment from the specified application.

applicationProjectName

String

The application’s project name.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

environmentEnabled

Boolean

True to enable the environment.

reservationRequired

Boolean

True to allow run using reservation only.

rollingDeployEnabled

Boolean

True to enable support for rolling deploy on this environment.

rollingDeployType

RollingDeployType

The type of rolling deploy type supported by the environment.

Positional arguments

projectName, environmentName

Usage

ec-perl

$cmdr->createEnvironment(<projectName>, <environmentName>, {<optionals>});
▼

ectool

ectool createEnvironment projectName environmentName [optionals]
▼

createEnvironmentInventoryItem

Creates a new environment inventory item.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

environmentName

String

(Required) The name of the environment.

applicationName

String

(Required) Application that owns the inventory item.

componentName

String

(Required) Component that owns the inventory item.

resourceName

String

(Required) Resource where the item is installed.

applicationTierName

String

Name of the application tier.

artifactName

String

Artifact name for the inventory item.

artifactSource

String

Source of the artifact.

artifactUrl

String

Url of the artifact.

artifactVersion

String

Artifact version for the inventory item.

clusterName

String

Cluster where the item is installed.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

environmentProjectName

String

Name for the project to which the environment or environment template belongs to.

microserviceName

String

Service that owns the inventory item.

status

JobOutcome

Inventory deployment status.

Positional arguments

projectName, environmentName, applicationName, componentName, resourceName

Usage

ec-perl

$cmdr->createEnvironmentInventoryItem(<projectName>, <environmentName>, <applicationName>, <componentName>, <resourceName>, {<optionals>});
▼

ectool

ectool createEnvironmentInventoryItem projectName environmentName applicationName componentName resourceName [optionals]
▼

createReservation

Creates a new reservation.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

reservationName

String

(Required) The name of the environment reservation.

applicationName

String

The name of the application.

beginDate

String

Date of beginning reservation.

blackout

Boolean

Do not allow executions against an environment at specified period.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

endDate

String

The date when reservation event ends.

environmentName

String

The name of the environment.

environmentProjectName

String

The name of the environment project name.

environmentTierName

String

The name of the environment tier.

monthDays

String

A list of numbers from 1-31 separated by spaces, indicating zero or more days of the month.

overlap

Boolean

Allow to overlap the reservation.

pipelineName

String

The name of the pipeline.

recurrence

Boolean

Recurrence reservation.

recurrenceEndDate

String

Date of beginning reservation.

releaseName

String

The name of the release.

timeZone

String

The time zone to use when interpreting times.

weekDays

String

Days of the week: any number of names such as Monday or Tuesday, separated by spaces.

Positional arguments

projectName, reservationName

Usage

ec-perl

$cmdr->createReservation(<projectName>, <reservationName>, {<optionals>});
▼

ectool

ectool createReservation projectName reservationName [optionals]
▼

deleteEnvironment

Deletes an environment.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

environmentName

String

(Required) The name of the environment.

Positional arguments

projectName, environmentName

Usage

ec-perl

$cmdr->deleteEnvironment(<projectName>, <environmentName>);
▼

ectool

ectool deleteEnvironment projectName environmentName
▼

deleteEnvironmentInventoryItem

Deletes an inventory item.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

environmentName

String

(Required) The name of the environment.

applicationName

String

(Required) Application that owns the inventory item.

componentName

String

(Required) Component that owns the inventory item.

resourceName

String

(Required) Resource where the item is installed.

artifactName

String

Artifact name for the inventory item.

artifactVersion

String

Artifact version for the inventory item.

clusterName

String

Cluster where the item is installed.

deploymentStrategyLabel

String

Label used by microservice plugins EC-Helm and EC-Kubectl to identify deployments depending on the deployment strategy in progress. For example, canary and stable will be used with canary strategy-based deployments while preview and active will be used with bluegreen strategy-based deployments. (Used exclusively in the context of an advanced deployment strategy for a microservice application).

environmentProjectName

String

Name for the project to which the environment or environment template belongs to.

microserviceName

String

Service that owns the inventory item.

Positional arguments

projectName, environmentName, applicationName, componentName, resourceName

Usage

ec-perl

$cmdr->deleteEnvironmentInventoryItem(<projectName>, <environmentName>, <applicationName>, <componentName>, <resourceName>, {<optionals>});
▼

ectool

ectool deleteEnvironmentInventoryItem projectName environmentName applicationName componentName resourceName [optionals]
▼

deleteReservation

Deletes the specified reservation.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

reservationName

String

(Required) The name of the environment reservation.

Positional arguments

projectName, reservationName

Usage

ec-perl

$cmdr->deleteReservation(<projectName>, <reservationName>);
▼

ectool

ectool deleteReservation projectName reservationName
▼

getEnvironment

Retrieves an environment by name.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

environmentName

String

(Required) The name of the environment.

Positional arguments

projectName, environmentName

Usage

ec-perl

$cmdr->getEnvironment(<projectName>, <environmentName>);
▼

ectool

ectool getEnvironment projectName environmentName
▼

getEnvironmentApplications

Retrieves a list of applications installed on the given environment.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

environmentName

String

(Required) The name of the environment.

Positional arguments

projectName, environmentName

Usage

ec-perl

$cmdr->getEnvironmentApplications(<projectName>, <environmentName>);
▼

ectool

ectool getEnvironmentApplications projectName environmentName
▼

getEnvironmentDeployments

Retrieves environment deployments for the specified environment.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

environmentName

String

(Required) The name of the environment.

Positional arguments

projectName, environmentName

Usage

ec-perl

$cmdr->getEnvironmentDeployments(<projectName>, <environmentName>);
▼

ectool

ectool getEnvironmentDeployments projectName environmentName
▼

getEnvironmentInventory

Retrieves a per-component grouped list of inventory items.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

environmentName

String

(Required) The name of the environment.

applicationName

String

(Required) The name of the application.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

environmentProjectName

String

Name for the project to which the environment or environment template belongs to.

Positional arguments

projectName, environmentName, applicationName

Usage

ec-perl

$cmdr->getEnvironmentInventory(<projectName>, <environmentName>, <applicationName>, {<optionals>});
▼

ectool

ectool getEnvironmentInventory projectName environmentName applicationName [optionals]
▼

getEnvironmentInventoryItem

Retrieves an inventory item.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

environmentName

String

(Required) The name of the environment.

applicationName

String

(Required) Application that owns the inventory item.

componentName

String

(Required) Component that owns the inventory item.

resourceName

String

(Required) Resource where the item is installed.

artifactName

String

Artifact name for the inventory item.

clusterName

String

Cluster where the item is installed.

environmentProjectName

String

Name for the project to which the environment or environment template belongs to.

includeResourceDetails

Boolean

True to include resource details (default is false).

microserviceName

String

Service that owns the inventory item.

Positional arguments

projectName, environmentName, applicationName, componentName, resourceName

Usage

ec-perl

$cmdr->getEnvironmentInventoryItem(<projectName>, <environmentName>, <applicationName>, <componentName>, <resourceName>, {<optionals>});
▼

ectool

ectool getEnvironmentInventoryItem projectName environmentName applicationName componentName resourceName [optionals]
▼

getEnvironmentInventoryItems

Retrieves all inventory items for a given environment.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

environmentName

String

(Required) The name of the environment.

includeResourceDetails

Boolean

True to include resource details (default is false).

Positional arguments

projectName, environmentName

Usage

ec-perl

$cmdr->getEnvironmentInventoryItems(<projectName>, <environmentName>, {<optionals>});
▼

ectool

ectool getEnvironmentInventoryItems projectName environmentName [optionals]
▼

getEnvironments

Retrieves all environments in a project.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

Positional arguments

projectName

Usage

ec-perl

$cmdr->getEnvironments(<projectName>);
▼

ectool

ectool getEnvironments projectName
▼

getReservation

Retrieves an environment reservation by its name.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

reservationName

String

(Required) The name of the environment reservation.

beginDate

String

Date of beginning reservation.

endDate

String

The date when reservation event ends.

includeTimeslots

Boolean

Include timeslots in reservation response.

timeZone

String

The time zone to use when interpreting times.

Positional arguments

projectName, reservationName

Usage

ec-perl

$cmdr->getReservation(<projectName>, <reservationName>, {<optionals>});
▼

ectool

ectool getReservation projectName reservationName [optionals]
▼

getReservations

Retrieves all environment reservations.

Arguments

Argument Name Type Description

applicationName

String

The name of the application.

beginDate

String

Date of beginning reservation.

blackout

Boolean

Blackout reservations.

endDate

String

The date when reservation event ends.

environmentName

String

The name of the environment.

environmentProjectName

String

The name of the environment project name.

environmentTierName

String

The name of the environment tier.

includeTimeslots

Boolean

Include timeslots in reservation response.

pipelineName

String

The name of the pipeline.

projectName

String

Name for the project; must be unique among all projects.

releaseName

String

The name of the release.

reserverTypes

Collection

Reserver types.

timeZone

String

The time zone to use when interpreting times.

Positional arguments

None.

Usage

ec-perl

$cmdr->getReservations({<optionals>});
▼

ectool

ectool getReservations [optionals]
▼

getRunSchedules

Retrieves the run schedules with environment reservations.

Arguments

Argument Name Type Description

beginDate

String

Date of beginning reservation.

endDate

String

The date when reservation event ends.

filters

Collection

A list of zero or more filter criteria definitions used to define objects to find.

includeTimeslots

Boolean

Include timeslots in reservation response.

timeZone

String

The time zone to use when interpreting times.

Positional arguments

None.

Usage

ec-perl

$cmdr->getRunSchedules({<optionals>});
▼

ectool

ectool getRunSchedules [optionals]
▼

modifyEnvironment

Modifies an environment.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

environmentName

String

(Required) The name of the environment.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

environmentEnabled

Boolean

True to enable the environment.

newName

String

The new name for an existing object that is being renamed.

reservationRequired

Boolean

True to allow run using reservation only.

rollingDeployEnabled

Boolean

True to enable support for rolling deploy on this environment.

rollingDeployType

RollingDeployType

The type of rolling deploy type supported by the environment.

Positional arguments

projectName, environmentName

Usage

ec-perl

$cmdr->modifyEnvironment(<projectName>, <environmentName>, {<optionals>});
▼

ectool

ectool modifyEnvironment projectName environmentName [optionals]
▼

modifyEnvironmentInventoryItem

Modifies an existing environment inventory item.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

environmentName

String

(Required) The name of the environment.

applicationName

String

(Required) Application that owns the inventory item.

componentName

String

(Required) Component that owns the inventory item.

resourceName

String

(Required) Resource where the item is installed.

applicationTierName

String

Name of the application tier.

artifactName

String

Artifact name for the inventory item.

artifactSource

String

Source of the artifact.

artifactUrl

String

Url of the artifact.

artifactVersion

String

Artifact version for the inventory item.

clusterName

String

Cluster where the item is installed.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

environmentProjectName

String

Name for the project to which the environment or environment template belongs to.

microserviceName

String

Service that owns the inventory item.

status

JobOutcome

Inventory deployment status.

Positional arguments

projectName, environmentName, applicationName, componentName, resourceName

Usage

ec-perl

$cmdr->modifyEnvironmentInventoryItem(<projectName>, <environmentName>, <applicationName>, <componentName>, <resourceName>, {<optionals>});
▼

ectool

ectool modifyEnvironmentInventoryItem projectName environmentName applicationName componentName resourceName [optionals]
▼

modifyReservation

Modifies an environment reservation.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

reservationName

String

(Required) The name of the environment reservation.

applicationName

String

The name of the application.

beginDate

String

Date of beginning reservation.

blackout

Boolean

Do not allow executions against an environment at specified period.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

endDate

String

The date when reservation event ends.

environmentName

String

The name of the environment.

environmentProjectName

String

The name of the environment project name.

environmentTierName

String

The name of the environment tier.

monthDays

String

A list of numbers from 1-31 separated by spaces, indicating zero or more days of the month.

newName

String

The new name for an existing object that is being renamed.

overlap

Boolean

Allow to overlap the reservation.

pipelineName

String

The name of the pipeline.

recurrence

Boolean

Recurrence reservation.

recurrenceEndDate

String

Date of beginning reservation.

releaseName

String

The name of the release.

timeZone

String

The time zone to use when interpreting times.

weekDays

String

Days of the week: any number of names such as Monday or Tuesday, separated by spaces.

Positional arguments

projectName, reservationName

Usage

ec-perl

$cmdr->modifyReservation(<projectName>, <reservationName>, {<optionals>});
▼

ectool

ectool modifyReservation projectName reservationName [optionals]
▼

seedEnvironmentInventory

Seeds the environment with a new inventory to mimic an actual application or release-scoped deployment.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

environmentName

String

(Required) The name of the environment.

applicationName

String

(Required) Applications that owns the inventory item.

applicationProcessName

String

(Required) Application process used to deploy to the environment.

status

JobOutcome

(Required) Inventory deployment status.

applicationTierName

String

The name of the application tier.

applicationVersion

String

Application version for the application that was deployed.

artifactName

String

Artifact name for the inventory item.

artifactProviderSource

String

Source of the provider that indirectly owns this artifact.

artifactSource

String

Source of the artifact.

artifactUrl

String

Url of the artifact.

artifactVersion

String

Artifact version for the inventory item.

clusterName

String

Cluster where the item is installed.

clusterNamespace

String

Cluster namespace where the item is installed.

componentName

String

Component that owns the inventory item.

deploymentDetails

String

Additional information about the deployment in JSON format.

deploymentStrategy

DeploymentStrategy

Deployment strategy used for the deployment of the microservice artifact being added to the environment inventory. (Used exclusively in the context of an advanced deployment strategy for a microservice application).

deploymentStrategyInProgress

Boolean

Whether deployment strategy is in progress. (Used exclusively in the context of an advanced deployment strategy for a microservice application).

deploymentStrategyLabel

String

Label used by microservice plugins EC-Helm and EC-Kubectl to identify deployments depending on the deployment strategy in progress. For example, canary and stable will be used with canary strategy-based deployments while preview and active will be used with bluegreen strategy-based deployments. (Used exclusively in the context of an advanced deployment strategy for a microservice application).

environmentProjectName

String

Name for the project to which the environment or environment template belongs to.

jobId

UUID

The ID of the job.

microserviceDeploymentData

String

The deployment details related to a microservice deployment.

microserviceDeploymentSummary

String

The summary of microservice deployment.

microserviceName

String

Microservice that owns the inventory item.

releaseName

String

Name of the release.

releaseProjectName

String

Name of the release project.

resourceNames

Collection

An array of resource names

seeded

Boolean

Seeded status.

snapshotName

String

Name of a snapshot.

stageName

String

Name of the stage.

Positional arguments

projectName, environmentName, applicationName, applicationProcessName, status

Usage

ec-perl

$cmdr->seedEnvironmentInventory(<projectName>, <environmentName>, <applicationName>, <applicationProcessName>, <status>, {<optionals>});
▼

ectool

ectool seedEnvironmentInventory projectName environmentName applicationName applicationProcessName status [optionals]
▼

tearDownEnvironment

Used to get rid of an environment that is no longer needed, and tear down associated dynamic resources.

Arguments

Argument Name Type Description

environmentName

String

(Required) The name of the environment.

projectName

String

(Required) Name for the project containing the environment.

Positional arguments

environmentName, projectName

Usage

ec-perl

$cmdr->tearDownEnvironment(<environmentName>, <projectName>);
▼

ectool

ectool tearDownEnvironment environmentName projectName
▼
Email notifier
Environment tier