Tools and Methods

The REST API is the management interface that allows configuration of the object model state. Configuration changes coming through the GUI or the SDK are written by the REST API. The REST API can be used to manipulate the object model state and retrieve information. such as events and statistics. It can be used to manage an tenants, MSP partner, and MSP administration.

You can use any language or library that can submit REST API requests and process JSON. Examples of languages and libraries that have been used to build REST API clients include:

For Java, the Jersey library provides the reference implementation of JAX-RS, a Java standard for RESTful web services. The implementation includes a client library that can run directly on the JVM.
For Python, the Requests and JSON libraries facilitate REST API applications.
For .Net, the core language provides facilities for submitting HTTP requests and .Net libraries include a serializer for JSON.
For Linux shell, Wget and curl can execute REST API calls. Linux shell utilities, like awk and grep, can parse and process JSON.

You can explore the REST API interactively using tools like the Postman plug-in for Chrome.

The API uses a resource manager model. Each resource manager contains data types that have information that can be retrieved and manipulated. In some cases, manipulation or configuration is not allowed and only the GET operation is supported.

The supported CRUD methods (operations) that are available depend on the object. You can find out which methods are supported for each resource manager by looking at the REST API Documentation GUI and selecting a resource manager.

Generally, the supported methods are:

CRUD Method	Description
GET	Gets information
DELETE	Deletes information
POST	Creates an entry
PUT	Updates an entry

Tools and Methods

More Information