Using the Perl API
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 managementGet application environment inventoryInstalling 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
IntroductionExamplesTroubleshooting
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Application Tier Commands

3 minute readReference

createApplicationTier

Creates a new application tier in the application.

You must specify the projectName, applicationName, and applicationTierName.

Arguments Descriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

Argument Type: String

applicationName

Name of the application that must be unique among all projects.

Argument Type: String

applicationTierName

Name of the tier that must be unique within the application.

Argument Type: String

description

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

Argument Type: String

Positional arguments

projectName, applicationName, applicationTierName

Response

Returns an application tier element.

ec-perl

syntax: $<object>->createApplicationTier(<projectName>, <applicationName>, <applicationTierName>, {<optionals>});

Example

$ec->createApplicationTier("Default", "Deploy", "Heat Clinic", {description => "Web setup"});
▼

ectool

syntax: ectool createApplicationTier <projectName> <applicationName> <applicationTierName> [optionals]

Example

ectool createApplicationTier "Default" "Deploy" "Heat Clinic" --description "Web setup"
▼

deleteApplicationTier

Deletes a tier from an application.

You must specify the projectName, applicationName, and applicationTierName.

Arguments Descriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

Argument Type: String

applicationName

Name of the application that must be unique among all projects.

Argument Type: String

applicationTierName

Name of the tier that must be unique within the application.

Argument Type: String

Positional arguments

projectName, applicationName, applicationTierName

Response

None or a status OK message.

ec-perl

syntax: $<object>->deleteApplicationTier(<projectName>, <applicationName>, <applicationTierName>);

Example

$ec->deleteApplicationTier("Default", "Undeploy", "Tomcat");
▼

ectool

syntax: ectool deleteApplicationTier <projectName> <applicationName> <applicationTierName>

Example

ectool deleteApplicationTier "Default" "Undeploy" "Tomcat"
▼

getApplicationTier

Retrieves an application tier by name.

You must specify the projectName, applicationName, and applicationTierName.

Arguments Descriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

Argument Type: String

applicationName

Name of the application that must be unique among all projects.

Argument Type: String

applicationTierName

Name of the tier that must be unique within the application.

Argument Type: String

applicationEntityRevisionId

(Optional) The revision ID of the versioned object.

Argument type: UUID

Positional arguments

projectName, applicationName, applicationTierName

Response

Returns an application tier element.

ec-perl

syntax: $<object>->getApplicationTier(<projectName>, <applicationName>, <applicationTierName>, {<optionals>});

Example

$ec->getApplicationTier("Default", "Deploy", "Tomcat", {applicationEntityRevisionId => "4fa765dd-73f1-11e3-b67e-b0a420524153"});
▼

ectool

syntax: ectool getApplicationTier <projectName> <applicationName> <applicationTierName> [optionals]

Example

ectool getApplicationTier "Default" "Deploy" "Tomcat" --applicationEntityRevisionId 4fa765dd-73f1-11e3-b67e-b0a420524153
▼

getApplicationTiers

Retrieves all application tiers in an application.

You must specify the projectName and applicationName arguments.

Arguments Descriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

Argument Type: String

applicationName

Name of the application that must be unique among all projects.

Argument Type: String

applicationEntityRevisionId

(Optional) The revision ID of the versioned object.

Argument type: UUID

Positional arguments

projectName, applicationName

Response

Returns zero or more application tier elements.

ec-perl

syntax: $<object>->getApplicationTiers(<projectName>, <applicationName>, {<optionals>});

Example

$ec->getApplicationTiers("Default", "Deploy", {applicationEntityRevisionId => "4fa765dd-73f1-11e3-b67e-b0a420524153"});
▼

ectool

syntax: ectool getApplicationTiers <projectName> <applicationName> [optionals]

Example

ectool getApplicationTiers "Default" "Deploy" --applicationEntityRevisionId 4fa765dd-73f1-11e3-b67e-b0a420524153
▼

getApplicationTiersInComponent

Retrieves all application tiers that are used by the given component.

You must specify the projectName and the componentName arguments.

Arguments Descriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

Argument Type: String

componentName

Name of the component.

Argument Type: String

applicationEntityRevisionId

(Optional) The revision ID of the versioned object.

Argument type: UUID

applicationName

(Optional) Name of an application to which this component is scoped.

Argument Type: String

reference

(Optional) < Boolean flag— 0|1|true|false >

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

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

Argument type: Boolean

sourceApplicationName

(Optional) The name of source application.

Argument Type: String

sourceComponentName

(Optional) The name of new component.

Argument Type: String

sourceProjectName

(Optional) The name of source project.

Argument Type: String

Positional arguments

projectName, componentName

Response

Returns zero or more application tier elements used by the specified component.

ec-perl

syntax: $<object>->getApplicationTiersInComponent(<projectName>, <componentName>, {<optionals>});

Example

$ec->getApplicationTiersInComponent("Default", "WAR file", {applicationName => "Snapshot"});
▼

ectool

syntax: ectool getApplicationTiersInComponent <projectName> <componentName> [optionals]

Example

ectool getApplicationTiersInComponent "Default" "WAR file" --applicationName "Snapshot"
▼

modifyApplicationTier

Modifies an existing tier in the application.

You must specify the projectName, applicationName, and applicationTierName arguments.

Arguments Descriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

Argument Type: String

applicationName

Name of the application that must be unique within the project.

Argument Type: String

applicationTierName

Name of the tier that must be unique within the application.

Argument Type: String

description

(Optional) Comment text describing this object, which is not interpreted by CloudBees CD/RO .

Argument Type: String

newName

(Optional) New name for an existing object that is being renamed.

Argument Type: String

Positional arguments

projectName, applicationName, applicationTierName

Response

Returns an updated application tier element.

ec-perl

syntax: $<object>->modifyApplicationTier(<projectName>, <applicationName>,<applicationTierName>, {<optionals>});

Example

$ec->modifyApplicationTier("Default", "Publish README", "App Server", {newName=> "Deploy README", description=> "Revised README file"});
▼

ectool

syntax: ectool modifyApplicationTier <projectName> <applicationName> <applicationTierName> [optionals]

Example

ectool  modifyApplicationTier "Default" "Publish README" "App Server" --newName "Deploy README" --description "Revised README file"
▼
Applications
Artifact management