Help documentation

Cruise API

Introduction

RESTful APIs offer a convenient way to integrate networked systems. Cruise provides a RESTful API through which you can access and manipulate various kinds of resources. Artifacts, Properties and configurations are the kinds of resources that are available in this version of the API. The following sections will walk you through the various resources and the operations that are supported on each of them

Cruise API features

The Cruise API provides access to various kinds of resources in Cruise over HTTP. The standard HTTP operation of GET, POST and PUT and DELETE are used to support read, create and upload operations on them. Hence performing a GET operation for Artifacts would be the equivalent of getting that resource, performing a PUT would be the equivalent of updating that artifact; and so on.

Main APIs

The Cruise API documented here is a work in progress. Future versions may change this API.

Cruise's main APIs are listed below: