Spring Cloud Skipper provides a REST API allowing you to access all aspects of the server. In fact the Spring Cloud Skipper Shell is a first-class consumer of that API.
Spring Cloud Skipper tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs.
| Verb | Usage |
|---|---|
| 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.
| Status code | Usage |
|---|---|
| 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 |
Every response has the following header(s):
| Name | Description |
|---|---|
| The Content-Type of the payload, e.g. |
| Path | Type | Description |
|---|---|---|
|
| 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 Skipper 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.