Enables or disables API request logging for troubleshooting
Enables or disables API request logging for troubleshooting.
When enabled (apiRequestLogging is true),
REST API requests and responses for the user are added to a log.
A log can have up to 50 requests/responses
and the current number of log entries can be determined
by getting the settings.
Logging is automatically disabled when the log limit of 50 is reached.
You can call Diagnostics: getRequestLog or Diagnostics: listRequestLogs to download the log files (individually or as a zip file). Call Diagnostics: deleteRequestLogs to clear the log by deleting current entries.
Private information, such as passwords and integration key information, which is normally located in the call header is omitted from the request/response log.
API request logging only captures requests from the authenticated user. Any call that does not authenticate the user and resolve a userId is not logged.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Request Body
application/json
When true, enables API request logging for the user.
Specifies the maximum number of API requests to log.
Indicates the remaining number of API requests that can be logged.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v2.1/diagnostics/settings" \ -H "Content-Type: application/json" \ -d '{}'{ "apiRequestLogging": "string", "apiRequestLogMaxEntries": "string", "apiRequestLogRemainingEntries": "string"}Gets the API request logging settings GET
Retrieves the current API request logging setting for the user and remaining log entries. **Response** The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.
Lists resources for REST version specified GET
Retrieves the base resources available for the eSignature REST API. You do not need an integrator key to view the REST API versions and resources.