API client settings

When setting up or editing an API client, you can configure the following client-specific settings.

Setting	Description	Notes
Client rate limit	Set the maximum query complexity cost per minute for this client.	If this value exceeds the value set for the Client rate limit set at the site level, then the site-level limit will be used instead.
Token expiration	This sets the length of time access tokens will be valid before expiring.	The default length of time is 1 day. Changing this setting only impacts new tokens; any existing tokens will continue to honour the expiry time set at the time of their creation.
Error response	This setting determines how much information will be provided in API responses when errors occur for this client. Select one of the following options: Site default (X): This client will use the option selected for Default error response in the site-wide API settings 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	By default, clients will use the Site default (X) option. If the Default error response setting is changed at the site level, all clients using the Site default (X) option will start using the selected option.

Setting

Description

Notes

Client rate limit

Set the maximum query complexity cost per minute for this client.

If this value exceeds the value set for the Client rate limit set at the site level, then the site-level limit will be used instead.

Token expiration

This sets the length of time access tokens will be valid before expiring.

The default length of time is 1 day.

Changing this setting only impacts new tokens; any existing tokens will continue to honour the expiry time set at the time of their creation.

Error response

This setting determines how much information will be provided in API responses when errors occur for this client. Select one of the following options:

Site default (X): This client will use the option selected for Default error response in the site-wide API settings
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

By default, clients will use the Site default (X) option. If the Default error response setting is changed at the site level, all clients using the Site default (X) option will start using the selected option.

Join the Totara Community for more resources to help you get the most out of Totara.