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

Component

6 minute readReference

attachCredential

Attach a credential to an object.

Arguments

Argument Name Type Description

projectName

String

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

credentialName

String

The name of the credential. (Required)

componentName

String

The name of the component, if attaching a credential to a component, component process, or component process step.

applicationName

String

The name of the application, if attaching a credential to an application process, or application process step.

applicationProjectName

String

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

deployerTaskName

String

The name of the deployer task mapped to the deployer configuration.

gateType

String

The type of the gate.

pipelineName

String

The name of the pipeline, if attaching a credential to a stage task.

procedureName

String

The name of the procedure, if attaching a credential to a procedure or a procedure step.

processName

String

The name of the process, if attaching a credential to a process or a process step.

processStepName

String

The name of the process step, if attaching a credential to a process step.

releaseName

String

The name of the release, if attaching a credential to a release.

scheduleName

String

The name of the schedule, if attaching a credential to a schedule.

serviceName

String

The name of the service, if attaching a credential to a service process, or service process step.

serviceProjectName

String

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

stageName

String

The name of the stage, if attaching a credential to its task.

stateDefinitionName

String

The name of the workflow state definition, if attaching a credential to a state definition.

stepName

String

The name of the procedure step, if attaching a credential to a procedure step.

taskName

String

The name of the task, if attaching a credential to a task.

workflowDefinitionName

String

The name of the workflow, if attaching a credential to a state definition.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

copyComponent

Allows easily create newer components based on existing ones

Arguments

Argument Name Type Description

componentName

String

The name of the component (Required)

newComponentName

String

The name of new component (Required)

projectName

String

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

applicationTierName

String

Name of the tier

description

String

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

fromApplicationName

String

The name of source application

toApplicationName

String

The name of source application

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.copyComponent(
                componentName: 'test-componentName',
                newComponentName: 'test-newComponentName',
                projectName: 'test-projectName'
                /* optional arguments */)

createComponent

Creates a new component for a project.

Arguments

Argument Name Type Description

projectName

String

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

componentName

String

The name of the component (Required)

actualParameters

 
array

Parameters passed as arguments to the application component.

applicationName

String

The name of an application to scope this component to.

credentialName

String

The name of a credential to attach to this component.

description

String

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

pluginKey

String

The key of the plugin

pluginName

String

The name of the plugin

pluginParameters

 
array

List of plugin parameters

reference

Boolean

1 to create reference of the component and 0 to create copy of the component

sourceApplicationName

String

The name of source application

sourceComponentName

String

The name of new component

sourceProjectName

String

The name of source project

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteComponent

Deletes a component

Arguments

Argument Name Type Description

projectName

String

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

componentName

String

The name of the component (Required)

applicationName

String

The name of an application to scope this component to.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

detachCredential

Detach a credential from an object.

Arguments

Argument Name Type Description

projectName

String

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

credentialName

String

The name of the credential. (Required)

componentName

String

The name of the component, if attaching a credential to a component, component process, or component process step.

applicationName

String

The name of the application, if attaching a credential to an application process, or application process step.

applicationProjectName

String

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

deployerTaskName

String

The name of the deployer task mapped to the deployer configuration.

gateType

String

The type of the gate.

pipelineName

String

The name of the pipeline, if attaching a credential to a stage task.

procedureName

String

The name of the procedure, if attaching a credential to a procedure or a procedure step.

processName

String

The name of the process, if attaching a credential to a process or a process step.

processStepName

String

The name of the process step, if attaching a credential to a process step.

releaseName

String

The name of the release, if attaching a credential to a release.

scheduleName

String

The name of the schedule, if attaching a credential to a schedule.

serviceName

String

The name of the service, if attaching a credential to a service process, or service process step.

serviceProjectName

String

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

stageName

String

The name of the stage, if attaching a credential to its task.

stateDefinitionName

String

The name of the workflow state definition, if attaching a credential to a state definition.

stepName

String

The name of the procedure step, if attaching a credential to a procedure step.

taskName

String

The name of the task, if attaching a credential to a task.

workflowDefinitionName

String

The name of the workflow, if attaching a credential to a state definition.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getComponent

Find a component by name.

Arguments

Argument Name Type Description

projectName

String

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

componentName

String

The name of the component (Required)

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationName

String

The name of an application to scope this component to.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getComponents

Retrieve all components in a project.

Arguments

Argument Name Type Description

projectName

String

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

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationName

String

Name of the application. Specify to search for components scoped to an application.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getComponentsInApplicationTier

Return the list of components in an application tier.

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)

applicationTierName

String

Name of the tier; must be unique within the application. (Required)

applicationEntityRevisionId

String

Revisionid of the versioned object

includeArtifactDetail

Boolean

Return artifact name and version as part of component response

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyComponent

Modifies an existing component.

Arguments

Argument Name Type Description

projectName

String

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

componentName

String

The name of the component (Required)

actualParameters

 
array

Parameters passed as arguments to the application component.

applicationName

String

The name of an application to scope this component to.

clearActualParameters

Boolean

True if the step should remove all actual parameters.

credentialName

String

The name of a credential to attach to this component.

description

String

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

newName

String

New name for an existing object that is being renamed.

pluginKey

String

The key of the plugin

pluginName

String

The name of the plugin

pluginParameters

 
array

List of plugin parameters

Usage

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


ElectricFlow ef = new ElectricFlow()

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

removeComponentFromApplicationTier

Removes the given component from the given application tier.

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)

applicationTierName

String

Name of the tier; must be unique within the application. (Required)

componentName

String

Name of the component. (Required)

componentProjectName

String

Project name of the component

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.removeComponentFromApplicationTier(
                projectName: 'test-projectName',
                applicationName: 'test-applicationName',
                applicationTierName: 'test-applicationTierName',
                componentName: 'test-componentName'
                /* optional arguments */)
cluster
container