Troubleshoot REST API

Changing the maximum number of tasks per page

You can change the maximum number of results per page by updating the parameter.

To change the maximum page size:

  • If XL_DEPLOY_SERVER_HOME/conf/xl-deploy.conf was added as a configuration file, append the file with the following: = custom_positive_integer
  • If the XL_DEPLOY_SERVER_HOME/conf/xl-deploy.conf configuration file is present in your Deploy installation and the xl { } section is defined, append this inside:

    rest {
    api {
      maxPageSize = custom_positive_integer

    Note: You must restart your Deploy server after modifying the xl-deploy.conf file for the changes to be picked up.

Important: If none of the settings above are applied, the defaults to 1000 as it is pre-configured inside the Deploy server.

Increase server timeout settings for custom rest endpoints.

The default server timeout value for requests is 60 seconds. However, in some scenarios you may want to increase the value.

To change the server timeout value, you must do the following:

  1. Open XL_DEPLOY_SERVER_HOME/conf/xl-deploy.conf
  2. Add the new timeout value:

    xl {
    server-extension {
        file = "xl-rest-endpoints.xml"
        timeout = 120 seconds
        rootPath = "/api"
        scriptsPathPrefix = "/extension"

Important: You must restart the Deploy server once you have added the information to the xl-deploy.conf file.

Note: Increasing the timeout value may also help if you encounter messages such as “The server was not able to produce a timely response to your request”.