The Multi-Tenant LoadMaster API works in a RESTful manner, allowing a user or application to pass HTTPS requests to the Multi-Tenant LoadMaster. The Multi-Tenant LoadMaster answers the request with a JavaScript Object Notation (JSON) formatted response. The HTTPS request needs to be in the following format:

https://<Username>:<Password>@<MTIPAddress>/api/<Command>?<Parameter>=<Value>

The basic interface is a simple HTTPS GET operation where the command is specified by the URL. If any parameters are required by the operation, they are passed as QUERY parameters.

The following points should be noted regarding the formatting of the HTTPS request:

  • Only one command can be given at a time.
  • The ‘?’ character signifies the end of a command.
  • The ‘&’ character signifies the end of a parameter/value pair.
  • If there are any unnecessary parameter/value pairs, they will be ignored.
  • The order in which the parameter/value pairs appear does not matter.
  • There cannot be any spaces within the query. Although some applications, like browsers, would convert spaces to HTML code prior to sending the string to the Multi-Tenant LoadMaster.