Chilkat Online Tools

Xojo / DocuSign eSignature REST API / Enables or disables API request logging for troubleshooting.

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "apiRequestLogging": "sample string 1",
//   "apiRequestLogMaxEntries": "sample string 2",
//   "apiRequestLogRemainingEntries": "sample string 3"
// }

Dim json As New Chilkat.JsonObject
success = json.UpdateString("apiRequestLogging","sample string 1")
success = json.UpdateString("apiRequestLogMaxEntries","sample string 2")
success = json.UpdateString("apiRequestLogRemainingEntries","sample string 3")

// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = "{{accessToken}}"
http.SetRequestHeader "Accept","application/json"

Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)

Dim resp As Chilkat.HttpResponse
resp = http.PTextSb("PUT","https://domain.com/v2.1/diagnostics/settings",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

System.DebugLog(Str(resp.StatusCode))
System.DebugLog(resp.BodyStr)

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "apiRequestLogging": "sample string 1",
  "apiRequestLogMaxEntries": "sample string 2",
  "apiRequestLogRemainingEntries": "sample string 3"
}'
https://domain.com/v2.1/diagnostics/settings

Postman Collection Item JSON

{
  "name": "Enables or disables API request logging for troubleshooting.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"apiRequestLogging\": \"sample string 1\",\n  \"apiRequestLogMaxEntries\": \"sample string 2\",\n  \"apiRequestLogRemainingEntries\": \"sample string 3\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/diagnostics/settings",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "diagnostics",
        "settings"
      ]
    },
    "description": "Enables or disables API request logging for troubleshooting.\n\nWhen enabled (`apiRequestLogging` is set to 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.\n\nYou can call [ML:GetRequestLog] or [ML:GetRequestLogs] to download the log files (individually or as a zip file). Call [ML:DeleteRequestLogs] to clear the log by deleting current entries.\n\nPrivate information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log.\n\n###### Note: API request logging only captures requests from the authenticated user. Any call that does not authenticate the user and resolve a userId isn't logged. Meaning that login_information, NewAccounts, or other distributor-credential calls are not logged.\n"
  },
  "response": [
  ]
}