Troubleshoot REST API

This page describes common REST API errors and their solutions.

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/centralConfiguration/deploy-server.yaml was added as a configuration file, append the file with the following:

  deploy.server.rest.api.maxPageSize : custom_positive_integer
• If the XL_DEPLOY_SERVER_HOME/centralConfiguration/deploy-server.yaml 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 deploy-server.yaml file for the changes to be picked up.

Important: If none of the settings above are applied, the deploy.server.rest.api.maxPageSize 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/centralConfiguration/deploy-server.yaml
2. Add the new timeout value:

    extensions:
      server:
        file: xl-rest-endpoints.xml
        rootPath: /api
        scriptsPathPrefix: /extension
        timeout: 120 seconds

Important: You must restart the Deploy server once you have added the information to the deploy-server.yaml 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".