REST API for Managing MaxScale

Overview

The REST API in MaxScale should be implement as a HTTP based administrative interface that manages resources in MaxScale in a stateless (i.e. RESTful) manner. This allows transactional communication with MaxScale.

Requirements

The API should implement the API documented in the MaxScale REST API documentation.

Implementation details

The current resources closely follow the maxadmin output of the previous versions.

Currently, all object references, e.g. servers in services, are expressed as relative pathnames. This means that nested resources in services, filters and monitors need to be queried separately. The required linkage of the nested resources could be done inside MaxScale so that only one query is needed to fully display an object.

The layout of the resources follow the JSON API specification: http://jsonapi.org/