Skip to content

Latest commit

 

History

History
118 lines (87 loc) · 4.04 KB

overview.md

File metadata and controls

118 lines (87 loc) · 4.04 KB
Raw

VirtShell V1

A REST based virtualization service.

The sections below document the behavior of the API in detail.

Output and Input Format

The API supports only JSON format, and requesting any output format other than application/json via the accept header will result in a 406 Content Not Acceptable error.

Errors

Here is a list of error codes that may result from a query to this API on any resource.

  • 400 Bad Request The request could not be processed successfully because the request URI was invalid. The response body will contain a reason for the failure. This response indicates permanent error, and the request should not be retried without fixing the error as indicated.

  • 403 Forbidden The request could not be processed successfully because the requesting user identity did not have sufficient access to process the request. This response indicates permanent error, and the request should not be retried without fixing the error as indicated.

  • 406 Content Not Acceptable The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. This response indicates permanent error, and the request should not be retried without specifying a supported output format. Responses of this type do not contain a response body due to the inability of the server to encode one.

  • 404 Not Found The request could not be processed successfully because the request URI was invalid. Most likely this is because the identifier was not found. This response indicates permanent error, and the request should not be retried without fixing the error as indicated.

  • 500 Server Error The request could not be processed because the server encountered an unexpected condition which prevented it from fulfilling the request.

  • 501 Not Implemented The request could not be completed because the server either does not recognise the request method or the resource requested does not exist.

Error responses other than 406 Content Not Acceptable contain a JSON response containing a brief message explaining the error in further detail. For example, a query to POST /api/virtsh/v1/instance with a body of {} would result in the following response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{"error": "Missing input for create instance"}

API Resources

Below is a list of resources provided by this API. Click on the heading for more details.

API Calls

Below is a list of API calls don't represent directly a resource.