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

Application tier

2 minute readReference

addComponentToApplicationTier

Adds the specified component to the specified 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->addComponentToApplicationTier(<projectName>, <applicationName>, <applicationTierName>, <componentName>, {<optionals>});
▼

ectool

ectool addComponentToApplicationTier projectName applicationName applicationTierName componentName [optionals]
▼

createApplicationTier

Creates a new application tier in the application.

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.

description

String

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

Positional arguments

projectName, applicationName, applicationTierName

Usage

ec-perl

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

ectool

ectool createApplicationTier projectName applicationName applicationTierName [optionals]
▼

deleteApplicationTier

Deletes a tier from an application.

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.

Positional arguments

projectName, applicationName, applicationTierName

Usage

ec-perl

$cmdr->deleteApplicationTier(<projectName>, <applicationName>, <applicationTierName>);
▼

ectool

ectool deleteApplicationTier projectName applicationName applicationTierName
▼

getApplicationTier

Retrieves an application tier by name.

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.

Positional arguments

projectName, applicationName, applicationTierName

Usage

ec-perl

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

ectool

ectool getApplicationTier projectName applicationName applicationTierName [optionals]
▼

getApplicationTiers

Retrieves all application tiers in an application.

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.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

Positional arguments

projectName, applicationName

Usage

ec-perl

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

ectool

ectool getApplicationTiers projectName applicationName [optionals]
▼

getApplicationTiersInComponent

Retrieves all application tiers that are used by the given 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.

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->getApplicationTiersInComponent(<projectName>, <componentName>, {<optionals>});
▼

ectool

ectool getApplicationTiersInComponent projectName componentName [optionals]
▼

modifyApplicationTier

Modifies an existing tier in the application.

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.

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.

Positional arguments

projectName, applicationName, applicationTierName

Usage

ec-perl

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

ectool

ectool modifyApplicationTier projectName applicationName applicationTierName [optionals]
▼
Application
Archive connector