Roadmap to CloudBees CD APIs
IntroductionUsing the Groovy APIUsing JRubyCloudBees CD API error messages
Using DSL
IntroductionGetting started with DSLGenerating DSL scriptsDSL automation as codeDSL editorsTroubleshooting and FAQs
DSL method reference
Using the RESTful API
Using the Perl API
Perl API response and element glossary
Perl API reference
IntroductionACL managementApplication dependencyApplicationsApplication tierArtifact managementCatalogsChange historyCI Build detailCI configurationCI JobsComponentsCredential managementCustom filtersDatabase configurationData retentionDevOps insightDirectory Provider managementDynamic environmentsemail configuration managementEmail Notifier managementEnvironmentEnvironment tierGateway and Zone managementInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementServer managementSingle sign-onSnapshotsTier mapUser and Group managementWait dependenciesWebhhook managementWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Using the Groovy API
IntroductionExamples
Groovy API reference
Introductionaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuilddetailciconfigurationclustercomponentcontainercredentialdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitionuserutilityresourcewaitdependencywidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezone

DataRetentionPolicy

3 minute readReference

createDataRetentionPolicy

Create a new data retention policy.

Arguments

Argument NameTypeDescription

dataRetentionPolicyName

String

Unique name of the data retention policy. (Required)

action

String

The action to take on the data that matches the criteria for the data retention rule.

additionalFilters

array

Additional filter criteria for the object type similar to search filters.

age

Integer

Minimum age of the data to qualify for the data retention rule.

ageUnit

String

Time unit for age.

associatedTags

String array

List of tags that the object can be associated with.

cleanupAssociatedWorkspace

Boolean

Whether or not to cleanup the associated workspace directory with the job or deployment being purged.

description

String

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

enabled

Boolean

True to enable the data retention policy. Defaults to true when creating the data retention policy.

includeSubreleases

Boolean

If the data retention rule is defined for releases, then whether to automatically include the sub-releases for the releases matching the data retention rule. Defaults to false.

objectType

String

Type of object for which the retention rule is defined.

projectNames

String array

List of projects that the object can belong to.

statuses

String array

List of statuses for the object such as job status, release status, pipeline run status, or deployment status.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createDataRetentionPolicy(
                dataRetentionPolicyName: 'test-dataRetentionPolicyName'
                /* optional arguments */)

deleteDataRetentionPolicy

Delete a data retention policy.

Arguments

Argument NameTypeDescription

dataRetentionPolicyName

String

Unique name of the data retention policy. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteDataRetentionPolicy(
                dataRetentionPolicyName: 'test-dataRetentionPolicyName')

getDataRetentionPolicies

Retrieve all data retention policies.

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getDataRetentionPolicies()

getDataRetentionPolicy

Retrieve a data retention policy by name.

Arguments

Argument NameTypeDescription

dataRetentionPolicyName

String

Unique name of the data retention policy. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getDataRetentionPolicy(
                dataRetentionPolicyName: 'test-dataRetentionPolicyName')

modifyDataRetentionPolicy

Modify a data retention policy.

Arguments

Argument NameTypeDescription

dataRetentionPolicyName

String

Unique name of the data retention policy. (Required)

action

String

The action to take on the data that matches the criteria for the data retention rule.

additionalFilters

array

Additional filter criteria for the object type similar to search filters.

age

Integer

Minimum age of the data to qualify for the data retention rule.

ageUnit

String

Time unit for age.

associatedTags

String array

List of tags that the object can be associated with.

cleanupAssociatedWorkspace

Boolean

Whether or not to cleanup the associated workspace directory with the job or deployment being purged.

clearAdditionalFilters

Boolean

Whether or not to clear additional filters for the data retention policy.

clearAssociatedTags

Boolean

Whether or not to clear associated tags for the data retention policy.

clearProjectNames

Boolean

Whether or not to clear project names for the data retention policy.

clearStatuses

Boolean

Whether or not to clear statuses for the data retention policy.

description

String

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

enabled

Boolean

True to enable the data retention policy. Defaults to true when creating the data retention policy.

includeSubreleases

Boolean

If the data retention rule is defined for releases, then whether to automatically include the sub-releases for the releases matching the data retention rule. Defaults to false.

newName

String

New name for an existing object that is being renamed.

objectType

String

Type of object for which the retention rule is defined.

projectNames

String array

List of projects that the object can belong to.

statuses

String array

List of statuses for the object such as job status, release status, pipeline run status, or deployment status.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyDataRetentionPolicy(
                dataRetentionPolicyName: 'test-dataRetentionPolicyName'
                /* optional arguments */)
dashboardcolumn
deployerapplication