OSv REST API

Ron edited this page Jun 16, 2015 · 4 revisions
Clone this wiki locally

On a cloud environment of multiple instances, interacting with each instance via GUI or CLI is non efficient. Instead OS operations should allows easy automation.

OSv REST API allows such remote automation. Just run OSv with --api flag as follow:

./scripts/run.py --api

This flag take care of port forwarding, so you can access the API using http://localhost:8000/

Now you can use the API directly, or access it using GUI. Direct access example

curl http://localhost:8000/os/version

For an interactive API GUI, base on Swagger, point your browser to http://localhost:8000/

Off line version of the latest API is here