Web Server Administration API

The administration API requests use a remote procedure call style that is structured as follows:

<Origin>/administration?method=<Method>

<Origin> = <Protocol>://<Domain>[:<Port>]

<Method> = Administration method name

The "administration" resource name is the default resource name for administration requests. The administration resource name is configurable in the web server. Please make sure that the resource name that you are using matches the proper resource name on the target web server.

Any content included with administration API requests, or returned as a response to the request, should/will be formatted as JSON content. The date/time format used in the JSON content is equivalent to a raw JavaScript Date value: an integer value representing the number of milliseconds since 1 January 1970 UTC.

Any forward slashes present in any JSON content returned as a response by the administration API will be escaped so that the JSON content can be included in HTML without issues.

Due to its size, the API reference for the server administration has been divided into several different topics:

Web Server Administration API - Privileges
Web Server Administration API - Roles
Web Server Administration API - Users
Web Server Administration API - Databases
Web Server Administration API - Modules
Web Server Administration API - Applications
Web Server Administration API - Files
Web Server Administration API - Status

More Support Options

Support Forums

Frequently Asked Questions

Technical Bulletins

Technical Articles

Incident Reports

Roadmap