summaryrefslogtreecommitdiffstats
path: root/cyborg_enhancement/mitaka_version/cyborg/doc/source/userdoc/api.rst
blob: 982a4d1231ea0642f2046b9d3f625ac37cb392c6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Cyborg REST API v1.0
********************

General Information
===================

This document describes the basic REST API operation that Cyborg supports
for Pike release.

+--------+-----------------------+-------------------------------------------------------------------------------+
| Verb   | URI                   | Description                                                                   |
+========+=======================+===============================================================================+
| GET    | /accelerators         | Return a list of accelerators                                                 |
+--------+-----------------------+-------------------------------------------------------------------------------+
| GET    | /accelerators/{uuid}  | Retrieve a certain accelerator info identified by `{uuid}`                    |
+--------+-----------------------+-------------------------------------------------------------------------------+
| POST   | /accelerators         | Create a new accelerator.                                                     |
+--------+-----------------------+-------------------------------------------------------------------------------+
| PUT    | /accelerators/{uuid}  | Update the spec for the accelerator identified by `{uuid}`                    |
+--------+-----------------------+-------------------------------------------------------------------------------+
| DELETE | /accelerators/{uuid}  | Delete the accelerator identified by `{uuid}`                                 |
+--------+-----------------------+-------------------------------------------------------------------------------+