Jedox OLAP HTTP API and Server Browser

Jedox OLAP server (In-Memory DB) offers a RESTful API and communicates with clients using the HTTP 1.1 protocol. Clients send requests using this API, and the server sends a response in an easily parsable CSV format.

The interface[s] and port[s] through which the Jedox OLAP server listens to all incoming requests is configured in the configuration file palo.ini, with an entry in the following format:

http "<server-address>" <port>

Here, <server-address> is the network interface via by which the Jedox OLAP server is accessed, and <port> is a network port. It is possible to specify several listening interfaces; however, a unique port must be specified for each entry.

The full documentation for the Jedox OLAP's HTTP API is accessible by opening the address http://<server-address>:<port>/api in a web browser.

Server Browser

The Jedox OLAP Server also offers the Server Browser: a lightweight web browser interface for inspecting server objects, especially database contents. By default, this interface is not enabled. To enable it, an additional entry is required in palo.ini in the following form:

admin "<server-address>" <port>

where <server-address> is the network interface by which the Jedox OLAP Server Browser is accessed; this can be the same interface as used for another HTTP entry. <port> is a network port, and it must be different from any other port used for the Jedox OLAP Server's HTTP interface. For example, if HTTP for Jedox OLAP is configured on port 7777, the port for admin interface could be set to 7778.

After restarting Jedox OLAP Server, the server browser can be accessed in a web browser at http://<server-address>:<port>/browser.

Important note: the admin interface is now protected with a username and password. Once accessed, the user has full control and can delete databases, cubes, dimensions, etc. Thus, it should only be enabled for debugging purposes.

Over the Admin interface and the HTTP API of Jedox, the server can be controlled and data can be retrieved from other computers as well as from the server itself, even without an Excel client installed. In this case, you have to enter the server IP address followed by the port number in your browser. For example, for access to the server itself, you would enter "http://127.0.0.1:7778/" or "http://localhost:7778/".

There you find the start page of the API:

You can use the server browser for administration of the databases via a browser. For example, you can delete a database via the browser.

Click on a database to see an overview of its cubes and dimensions. You can also find the API documentation on the website.

The access from other computers to the API is made possible in a similar way to the access for Excel clients.

The entry

admin "192.168.2.100" 7778

would allow access over the URL http://192.168.2.100:7778/

The entry

admin "" 7778

would allow access over all IP addresses of the computer, including "http://localhost:7778/".

Updated June 5, 2023