Lightbits REST API Overview

You can configure and manage the Lightbits cluster with a standard REST API developed by Lightbits.

This section includes several examples of how to use common management commands via REST API using a web interface and the Linux “curl” utility to send and receive data with the REST API methods:

• GET
• CREATE
• DELETE

REST API Syntax

The following example shows how the Linux curl utility is used in this document to provide REST API usage examples:

curl -X <REST API VERB> http://<IP of LightOS Node>:<TCP PORT#>/api/v2/<command>

You can use any of the cluster node’s IP addresses (not necessarily the node affected by the command).

Using REST API Commands (curl Examples)

If you use the REST API GET method, the Lightbits management service returns the data in JSON format.