RequestLogs: getSettings

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.

Request

HTTP request

GET /v2.1/diagnostics/settings

Parameters

Parameter NameValueDescription

Responses

CodeDescriptionReference
200

Successful response.

RequestLogs
400

Error encountered.

errorDetails

SDK Method

Diagnostics::getRequestLogSettings

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

RequestLogs

Request logs

apiRequestLoggingstring

When set to true, enables API request logging for the user.

apiRequestLogMaxEntriesstring

Specifies the maximum number of API requests to log.

apiRequestLogRemainingEntriesstring

Indicates the remaining number of API requests that can be logged.

Examples

Generic JSON Response

Response
{
  "apiRequestLogging": "sample string 1",
  "apiRequestLogMaxEntries": "sample string 2",
  "apiRequestLogRemainingEntries": "sample string 3"
}
Generic XML Response

Response
<diagnosticsSettingsInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <apiRequestLogMaxEntries>sample string 2</apiRequestLogMaxEntries>
  <apiRequestLogRemainingEntries>sample string 3</apiRequestLogRemainingEntries>
  <apiRequestLogging>sample string 1</apiRequestLogging>
</diagnosticsSettingsInformation> 
}} />