Back to indexSummaryData Retention Policy.dataRetentionPolicyNameStringrequiredUnique name of the data retention policy.actionStringoptionalThe action to take on the data that matches the criteria for the data retention rule.additionalFiltersStringoptionalAdditional filter criteria for the object type similar to search filters. (Alternate argument name additionalFilter.)ageStringoptionalMinimum age of the data to qualify for the data retention rule.ageUnitStringoptionalTime unit for age.associatedTagsStringoptionalList of tags that the object can be associated with. (Alternate argument name associatedTag.)cleanupAssociatedWorkspaceStringoptionalWhether or not to cleanup the associated workspace directory with the job or deployment being purged.cleanupDatabaseStringoptionalWhether or not to delete the jobs from the database. If set to false, then cleanupAssociatedWorkspace must be set to true for the jobs or deployments being purged.clearAdditionalFiltersStringoptionalWhether or not to clear additional filters for the data retention policy.clearAssociatedTagsStringoptionalWhether or not to clear associated tags for the data retention policy.clearProjectNamesStringoptionalWhether or not to clear project names for the data retention policy.clearStatusesStringoptionalWhether or not to clear statuses for the data retention policy.descriptionStringoptionalComment text describing this object that is not interpreted at all by CloudBees CD/RO.enabledStringoptionalTrue to enable the data retention policy. Defaults to true when creating the data retention policy.includeSubreleasesStringoptionalWhen set to true subreleases will be automatically included for releases matching the data retention rule. Defaults to false.newNameStringoptionalThe new name for an existing object that is being renamed.numberToRetainStringoptionalNumber of objects to retain.objectTypeStringoptionalType of object for which the retention rule is defined.projectNamesStringoptionalList of projects that the object can belong to. (Alternate argument name projectName.)statusesStringoptionalList of statuses for the object such as job status, release status, pipeline run status, or deployment status. (Alternate argument name status.)UsageThere are no usage examples available for dataRetentionPolicy.