Installation instructions

The Revive Adserver REST API is very simple to install. The complete package is located in one folder. The package is an integrated part of the Revive Adserver architecture, but does not require integration by means of the Revive Adserver plugin architecture. The main reason for this is simplicity, the whole package can be dropped into any Revive Adserver instance simply by copying one folder.

When you want to install your module you should do the following:

  • When you purchase the software, you receive a zipped file
  • Copy or upload this zipped file to the root of your Revive Adserver folder, and unzip it.
  • A new folder will be created in the location /www/api/rest_v1. This folder contains the full package.
  • Test the the API by opening your browser and entering this URL (which should retrieve the details for the agency with ID 1 that was created during the installation of the Revive Adserver software:

You should get an authentication request first. Enter the same username and password that you normally use to login on your Revive Adserver instance.


Authentication is an integrated part of the Revive Adserver REST API package. All users within your Revive Adserver instance have the same permissions when using the API.

Apache rewrite instructions

It is recommended to create a rewrite rule for your Apache web server, in order to have better formatted URLs.
One of the suggestions for the rewrite rule would be:

RewriteEngine on
RewriteRule ^(.*)/rest/$  /www/api/rest_v1/rest.php?rest=$2	[L]

This rule would allow you to use API calls with a URL like http://[your_revive_domain]/rest/bnn/1

Nginx rewrite instructions

If you have an Nginx web server, here is some input to make a rewrite rule:

location / {
rewrite ^/(.*)/rest/$ /www/api/rest_v1/rest.php?rest=$2 break;

Current version

The most recently released version of the Revive Adserver REST API is v5.2.0 (publication date April 18, 2024).

See Release Notes


Revive Adserver REST API is compatible with all versions of Revive Adserver v4.x, and v5.x. It may also be compatible with Revive Adserver v3.x (and also with OpenX Source v2.8 and higher), but this can not be guaranteed.

Revive Adserver REST API is compatible with all supported versions of PHP, including PHP 7 and PHP  8.

Also see Technical Requirements, Product Content, and Installation Instructions.