API error messages
Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercompliancecomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

CiConfiguration

2 minute readReference

createCIConfiguration

Creates a new CI server configuration.

Arguments

Argument Name Type Description

ciConfigurationName

String

The name of the CI configuration. (Required)

ciConfigurationType

String

The type of CI configuration.

credentialName

String

The name of the credential.

credentialProjectName

String

The name of the project containing specified credential.

description

String

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

isDefault

Boolean

Set as default CI Configuration.

overrideDefault

Boolean

If true, the isDefault flag is overwritten for the existing, default CI configuration.

password

String

The password for authenticating with the CI server.

publicKey

String

Public key for the CI controller. Use this argument to specify the public key for the CI controller if the server is unable to retrieve the controller’s public key due to network topology.

refCIConfiguration

String

References the CI configuration to use the userName and password or API token.

serverUrl

String

URL to connect to the CI server.

testConnection

Boolean

Specifies if the connection to the CI server should be tested before saving the configuration. The default is false.

userName

String

The user name 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

Retrieves 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.getCIConfiguration(
                ciConfigurationName: 'test-ciConfigurationName')
▼

getCIConfigurations

Retrieves all CI configurations.

Arguments

Argument Name Type Description

ciConfigurationType

String

The type of CI configuration.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getCIConfigurations(
                /* optional arguments */)
▼

modifyCIConfiguration

Modifies an existing CI server configuration.

Arguments

Argument Name Type Description

ciConfigurationName

String

The name of the CI configuration. (Required)

ciConfigurationType

String

The type of CI configuration.

credentialName

String

The name of the credential.

credentialProjectName

String

The name of the project containing specified credential.

description

String

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

isDefault

Boolean

Set as default CI Configuration.

newName

String

The new name for an existing object that is being renamed.

overrideDefault

Boolean

If true, the isDefault flag is overwritten for the existing, default CI configuration.

password

String

The password for authenticating with the CI server.

publicKey

String

Public key for the CI controller. Use this argument to specify the public key for the CI controller if the server is unable to retrieve the controller’s public key due to network topology.

serverUrl

String

URL to connect to the CI server.

testConnection

Boolean

Specifies if the connection to the CI server should be tested before saving the configuration. The default is false.

userName

String

The user name 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
cievent