Spring Cloud Data Flow provides a REST API allowing you to access all aspects of the server. In fact the Spring Cloud Data Flow Shell is a first-class consumer of that API.
If you plan on using the REST API using Java, please also consider using the provided Java client (DataflowTemplate) that uses the REST API internally.
Spring Cloud Data Flow tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs.
Used to retrieve a resource
Used to create a new resource
Used to update an existing resource, including partial updates. Also used for
resources that imply the concept of
Used to delete an existing resource
RESTful note tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.
The request completed successfully
A new resource has been created successfully. The resource’s URI is available from the response’s
An update to an existing resource has been applied successfully
The request was malformed. The response body will include an error providing further information
The requested resource did not exist
The requested resource already exists, e.g. the task already exists or the stream was already being deployed
Returned in cases the Job Execution cannot be stopped or restarted
Every response has the following header(s):
The Content-Type of the payload, e.g.
The HTTP error that occurred, e.g.
A description of the cause of the error
The path to which the request was made
The HTTP status code, e.g.
The time, in milliseconds, at which the error occurred
Spring Cloud Data Flow uses hypermedia and resources include links to other resources
in their responses. Responses are in Hypertext Application from resource to resource Language (HAL) format. Links can be found beneath the
_links key. Users of the API should not create URIs themselves, instead they should use the above-described links to navigate.