Troubleshoot REST API

Changing the maximum number of tasks per page

You can change the maximum number of results per page by updating the xl.rest.api.maxPageSize 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:

    xl.rest.api.maxPageSize = custom_positive_integer
  • If the XL_DEPLOY_SERVER_HOME/conf/xl-deploy.conf configuration file is present in your XL Deploy installation and the xl { } section is defined, append this inside:

    rest {
    api {
      maxPageSize = custom_positive_integer
    }
    }  

    Note: You must restart your XL 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 xl.rest.api.maxPageSize defaults to 1000 as it is pre-configured inside the XL 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.

In order to change the server timeout value, you must add the following to your XL_DEPLOY_SERVER_HOME/conf/reference.conf file. See File placeholders for more information.

xl {
    server-extension {
        timeout = 120 seconds
    }
}

Important: You must restart the XL Deploy server once you have added the information to reference.conf.

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".