Parameter: requestTimeout

Applies to

Applies to: latest

Applies to: stream

Applies to: history

Value

Single positive integer (number of milliseconds)

Related

Parameter: dateFormat

Applies to: history

Parameter: descending

Parameter: format

Parameter: inline

Parameter: showMessage

Parameter: verifyLinks

Use this parameter if the client application needs to terminate a slow response quicker than the default 5-minute timeout applied on the REST API. Use of this parameter can reduce the number of parallel threads open on the REST API server, avoiding certain cases where the REST API would respond with HTTP 429 TOO_MANY_REQUESTS.

Important: requestTimeout is an instruction to the REST API server to terminate any threads associated with the request. If the timeout occurs during the streaming of a response, the returned data structure will be truncated and not valid. In addition, the data might be returned with a HTTP 200 code if the return code has been sent before the timeout was triggered. Client logic related to the timeout should be based on the elapsed time and not on the (potentially fragmentary) response from the REST API server.

Back to help overview