About This Guide

2 minute readReference

The CloudBees Flow API Guide discusses how to use the API in the CloudBees Flow® DevOps Release Automation platform for provisioning, build, and release management of multi-tiered applications. CloudBees Flow is a unified platform for automating bottlenecks in the software delivery lifecycle and making software delivery faster, easier, and more reliable. This guide shows DevOps teams how to get started with automation by plugging in their existing tools and processes and future-proofing their work by using CloudBees Flow’s flexible, scalable orchestration platform.


This guide is for DevOps professionals such as product managers, software developers, and IT staff who want to automate the processes between their respective teams to build, test, and deploy or release software faster and more reliably.


This guide covers topics in the following chapters and appendices:

Chapter Description

Provides an overview of CloudBees Flow, including details about its purpose and key benefits.

Describes the basics of using the API, including how to log in and use the ectool and ec-perl command-line tools, the Perl API structure, command global arguments, batch mode, installing CloudBees Flow Perl modules into your Perl distribution, and installing perl Modules into the CloudBees Flow Perl distribution.

Provides lists of the API commands categorized by functionality. This chapter also provides descriptions, lists of arguments with their descriptions, and examples for each command.

Lists some (but not all) of the response container elements in alphabetical order. The contents for each container element lists all or most of the possible returned response elements—both simple and subcontainer elements. This chapter also contains an element glossary for some (but not all) of the single or “leaf” elements and subcontainer elements.

Describes how to use the CloudBees Flow REST API to access the REST API resources and operations and execute a request.

Shows how to use the CloudBees Flow domain-specific language (DSL), which is an intuitive, Groovy-based, easy-to-use computer language that lets you model CD and ARA solutions.

Describes how to create APIs written in Groovy.

Describes how to create APIs written in JRuby.