RESTful Management API Resources

The RESTful Management API supports JSON data format. The format is specified using standard mime-types. The client should use the Accept header to specify the format that it wishes to receive. The Content-Type header specifies the mime-type of the request's or response's content.

The RESTful Management API can be accessed in two ways:

• Locally over HTTP
  Use the base URL http://127.0.0.1:10080/

• Externally over HTTPS
  The https interface is provided by the lighttpd service acting as proxy.
  Use https://<ipaddress>:10443/
  The https service uses http basic authentication and defines a single user "admin" with the password "admin".

PowerMedia XMS has two modes of operation, Native and MSML. The resources provided by the RESTful Management API will differ between these modes. For example, when in MSML mode, the Routing, Tones, MRCP Client and VXML resources are not available.

The table below lists all available resources, their sub-resources, valid HTTP methods that may be used with them and XMS modes for which they are valid.

Clicking on the resource or sub-resource will:

• Provide its definition

• Provide valid values for the parameters that can be set

• Define how each valid method affects the resource

• Give an example of a request and a response payload