OneFlow Server API

The OpenNebula OneFlow API is a RESTful service to create, control and monitor services composed of interconnected Virtual Machines (VMs) with deployment dependencies among them. Each group of VMs is deployed and managed as a single entity, and it is completely integrated with the advanced OpenNebula user and group management. There are two kinds of resources: service templates and services. All data is sent and received as JSON.

This guide is intended for developers. The OpenNebula distribution includes a CLI to interact with OneFlow and it is also fully integrated in the Sunstone GUI.

API Authentication

User authentication is based on HTTP Basic access authentication. The required credentials are the username and password.

$ curl -u "username:password" https://oneflow.example.server:2474

By default, OneFlow API listens at http://localhost:2474. Customize this value along with other API service settings in the /etc/one/oneflow-server.conf file. For more information, refer to the OneFlow Configuration Guide.

API Methods

Base URL: oneflow.example.server