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/diagnostics/settings

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Diagnostics::getRequestLogSettings

Definitions Expand All | Collapse All

RequestLogs

Request logs

apiRequestLogging string

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

apiRequestLogMaxEntries string

Specifies the maximum number of API requests to log.

apiRequestLogRemainingEntries string

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

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

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>