Roadmap to CloudBees CD APIs
IntroductionUsing the Groovy APIUsing JRubyCloudBees CD API error messages
Using DSL
IntroductionGetting started with DSLGenerating DSL scriptsDSL automation as codeDSL editorsTroubleshooting and FAQs
DSL method reference
Using the RESTful API
Using the Perl API
Perl API response and element glossary
Perl API reference
IntroductionACL managementApplication dependencyApplicationsApplication tierArtifact managementCatalogsChange historyCI Build detailCI configurationCI JobsComponentsCredential managementCustom filtersDatabase configurationData retentionDevOps insightDirectory Provider managementDynamic environmentsemail configuration managementEmail Notifier managementEnvironmentEnvironment tierGateway and Zone managementInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementServer managementSingle sign-onSnapshotsTier mapUser and Group managementWait dependenciesWebhhook managementWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Using the Groovy API
IntroductionExamples
Groovy API reference
Introductionaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuilddetailciconfigurationclustercomponentcontainercredentialdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitionuserutilityresourcewaitdependencywidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezone

DeployerService

3 minute readReference

createDeployerService

Adds deployer service to the specified release.

Arguments

Argument NameTypeDescription

projectName

String

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

serviceName

String

The name of the service (Required)

releaseName

String

The name of the release

afterLastRetry

String

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

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'

serviceProjectName

String

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

snapshotName

String

The name of the snapshot

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createDeployerService(
                projectName: 'test-projectName',
                serviceName: 'test-serviceName'
                /* optional arguments */)

getDeployerService

Get the service in the release by name

Arguments

Argument NameTypeDescription

projectName

String

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

serviceName

String

The name of the service (Required)

releaseName

String

The name of the release

serviceProjectName

String

The name of the project containing specified service. 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.getDeployerService(
                projectName: 'test-projectName',
                serviceName: 'test-serviceName'
                /* optional arguments */)

getDeployerServices

Gets all the services in the release

Arguments

Argument NameTypeDescription

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.getDeployerServices(
                projectName: 'test-projectName', )

modifyDeployerService

Modifies deployer service associated with a release.

Arguments

Argument NameTypeDescription

projectName

String

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

serviceName

String

The name of the service (Required)

releaseName

String

The name of the release

afterLastRetry

String

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

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'

serviceProjectName

String

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

snapshotName

String

The name of the snapshot

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyDeployerService(
                projectName: 'test-projectName',
                serviceName: 'test-serviceName'
                /* optional arguments */)

removeDeployerService

Removes a deployer service

Arguments

Argument NameTypeDescription

projectName

String

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

serviceName

String

The name of the service (Required)

releaseName

String

The name of the release

serviceProjectName

String

The name of the project containing specified service. 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.removeDeployerService(
                projectName: 'test-projectName',
                serviceName: 'test-serviceName'
                /* optional arguments */)
deployerconfiguration
deploymenthistoryitem