OneForm Server API

The OpenNebula OneForm API is a RESTful service designed to register, configure, and orchestrate infrastructure provisioning workflows across multiple Providers. It enables users to define and create Providers and launch full provisioning cycles, each consisting of one or more cloud resources such as Hosts, networks, and datastores. All data is sent and received in JSON format.

This guide is intended for developers and integrators. For other purposes, OneForm is accessible via its own OneForm Command Line Interface.

API Authentication

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

curl -u "username:password" https://oneform.example.server/api/v1

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

API Methods

Base URL: oneform.example.server/api/v1