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

PluginConfiguration

2 minute readReference

createPluginConfiguration

[PREVIEW] This API is in preview mode, and therefore subject to change. Create a new plugin configuration.

Arguments

Argument Name Type Description

projectName

String

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

pluginConfigurationName

String

Unique name of the plugin configuration within the project. (Required)

credentialReferenceParameters

array

List of credential parameters with references to existing credentials as parameter values. If the parameter value is a property reference then the credential would be resolved at runtime.

credentials

Credential array

Credentials to be used by the plugin config.

description

String

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

fields

Field array

Fields for plugin configuration.

pluginKey

String

The plugin key.

pluginProjectName

String

The name for the plugin’s project.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deletePluginConfiguration

Deletes a plugin configuration

Arguments

Argument Name Type Description

projectName

String

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

pluginConfigurationName

String

Unique name of the plugin configuration within the project. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deletePluginConfiguration(
                projectName: 'test-projectName',
                pluginConfigurationName: 'test-pluginConfigurationName')

getPluginConfiguration

Find a plugin configuration.

Arguments

Argument Name Type Description

projectName

String

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

pluginConfigurationName

String

Unique name of the plugin configuration within the project. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getPluginConfiguration(
                projectName: 'test-projectName',
                pluginConfigurationName: 'test-pluginConfigurationName')

getPluginConfigurations

[PREVIEW] This API is in preview mode, and therefore subject to change. Find plugin configurations.

Arguments

Argument Name Type Description

pluginKey

String

The plugin’s key.

pluginProjectName

String

The name for the plugin’s project.

projectName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getPluginConfigurations(
                /* optional arguments */)

modifyPluginConfiguration

[PREVIEW] This API is in preview mode, and therefore subject to change. Modify a plugin configuration.

Arguments

Argument Name Type Description

projectName

String

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

pluginConfigurationName

String

Unique name of the plugin configuration within the project. (Required)

clearCredentialNames

String array

Collection of existing credential names to be cleared for the plugin configuration.

clearCredentials

Boolean

Whether or not to clear existing credentials for the plugin configuration.

clearFields

Boolean

Whether or not to clear fields for the plugin configuration.

credentialReferenceParameters

array

List of credential parameters with references to existing credentials as parameter values. If the parameter value is a property reference then the credential would be resolved at runtime.

credentials

Credential array

Credentials to be used by the plugin config.

description

String

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

fields

Field array

Fields for plugin configuration.

newName

String

New name for an existing object that is being renamed.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyPluginConfiguration(
                projectName: 'test-projectName',
                pluginConfigurationName: 'test-pluginConfigurationName'
                /* optional arguments */)
plugincatalog
procedure