API settings

Updated on 29 Nov 2022
1 minute to read

Article summary

Did you find this summary helpful?

Thank you for your feedback

The API has a number of configuration settings that control its behaviour at the site level. Site Administrators can configure the general API settings for your site by navigating to Quick-access menu > Development > API > API settings.

Only users with the totara/api:managesettings capability are able to configure API settings at the site level. By default this includes Site Administrators and Site Managers. Tenant users will be limited to making changes at the client level.

The table below describes the API settings that can be defined at the site level. Some settings can also be configured at the individual client level.

For more information about rate limits and query complexity, please see the developer documentation.

Setting	Description	Notes
Site rate limit	Set the maximum query complexity cost for all clients per minute.	The default value is 500,000.
Client rate limit	Set the maximum query complexity cost per minute for a single client.	You can configure this limit for individual clients by editing their settings. The default value is 250,000.
Maximum query complexity	Set the maximum complexity allowed for a single query.	The default value is 6,000.
Maximum query depth	Set the maximum depth allowed for a single query.	The default value is 15.
Default token expiration	This sets the default length of time tokens will be valid when adding new API clients. Use the two dropdown menus to set the value and the unit of time (e.g. hours, days, weeks).	You can configure the token expiry for each client by editing their settings. The default length of time is 24 hours.
Default error response	This setting determines how much information will be provided in API responses when errors occur. Select one of the following options: None: API responses will not return any specific information about the error Normal: API responses will return specific information about why the error occurred Developer: API responses will return specific information about why the error occurred, including a full stack trace	The default option is Normal.

Join the Totara Community for more resources to help you get the most out of Totara. You can also book a call to have a chat about your Totara platform with a dedicated Customer Success Manager.

Was this article helpful?

What's Next

API client settings

Follow us

If you have any questions or feedback about the Totara documentation, please contact documentation@totara.com.

To report a customer security issue, please contact our Security Team via security@totara.com. If you are a TotaraGov customer with a security issue, please contact our Public Sector Security Team via security@totaraclouddirect.com.

© Copyright 2024 Totara Learning Solutions. All rights reserved. Some content originally obtained via GPLv3 license and continues to be available under GPLv3. All other content is the sole copyright of Totara Learning Solutions.