About This Guide

On this page

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.

Audience

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.

Organization

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.

Copyright © 2010-2020 CloudBees, Inc.Online version published by CloudBees, Inc. under the Creative Commons Attribution-ShareAlike 4.0 license.CloudBees and CloudBees DevOptics are registered trademarks and CloudBees Core, CloudBees Flow, CloudBees Flow Deploy, CloudBees Flow DevOps Insight, CloudBees Flow DevOps Foresight, CloudBees Flow Release, CloudBees Accelerator, CloudBees Accelerator ElectricInsight, CloudBees Accelerator Electric Make, CloudBees CodeShip, CloudBees Jenkins Enterprise, CloudBees Jenkins Platform, CloudBees Jenkins Operations Center, and DEV@cloud are trademarks of CloudBees, Inc. Most CloudBees products are commonly referred to by their short names — Accelerator, Automation Platform, Flow, Deploy, Foresight, Release, Insight, and eMake — throughout various types of CloudBees product-specific documentation. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Jenkins is a registered trademark of the non-profit Software in the Public Interest organization. Used with permission. See here for more info about the Jenkins project. The registered trademark Jenkins® is used pursuant to a sublicense from the Jenkins project and Software in the Public Interest, Inc. Read more at www.cloudbees.com/jenkins/about. Apache, Apache Ant, Apache Maven, Ant and Maven are trademarks of The Apache Software Foundation. Used with permission. No endorsement by The Apache Software Foundation is implied by the use of these marks.Other names may be trademarks of their respective owners. Many of the designations used by manufacturers and sellers to distinguish their products are claimed as trademarks. Where those designations appear in this content, and CloudBees was aware of a trademark claim, the designations have been printed in caps or initial caps. While every precaution has been taken in the preparation of this content, the publisher and authors assume no responsibility for errors or omissions, or for damages resulting from the use of the information contained herein.