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

Object Tags

5 minute readReference

createTag

Creates a new tag for an object.

You must specify the tagName.

Arguments Descriptions

tagName

Name of the tag.

Argument Type: String

colorCode

(Optional) Hexadecimal value of the color to be used with an entity.

Argument Type: String

description

(Optional) Comment text describing this object. CloudBees CD/RO ignores this text.

Argument Type: String

Positional arguments

tagName

Response

The newly created Tag object.

ec-perl

syntax: $<object>->createTag(<tagName>, {<optionals>});

Example

$ec->createTag("testtag2", {colorCode => "#ee3647", description => "red tag 2 for testing"});
▼

ectool

syntax: ectool createTag <tagName> [optionals]

Example

ectool createTag "testtag2" --colorCode #ee3647 --description "red tag 2 for testing"
▼

deleteTag

Deletes an existing object tag.

You must specify the tagName.

Arguments Descriptions

tagName

Name of the tag.

Argument Type: String

Positional arguments

tagName

Response

None or a status OK message.

ec-perl

syntax: $<object>->deleteTag(<tagName>);

Example

$ec->deleteTag("testtag2");
▼

ectool

syntax: ectool deleteTag <tagName>

Example

ectool deleteTag "testtag2"
▼

getTag

Retrieves an existing object tag.

You must specify the tagName.

Arguments Descriptions

tagName

Name of the tag.

Argument Type: String

Positional arguments

tagName

Response

A tag object.

ec-perl

syntax: $<object>->getTag(<tagName>);

Example

$ec->getTag("testtag2");
▼

ectool

syntax: ectool getTag <tagName>

Example

ectool getTag "testtag2"
▼

getTags

Get tags based on requested criteria.

Arguments Descriptions

applicationName

(Optional) Name of the application.

Argument Type: String

artifactName

(Optional) Name of the artifact.

Argument Type: String

artifactVersionName

(Optional) Name of the artifact version.

Argument Type: String

componentName

(Optional) Name of the component.

Argument Type: String

entityId

(Optional) ID of the entity to associate with an entity tag link.

Argument Type: UUID

entityType

(Optional) Entity type to associate with an entity tag link.

Argument Type: String

environmentName

(Optional) Name of the environment.

Argument Type: String

environmentTemplateName

(Optional) Name of the environment template.

Argument Type: String

flowRuntimeId

(Optional) ID of the flowRuntime to associate with a tag link.

Argument Type: UUID

gateType <POST|PRE>

(Optional) Type of the gate.

Argument Type: String

jobId

(Optional) ID of the job to associate with a tag link.

Argument Type: UUID

pipelineName

(Optional) Name of the pipeline.

Argument Type: String

procedureName

(Optional) Name of the procedure.

Argument Type: String

processName

(Optional) Name of the process.

Argument Type: String

processStepName

(Optional) Name of the process step.

Argument Type: String

projectName

(Optional) Name of the project.

Argument Type: String

releaseName

(Optional) Name of the release.

Argument Type: String

resourceName

(Optional) Name of the resource.

Argument Type: String

resourceTemplateName

(Optional) Name of the resource template.

Argument Type: String

serviceName

(Optional) Name of the service.

Argument Type: String

stageName

(Optional) Name of the stage.

Argument Type: String

stepName

(Optional) Name of the procedure step.

Argument Type: String

taskName

(Optional) Name of the task.

Argument Type: String

workflowDefinitionName

(Optional) Name of the workflow definition.

Argument Type: String

workflowId

(Optional) ID of the workflow to associate with a tag link.

Argument Type: UUID

workItemId

(Optional) Id for the work item, as returned by getWorkItems , to associate with a tag link.

Argument Type: UUID

Positional arguments

tagName

Response

A set of tag objects based on selected criteria.

ec-perl

syntax: $<object>->getTags (<tagName>, {<optionals>});

Example

$ec->getTags({applicationName => "MyApp"});
▼

ectool

syntax: ectool getTags [optionals]

Example

ectool getTags --applicatinoName MyApp
▼

tagObject

Adds a tag to an object.

You must specify the tagName.

Arguments Descriptions

tagName

Name of the tag.

Argument Type: String

applicationName

(Optional) Name of the application.

Argument Type: String

artifactName

(Optional) Name of the artifact.

Argument Type: String

artifactVersionName

(Optional) Name of the artifact version.

Argument Type: String

componentName

(Optional) Name of the component.

Argument Type: String

entityId

(Optional) ID of the entity to associate with an entity tag link.

Argument Type: UUID

entityType

(Optional) Entity type to associate with an entity tag link.

Argument Type: String

environmentName

(Optional) Name of the environment.

Argument Type: String

environmentTemplateName

(Optional) Name of the environment template.

Argument Type: String

flowRuntimeId

(Optional) ID of the flowRuntime to associate with a tag link.

Argument Type: UUID

gateType <POST|PRE>

(Optional) Type of the gate.

Argument Type: String

jobId

(Optional) ID of the job to associate with a tag link.

Argument Type: UUID

pipelineName

(Optional) Name of the pipeline.

Argument Type: String

procedureName

(Optional) Name of the procedure.

Argument Type: String

processName

(Optional) Name of the process.

Argument Type: String

processStepName

(Optional) Name of the process step.

Argument Type: String

projectName

(Optional) Name of the project.

Argument Type: String

releaseName

(Optional) Name of the release.

Argument Type: String

resourceName

(Optional) Name of the resource.

Argument Type: String

resourceTemplateName

(Optional) Name of the resource template.

Argument Type: String

serviceName

(Optional) Name of the service.

Argument Type: String

stageName

(Optional) Name of the stage.

Argument Type: String

stepName

(Optional) Name of the procedure step.

Argument Type: String

tags tag1 tag2 …​

(Optional) List of tags to add to the entity.

Argument Type: String

taskName

(Optional) Name of the task.

Argument Type: String

workflowDefinitionName

(Optional) Name of the workflow definition.

Argument Type: String

workflowId

(Optional) ID of the workflow to associate with a tag link.

Argument Type: UUID

workItemId

(Optional) Id for the work item, as returned by getWorkItems , to associate with a tag link.

Argument Type: UUID

Positional arguments

tagName

Response

None or a status OK message.

ec-perl

syntax: $<object>->tagObject(<tagName>, {<optionals>});

Example

$ec->tagObject("testtag2", {applicationName => "reportingQ2app"});
▼

ectool

syntax: ectool tagObject <tagName> [optionals]

Example

ectool tagObject "testtag2" --applicationName reportingQ2app
▼

untagObject

Removes a tag from an object.

You must specify the tagName.

Arguments Descriptions

tagName

Name of the tag.

Argument Type: String

applicationName

(Optional) Name of the application.

Argument Type: String

artifactName

(Optional) Name of the artifact.

Argument Type: String

artifactVersionName

(Optional) Name of the artifact version.

Argument Type: String

componentName

(Optional) Name of the component.

Argument Type: String

entityId

(Optional) ID of the entity to associate with an entity tag link.

Argument Type: UUID

entityType

(Optional) Entity type to associate with an entity tag link.

Argument Type: String

environmentName

(Optional) Name of the environment.

Argument Type: String

environmentTemplateName

(Optional) Name of the environment template.

Argument Type: String

flowRuntimeId

(Optional) ID of the flowRuntime to associate with a tag link.

Argument Type: UUID

gateType <POST|PRE>

(Optional) Type of the gate.

Argument Type: String

jobId

(Optional) ID of the job to associate with a tag link.

Argument Type: UUID

pipelineName

(Optional) Name of the pipeline.

Argument Type: String

procedureName

(Optional) Name of the procedure.

Argument Type: String

processName

(Optional) Name of the process.

Argument Type: String

processStepName

(Optional) Name of the process step.

Argument Type: String

projectName

(Optional) Name of the project.

Argument Type: String

releaseName

(Optional) Name of the release.

Argument Type: String

resourceName

(Optional) Name of the resource.

Argument Type: String

resourceTemplateName

(Optional) Name of the resource template.

Argument Type: String

serviceName

(Optional) Name of the service.

Argument Type: String

stageName

(Optional) Name of the stage.

Argument Type: String

stepName

(Optional) Name of the procedure step.

Argument Type: String

tags tag1 tag2 …​

(Optional) List of tags to add to the entity.

Argument Type: String

taskName

(Optional) Name of the task.

Argument Type: String

workflowDefinitionName

(Optional) Name of the workflow definition.

Argument Type: String

workItemId

(Optional) Id for the work item, as returned by getWorkItems , to associate with a tag link.

Argument Type: UUID

Positional arguments

tagName

Response

None or a status OK message.

ec-perl

syntax: $<object>->untagObject(<tagName>, {<optionals>});

Example

$ec->untagObject("testtag2", {applicationName => "reportingQ2app"});
▼

ectool

syntax: ectool untagObject <tagName> [optionals]

Example

ectool untagObject "testtag2" --applicationName reportingQ2app
▼
Microservices
Parameter management