Introduction
Using JRuby
API error messages
API command line access
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 reference
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 managementInstalling 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
Using the Groovy API
IntroductionExamplesTroubleshooting
Groovy API reference
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

UtilityResource

2 minute readReference

createUtilityResource

Create new utility resource.

Arguments

Argument NameTypeDescription

projectName

String

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

utilityResourceName

String

Name for utilityResource; must be unique among all utility resources for the environment or environemnt template. (Required)

environmentName

String

Name of parent environment

description

String

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

environmentTemplateName

String

Name of parent environmentTemplate

resourceName

String

The name of the default resource for this utility resource.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteUtilityResource

Deletes a utility resource.

Arguments

Argument NameTypeDescription

projectName

String

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

utilityResourceName

String

Name for utilityResource; must be unique among all utility resources for the environment or environemnt template. (Required)

environmentName

String

Name of parent environment

environmentTemplateName

String

Name of parent environmentTemplate

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getUtilityResource

Retrieve an utility resource by name.

Arguments

Argument NameTypeDescription

projectName

String

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

utilityResourceName

String

Name for utilityResource; must be unique among all utility resources for the environment or environemnt template. (Required)

environmentName

String

Name of parent environment

environmentTemplateName

String

Name of parent environmentTemplate

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getUtilityResources

Retrieve all utility resources in an environment or environment template.

Arguments

Argument NameTypeDescription

projectName

String

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

environmentName

String

Name of parent environment

environmentTemplateName

String

Name of parent environmentTemplate

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyUtilityResource

Modify a utility resource.

Arguments

Argument NameTypeDescription

projectName

String

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

utilityResourceName

String

Name for utilityResource; must be unique among all utility resources for the environment or environemnt template. (Required)

environmentName

String

Name of parent environment

description

String

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

environmentTemplateName

String

Name of parent environmentTemplate

newName

String

New name for an existing object that is being renamed.

resourceName

String

The name of the default resource for this utility resource.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyUtilityResource(
                projectName: 'test-projectName',
                utilityResourceName: 'test-utilityResourceName'
                /* optional arguments */)
useremail
waitdependency