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
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Components

3 minute readReference

copyComponent

Creates a new component based on an existing one.

Arguments

Argument Name Type Description

projectName

String

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

componentName

String

(Required) The name of the component.

newComponentName

String

(Required) The name of new component.

applicationTierName

String

The name of the tier.

description

String

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

fromApplicationName

String

The name of the source application.

toApplicationName

String

The name of the source application.

Positional arguments

projectName, componentName, newComponentName

Usage

ec-perl

$cmdr->copyComponent(<projectName>, <componentName>, <newComponentName>, {<optionals>});
▼

ectool

ectool copyComponent projectName componentName newComponentName [optionals]
▼

createComponent

Creates a new component for a project.

Arguments

Argument Name Type Description

projectName

String

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

componentName

String

(Required) The name of the component.

actualParameters

Map

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/RO.

pluginKey

String

The key of the plugin.

pluginName

String

The name of the plugin.

pluginParameters

Map

List of plugin parameters.

reference

Boolean

If 1 or true, a reference of the component is created. If 0 or false, a copy of the component is created.

sourceApplicationName

String

The name of the source application.

sourceComponentName

String

The name of new component.

sourceProjectName

String

The name of source project.

Positional arguments

projectName, componentName

Usage

ec-perl

$cmdr->createComponent(<projectName>, <componentName>, {<optionals>});
▼

ectool

ectool createComponent projectName componentName [optionals]
▼

deleteComponent

Deletes a component.

Arguments

Argument Name Type Description

projectName

String

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

componentName

String

(Required) The name of the component.

applicationName

String

The name of an application to scope this component to.

Positional arguments

projectName, componentName

Usage

ec-perl

$cmdr->deleteComponent(<projectName>, <componentName>, {<optionals>});
▼

ectool

ectool deleteComponent projectName componentName [optionals]
▼

getComponent

Retrieves a component by name.

Arguments

Argument Name Type Description

projectName

String

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

componentName

String

(Required) The name of the component.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

applicationName

String

The name of an application to scope this component to.

Positional arguments

projectName, componentName

Usage

ec-perl

$cmdr->getComponent(<projectName>, <componentName>, {<optionals>});
▼

ectool

ectool getComponent projectName componentName [optionals]
▼

getComponents

Retrieves all components in a project.

Arguments

Argument Name Type Description

projectName

String

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

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

applicationName

String

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

Positional arguments

projectName

Usage

ec-perl

$cmdr->getComponents(<projectName>, {<optionals>});
▼

ectool

ectool getComponents projectName [optionals]
▼

getComponentsInApplicationTier

Retrieves the list of components in an application tier.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

applicationTierName

String

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

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

includeArtifactDetail

Boolean

Retrieves artifact name and version as part of component response.

Positional arguments

projectName, applicationName, applicationTierName

Usage

ec-perl

$cmdr->getComponentsInApplicationTier(<projectName>, <applicationName>, <applicationTierName>, {<optionals>});
▼

ectool

ectool getComponentsInApplicationTier projectName applicationName applicationTierName [optionals]
▼

modifyComponent

Modifies an existing component.

Arguments

Argument Name Type Description

projectName

String

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

componentName

String

(Required) The name of the component.

actualParameters

Map

Parameters passed as arguments to the application component.

applicationName

String

The name of an application to scope this component to.

clearActualParameters

Boolean

If true, 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/RO.

newName

String

The 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

Map

List of plugin parameters.

Positional arguments

projectName, componentName

Usage

ec-perl

$cmdr->modifyComponent(<projectName>, <componentName>, {<optionals>});
▼

ectool

ectool modifyComponent projectName componentName [optionals]
▼

removeComponentFromApplicationTier

Removes the specified component from an application tier.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

applicationTierName

String

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

componentName

String

(Required) Name of the component.

componentProjectName

String

Project name of the component.

Positional arguments

projectName, applicationName, applicationTierName, componentName

Usage

ec-perl

$cmdr->removeComponentFromApplicationTier(<projectName>, <applicationName>, <applicationTierName>, <componentName>, {<optionals>});
▼

ectool

ectool removeComponentFromApplicationTier projectName applicationName applicationTierName componentName [optionals]
▼
Cluster
Credential