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

CiConfiguration

2 minute readReference

createCIConfiguration

Create a new CI Configuration.

Arguments

Argument Name Type Description

ciConfigurationName

String

The name of the CI Configuration. (Required)

description

String

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

password

String

Password for authenticating with the CI server.

serverUrl

String

Url to connect to CI server.

testConnection

Boolean

Whether the connection to the CI Server should be tested before saving the configuration. Defaults to false.

userName

String

Username for authenticating with the CI server.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createCIConfiguration(
                ciConfigurationName: 'test-ciConfigurationName'
                /* optional arguments */)

deleteCIConfiguration

Deletes a CI Configuration

Arguments

Argument Name Type Description

ciConfigurationName

String

The name of the CI Configuration. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteCIConfiguration(
                ciConfigurationName: 'test-ciConfigurationName')

getCIConfiguration

Create a new CI Configuration.

Arguments

Argument Name Type Description

ciConfigurationName

String

The name of the CI Configuration. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getCIConfiguration(
                ciConfigurationName: 'test-ciConfigurationName')

getCIConfigurations

Retrieve all CI Configurations

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getCIConfigurations()

modifyCIConfiguration

Modify an existing CI Configuration.

Arguments

Argument Name Type Description

ciConfigurationName

String

The name of the CI Configuration. (Required)

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.

password

String

Password for authenticating with the CI server.

serverUrl

String

Url to connect to CI server.

testConnection

Boolean

Whether the connection to the CI Server should be tested before saving the configuration. Defaults to false.

userName

String

Username for authenticating with the CI server.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyCIConfiguration(
                ciConfigurationName: 'test-ciConfigurationName'
                /* optional arguments */)
cibuilddetail
cluster