This operation modifies the log file level, version, and size.
Request
Syntax
POST <webservice>/Client/{clientId>/Log/{LogFileName} Host: <host name> Content-Type: application/json Accept: application/json Authtoken: <authentication token> <modify_log_file_properties.json>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
|
Name |
Description |
Required |
|---|---|---|
|
clientId |
The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it. |
Yes-for the request by ID |
|
LogFileName |
The name of the log file. For example, enter WebConsole, for the WebConsole.log file in the Commserver/WebConsole location. |
Yes |
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or Web Console used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
|
Content-type |
The format of the body of the request. Valid values are: application/xml or application/json. |
Request Body
Download the JSON file modify_log_file_properties.json or the XML file modify_log_file_properties.xml required for this request: . The following table displays the parameters for the request body.
|
Parameters |
Description |
Elements |
|---|---|---|
|
fileSizeInMB |
The size in MB for the log file. The software automatically creates a new log file when the file reaches the size specified. |
App_LogFileProperties |
|
fileVersions |
The number of versions that the software can maintain for the log file. The software automatically prunes old log files when the file versions that the software creates reaches the number specified. |
App_LogFileProperties |
|
debugLevel |
The debug level for the logs. |
App_LogFileProperties |
Response
Supported Status Codes
|
Code |
Status |
Description |
|---|---|---|
|
200 |
Success |
Log file properties are successfully modified. |
Examples
Sample Request
POST <webservice>/Client/2/Logs/cvfwd
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-Type: application/json
{
"fileSizeInMB": 6,
"fileVersions": 5,
"debugLevel": 2
}'
Sample Response
Response status code : 200
Response body : {'response': {}}