API Reference

This is a set of reference guides containing the full formal description of the Application Programming Interface (API) and other components that system integrators use to integrate the platform services, 3rd party systems, and cloud applications via the APS ecosystem.


The platform, APS API, the user panels, and the APS tools have all changed their versions many times. The newer versions are backward compatible with the older ones, for example:

  • An APS application that functions in the platform version 7.4 will also function in the newer versions (8.0 and so on) of the platform without any updates to the application.

  • If an APS package was built successfully using the APS tools version 2.1, the same package will be successfully created using the newer APS tools, that is, version 2.2 and higher.


Forward compatibility is not supported. For example, if the aps build tool version 2.2 builds successfully an APS package from a project, this does not guarantee that the aps build tool version 2.1 can do the same.

Although the APS JavaScript framework is an internal component of the platform, its version differs from the platform version. The APS tools and APS PHP runtime are external components with their own versioning.

Version Identification

Platform and APS

To identify the version of the platform and APS follow these steps.

  1. Log in to the Provider Control Panel (PCP).

  2. Navigate to System > Information.

  3. In the Current build information section, find the Version of the platform.

  4. Identify the APS API version by sending a GET request from an APS application instance to the APS controller with the /aps path in the URL. This is how the APS PHP framework identifies the APS version on the backend.

  5. Get the full version of APS JavaScript framework by addressing your web browser to https://docs.cloudblue.com/oa/<platform-version>/sdk/aps/2/ui/runtime/version.html.

APS Tools

If you have the APS command line tools installed on your computer, run the following command to identify the tools version:

$ aps help

PHP Runtime

On an endpoint Linux host, identify the installed APS PHP runtime version using the standard RPM request:

# rpm -q aps-php-runtime

On any other OS, do it in two steps:

  1. Prepare a PHP file, for example, version.php:

    require_once 'aps/2/rest.php';
  2. Execute the script in the command line:

    $ php version.php

    This prints out the APS PHP runtime version.