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
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercompliancecomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Deployer application

8 minute readReference

createDeployerApplication

Adds a deployer application to a release.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

afterLastRetry

AfterLastRetryErrorHandling

Specify continue or stop pipeline execution after last unsuccessful retry or a task.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

enforceDependencies

Boolean

Enforce dependencies flag to be used during runProcess for the application.

errorHandling

FlowStateErrorHandling

Specifies error handling for the deployer application.

orderIndex

Integer

Specifies the application deployment order (starts from 1).

processName

String

The name of the application process.

releaseName

String

The name of the release.

retryApprovers

Collection

A list of retry approvers who receive the notification.

retryCount

String

If the retry is auto, specify the maximum number of times retry should occur.

retryInterval

String

If the retry is auto, specify the number of seconds to wait until the next retry should occur.

retryNotificationTemplate

String

Email retry notification template for application.

retryType

RetryType

Type of retry when process step or task fails. Is one of auto or manual.

smartDeploy

Boolean

Smart deploy flag to be used during runProcess for the application.

snapshotName

String

The name of the snapshot.

stageArtifacts

Boolean

Stage artifacts for the application process.

Positional arguments

projectName, applicationName

Usage

ec-perl

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

ectool

ectool createDeployerApplication projectName applicationName [optionals]
▼

createDeployerConfiguration

Adds the deployer configuration to the deployer application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

stageName

String

(Required) The name of the stage of a pipeline attached to a release if specified.

actualParameters

Map

Actual parameters.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

deployerConfigurationName

String

The name of deployer configuration. If not specified, a system generated GUID is used.

deployerTaskName

String

The name of the deployer task defined in the provided stage.

environmentName

String

The name of the environment.

environmentProjectName

String

The name of the project containing specified environment or environment template. If not specified, it is defaulted to the release project name.

environmentTemplateName

String

The name of the environment template.

environmentTemplateProjectName

String

The name of the project containing specified environment template. If not specified, it is defaulted to the environment project name.

insertRollingDeployManualStep

Boolean

True to indicate a manual step needs to be injected after each phase or batch.

processName

String

The name of the application process.

releaseName

String

The name of the release.

rollingDeployEnabled

Boolean

Perform rolling deployment.

rollingDeployManualStepAssignees

Collection

A list of assignees who receive the notification when rolling deploy iteration completes.

rollingDeployManualStepCondition

NotificationType

Defines run condition on manual step created during rolling deployment.

rollingDeployPhases

Collection

One or more rolling deploy phases to be used for deployment.

rolloutApprovers

Collection

A list of rollout approvers.

rolloutNotificationEnabled

Boolean

Rollout notification enabled (default is false).

skipDeploy

Boolean

True to skip deployment to an environment.

snapshotName

String

The name of the snapshot.

Positional arguments

projectName, applicationName, stageName

Usage

ec-perl

$cmdr->createDeployerConfiguration(<projectName>, <applicationName>, <stageName>, {<optionals>});
▼

ectool

ectool createDeployerConfiguration projectName applicationName stageName [optionals]
▼

getDeployerApplication

Retrieves the application used in the release by name.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

releaseName

String

The name of the release.

Positional arguments

projectName, applicationName

Usage

ec-perl

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

ectool

ectool getDeployerApplication projectName applicationName [optionals]
▼

getDeployerApplications

Retrieves all the applications in a release.

Arguments

Argument Name Type Description

projectName

String

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

releaseName

String

The name of the release.

Positional arguments

projectName

Usage

ec-perl

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

ectool

ectool getDeployerApplications projectName [optionals]
▼

getDeployerConfiguration

Retrieves a deployer configuration.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

stageName

String

(Required) The name of the stage of a pipeline attached to a release if specified.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

deployerConfigurationName

String

The name of deployer configuration. If not specified, a system generated GUID is used.

deployerTaskName

String

The name of the deployer task defined in the provided stage.

releaseName

String

The name of the release.

Positional arguments

projectName, applicationName, stageName

Usage

ec-perl

$cmdr->getDeployerConfiguration(<projectName>, <applicationName>, <stageName>, {<optionals>});
▼

ectool

ectool getDeployerConfiguration projectName applicationName stageName [optionals]
▼

getDeployerConfigurations

Retrieves all configurations in the deployer.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

releaseName

String

The name of the release.

stageName

String

The name of the stage of a pipeline attached to a release if specified.

Positional arguments

projectName

Usage

ec-perl

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

ectool

ectool getDeployerConfigurations projectName [optionals]
▼

getPipelineStageRuntimeDeployerTasks

Retrieves the list of deployer tasks and their details to be displayed in CloudBees CD/RO Pipeline Run Details page.

Arguments

Argument Name Type Description

flowRuntimeId

UUID

(Required) The ID of the flow runtime.

stageName

String

(Required) The name of the stage.

taskName

String

(Required) The name of the deployer task.

firstResult

Integer

Result pagination: the first row to return.

groupRunNumber

Integer

The group run number.

maxResults

Integer

Result pagination: the number of rows to return.

sortKey

String

How to sort the results.

sortOrder

SortOrder

Specifies the order to sort the results.

stageRunNumber

Integer

The stage run number.

taskRunNumber

Integer

The task run number.

Positional arguments

flowRuntimeId, stageName, taskName

Usage

ec-perl

$cmdr->getPipelineStageRuntimeDeployerTasks(<flowRuntimeId>, <stageName>, <taskName>, {<optionals>});
▼

ectool

ectool getPipelineStageRuntimeDeployerTasks flowRuntimeId stageName taskName [optionals]
▼

modifyDeployerApplication

Modifies the deployer application associated with a release.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

afterLastRetry

AfterLastRetryErrorHandling

Specify continue or stop pipeline execution after last unsuccessful retry or a task.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

enforceDependencies

Boolean

Enforce dependencies flag to be used during runProcess for the application.

errorHandling

FlowStateErrorHandling

Specifies error handling for the deployer application.

orderIndex

Integer

Specifies the application deployment order (starts from 1).

processName

String

The name of the application process.

releaseName

String

The name of the release.

retryApprovers

Collection

A list of retry approvers who receive the notification.

retryCount

String

If the retry is auto, specify the maximum number of times retry should occur.

retryInterval

String

If the retry is auto, specify the number of seconds to wait until the next retry should occur.

retryNotificationTemplate

String

Email retry notification template for application.

retryType

RetryType

Type of retry when process step or task fails. Is one of auto or manual.

smartDeploy

Boolean

Smart deploy flag to be used during runProcess for the application.

snapshotName

String

The name of the snapshot.

stageArtifacts

Boolean

Stage artifacts for the application process.

Positional arguments

projectName, applicationName

Usage

ec-perl

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

ectool

ectool modifyDeployerApplication projectName applicationName [optionals]
▼

modifyDeployerConfiguration

Modifies a deployer configuration associated with a deployer application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

stageName

String

(Required) The name of the stage of a pipeline attached to a release if specified.

actualParameters

Map

Actual parameters.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

clearActualParameters

Boolean

True if the task should remove all actual parameters.

deployerConfigurationName

String

The name of deployer configuration. If not specified, a system generated GUID is used.

deployerTaskName

String

The name of the deployer task defined in the provided stage.

environmentName

String

The name of the environment.

environmentProjectName

String

The name of the project containing specified environment or environment template. If not specified, it is defaulted to the release project name.

environmentTemplateName

String

The name of the environment template.

environmentTemplateProjectName

String

The name of the project containing specified environment template. If not specified, it is defaulted to the environment project name.

insertRollingDeployManualStep

Boolean

True to indicate a manual step needs to be injected after each phase or batch.

newName

String

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

processName

String

The name of the application process.

releaseName

String

The name of the release.

rollingDeployEnabled

Boolean

Perform rolling deployment.

rollingDeployManualStepAssignees

Collection

A list of assignees who receive the notification when rolling deploy iteration completes.

rollingDeployManualStepCondition

NotificationType

Defines run condition on manual step created during rolling deployment.

rollingDeployPhases

Collection

One or more rolling deploy phases to be used for deployment.

rolloutApprovers

Collection

A list of rollout approvers.

rolloutNotificationEnabled

Boolean

Rollout notification enabled (default is false).

skipDeploy

Boolean

True to skip deployment to an environment.

snapshotName

String

The name of the snapshot.

Positional arguments

projectName, applicationName, stageName

Usage

ec-perl

$cmdr->modifyDeployerConfiguration(<projectName>, <applicationName>, <stageName>, {<optionals>});
▼

ectool

ectool modifyDeployerConfiguration projectName applicationName stageName [optionals]
▼

removeDeployerApplication

Removes a deployer application for a release.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

releaseName

String

The name of the release.

Positional arguments

projectName, applicationName

Usage

ec-perl

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

ectool

ectool removeDeployerApplication projectName applicationName [optionals]
▼

removeDeployerConfiguration

Removes a deployer configuration associated with a deployer application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

stageName

String

(Required) The name of the stage of a pipeline attached to a release if specified.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

deployerConfigurationName

String

The name of deployer configuration. If not specified, a system generated GUID is used.

deployerTaskName

String

The name of the deployer task defined in the provided stage.

releaseName

String

The name of the release.

Positional arguments

projectName, applicationName, stageName

Usage

ec-perl

$cmdr->removeDeployerConfiguration(<projectName>, <applicationName>, <stageName>, {<optionals>});
▼

ectool

ectool removeDeployerConfiguration projectName applicationName stageName [optionals]
▼

validateDeployer

Validates the deployer configuration.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

stageName

String

(Required) The name of the stage of a pipeline attached to a release if specified.

actualParameters

Map

Actual parameters.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

deployerConfigurationName

String

The name of deployer configuration. If not specified, a system generated GUID is used.

deployerTaskName

String

The name of the deployer task defined in the provided stage.

environmentName

String

The name of the environment.

environmentProjectName

String

The name of the project containing specified environment or environment template. If not specified, it is defaulted to the release project name.

environmentTemplateName

String

The name of the environment template.

environmentTemplateProjectName

String

The name of the project containing specified environment template. If not specified, it is defaulted to the environment project name.

insertRollingDeployManualStep

Boolean

True to indicate a manual step needs to be injected after each phase or batch.

processName

String

The name of the application process.

releaseName

String

The name of the release.

rollingDeployEnabled

Boolean

Perform rolling deployment.

rollingDeployManualStepAssignees

Collection

A list of assignees who receive the notification when rolling deploy iteration completes.

rollingDeployManualStepCondition

NotificationType

Defines run condition on manual step created during rolling deployment.

rollingDeployPhases

Collection

One or more rolling deploy phases to be used for deployment.

rolloutApprovers

Collection

A list of rollout approvers.

rolloutNotificationEnabled

Boolean

Rollout notification enabled (default is false).

snapshotName

String

The name of the snapshot.

validationType

DeployerValidationType

The type of validation to perform (APPROVER for approver, PARAM for parameter, ENV for environment, ALL for all validations). Defaults to ALL.

Positional arguments

projectName, applicationName, stageName

Usage

ec-perl

$cmdr->validateDeployer(<projectName>, <applicationName>, <stageName>, {<optionals>});
▼

ectool

ectool validateDeployer projectName applicationName stageName [optionals]
▼
Data retention policy
DevOps Insight data source