This URL updates the botnet automatic download configuration.
Resource URL
PUT /autoupdateconfiguration/botnetdownloadconfig
Request Parameters
URL Parameters:
None
Payload Parameters:
Field Name | Description | Data Type |
|---|---|---|
| Whether the automatic download is enabled | Boolean |
| Schedule for the update. Values can be following:
| String |
| Time when the update should start. It should be in hh:mm format. | String |
| Time when the update should start. It should be in hh:mm format. | String |
| The recurring duration | String |
Response Parameters
Following fields are returned if the request parameters are correct, otherwise error details are returned.
Field Name | Description | Data Type |
|---|---|---|
| Set to 1 if the operation was successful | Number |
Example
Request
PUT https://<NSM_IP>/sdkapi/autoupdateconfiguration/botnetdownloadconfig
Payload
{
"enableDownload": true,
"schedule": "FREQUENTLY",
"startTime": "0:0",
"endTime": "23:0",
"recur": "10 Hr"
}
Response
{
"status": 1
}
Error Information
Following error codes are returned by this URL:
No | HTTP Error Code | SDK API errorId | SDK API errorMessage |
|---|---|---|---|
1 | 400 | 6101 | Invalid time format... Time is mandatory and should be in hh:mm format |
2 | 400 | 6102 | Hour should be between 0 and 23 |
3 | 400 | 6103 | Minute should be between 0 and 55 and multiples of 5 |
4 | 400 | 6104 | For frequently: duration should end with Min or Hr... If hr then 1 to 10 and 12 is allowed... If min then 10 15 30 & 45 are allowed... |
5 | 400 | 6105 | For weekly: duration should be name of the days like SUNDAY,MONDAY,etc. |
6 | 400 | 6106 | Schedule should be one of the following: FREQUENTLY, DAILY & WEEKLY |
7 | 400 | 6107 | Recur value is mandatory when schedule is FREQUENTLY or WEEKLY |
8 | 400 | 6108 | Update to Sensor failed |