Documentation
Software Delivery Automation
CloudBees Software Delivery Automation CloudBees CI CloudBees CD/RO CloudBees Previews
Other CloudBees Products
CloudBees Build Acceleration CloudBees CodeShip CloudBees Jenkins Platform
CloudBees Platform
CloudBees Feature Management CloudBees Value Stream Management
Resources
Account management cbsupport CLI Legal and policies
Training
Support
Plugins
CloudBees CI Plugins CloudBees CD/RO Plugins
Lexicon
CloudBees CI CloudBees CD/RO CloudBees Feature Management CloudBees Build Acceleration
Search
New to CloudBees or returning.
Sign in / Sign up

Resources

Account management cbsupport CLI Legal and policies

Software Delivery Automation

CloudBees Software Delivery Automation CloudBees CI CloudBees CD/RO CloudBees Previews

CloudBees Platform

CloudBees Feature Management CloudBees Release Orchestration SaaS CloudBees Value Stream Management

Other CloudBees Products

CloudBees Build Acceleration CloudBees CodeShip CloudBees Jenkins Platform

Documentation API reference (Stable)DSL API reference (Preview)Groovy API reference (Preview)Perl API reference (Preview)Plugin developer kit Plugin documentation Technical evaluation Lexicon Release notes Knowledge Base

latest (2023.03.0)2023.02.0 10.11 10.10 10.9 10.8 10.7 10.6 10.5 10.4 10.3 10.2 10.1 10.0 9.2 7.3 and earlier0

API error messages

API command line access

Using DSL

Introduction Getting started with DSL Generating DSL scripts DSL automation as code DSL editors Troubleshooting and FAQs

DSL method reference

Using the RESTful API

Using the Perl API

Perl API reference

Introduction Access tokens ACL management Application dependency Applications Application tier Artifact management Catalogs Change history CI build detail CI configuration CI jobs Components Credential management Custom filters Database configuration Data retention CloudBees Analytics Directory provider management Dynamic environments Email configuration management Email notifier management Environment Environment tier Gateway and zone management Get application environment inventory Installing or upgrading remote agents Job management Microservices Object tags Parameter management Personas Pipelines and releases Plugin management Plugin configuration management Procedure management Process Process dependency Process step Project management Property management Resource management Rolling deploy Schedule management Service accounts for webhooks Server management Single sign on for SAML Snapshots Tier map Trigger management User and group management User profile email management Wait dependencies Workflow definition management Workflow management Work items Workspace management Miscellaneous management

Perl API response and element glossary

Using the Groovy API

Introduction Examples Troubleshooting

Groovy API reference

Introduction accesstoken acl aclentry actualparameter actualparameters application applicationdependency applicationtier archiveconnector artifact artifactversion catalog catalogitem catalogitemrun cibuild cibuilddetail ciconfiguration cievent cluster component credential credentialprovider dashboard dashboardcolumn dataretentionpolicy deployerapplication deployerconfiguration deploymenthistoryitem devopsinsightdatasource directoryprovider emailconfig emailnotifier entitychange environment environmentinventoryitem environmenttemplate environmenttemplatetier environmenttemplatetiermap environmenttemplatetiermapping environmenttier envtempltierresourcetemplmapping eventsubscription flowruntime formaloutputparameter formalparameter gate gateway group hook job jobstep kerberoskeytab license microservice microservicemapping note object openidconnectconfiguration outputparameter persona personacategory personapage pipeline plugin plugincatalog pluginconfiguration procedure procedurestep process processdependency processstep project property release report reportingfilter reportobjectassociation reportobjectattribute reportobjecttype repository reservation resource resourcepool resourcetemplate resourceusage retrievedartifacts rollingdeployphase rundiscovery samlidentityprovider samlserviceprovider schedule scmsync searchfilter server serversetting serversettingcategory serviceaccount session snapshot stage state statedefinition tag task tiermap tiermapping transition transitiondefinition trigger triggererrordetail user useremail utilityresource waitdependency webhookresult widget widgetfilteroverride workflow workflowdefinition workitem workspace zone Argument models

CloudBees Analytics

30 minute readReference

You are browsing an older version of this page.

Click here to view the latest released version.

Refer to