Using the Perl API
IntroductionAccess tokensACL managementApplication dependencyApplicationsApplication tier Artifact managementCatalogsChange historyCI build detailCI configurationCI jobsComponentsCredential managementCustom filtersDatabase configurationData retentionCloudBees AnalyticsDirectory provider managementDynamic environmentsEmail configuration managementEmail notifier managementEnvironmentEnvironment tierGateway and zone managementGet application environment inventoryInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementPlugin configuration managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementService accounts for webhooksServer managementSingle sign on for SAMLSnapshotsTier mapTrigger managementUser and group managementUser profile email managementWait dependenciesWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
IntroductionExamplesTroubleshooting
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

DeployerApplication

3 minute readReference

createDeployerApplication

Adds deployer application to the specified release.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application (Required)

releaseName

String

The name of the release

afterLastRetry

String

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

String

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

retryApprovers

String array

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

String

Type of rety 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 the application process.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.createDeployerApplication(
                projectName: 'test-projectName',
                applicationName: 'test-applicationName'
                /* optional arguments */)
▼

getDeployerApplication

Get the application in the release by name

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application (Required)

releaseName

String

The name of the release

applicationProjectName

String

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

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getDeployerApplication(
                projectName: 'test-projectName',
                applicationName: 'test-applicationName'
                /* optional arguments */)
▼

getDeployerApplications

Gets all the applications in the release

Arguments

Argument Name Type Description

projectName

String

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

releaseName

String

The name of the release

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getDeployerApplications(
                projectName: 'test-projectName', )
▼

modifyDeployerApplication

Modifies deployer application associated with a release.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application (Required)

releaseName

String

The name of the release

afterLastRetry

String

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

String

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

retryApprovers

String array

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

String

Type of rety 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 the application process.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyDeployerApplication(
                projectName: 'test-projectName',
                applicationName: 'test-applicationName'
                /* optional arguments */)
▼

removeDeployerApplication

Removes a deployer application

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application (Required)

releaseName

String

The name of the release

applicationProjectName

String

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

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.removeDeployerApplication(
                projectName: 'test-projectName',
                applicationName: 'test-applicationName'
                /* optional arguments */)
▼
dataretentionpolicy
deployerconfiguration