PUT OneStop/Groups/{GroupID}/ScanSchedules
Update specified scan schedules
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupID | integer |
Required |
Body Parameters
ScanScheduleDetailDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ScanScheduleID | integer |
None. |
|
| GroupID | integer |
None. |
|
| ScheduleType |
0 for weekly schedule, 1 for monthly schedule |
integer |
None. |
| RunDays |
Days to run if weekly schedule. Simple string value containing numeric for each day, starting from 1 for Monday 124 would run on Monday, Tuesday and Thursday. Default if not set 12345 |
string |
None. |
| RunDate |
Date of month to run on if monthly schedule |
integer |
None. |
| RunTime |
Time of day to run schedule. Default if not set is random time between 9:30 and 16:30 |
date |
None. |
| Ranges |
IP ranges to check, in the form 192.168.100.1-192.168.100.255 Multiple ranges separated by CRLF |
string |
None. |
| Devices |
List of devices to check, separated by CRLF. Can be either IP address or hostname |
string |
None. |
| Description |
Description of scan schedule |
string |
None. |
| Excluded |
List of devices to exclude from discovery, separated by CRLF. Can be either IP address or hostname |
string |
None. |
| DestinationGroupID |
ID of group to add devices to if not the scan group. Must be a group under scan group |
integer |
None. |
| DiscoveryScheduleType |
0 for weekly schedule, 1 for monthly schedule |
integer |
None. |
| DiscoveryRunDays |
Days to run if weekly schedule. Simple string value containing numeric for each day, starting from 1 for Monday 124 would run on Monday, Tuesday and Thursday.Default if not set 12345 |
string |
None. |
| DiscoveryRunDate |
Date of month to run on if monthly schedule |
integer |
None. |
| DiscoveryRunTime |
Time of day to run schedule. Default if not set is random time between 9:30 and 16:30 |
date |
None. |
| SNMPVersion |
Version of SNMP to use 1,2 or 3 |
integer |
None. |
| SNMPv3SecurityLevel |
SNMP v3 Security level NoAuthNoPriv=0, AuthNoPriv=1, AuthPriv=2 |
integer |
None. |
| SNMPv3AuthenticationEncryption |
SNMP v3 Authentication Encryption MD5=0, SHA1=1 |
integer |
None. |
| SNMPv3PrivacyEncryption |
SNMP v3 Privacy Encryption DES=0, 3DES=1, AES=2 |
integer |
None. |
| SNMPv3UserName |
SNMP v3 User Name |
string |
None. |
| SNMPv3AuthenticationPassword |
SNMP v3 Authentication Password |
string |
None. |
| SNMPv3PrivacyPassword |
SNMP v3 Privacy Password |
string |
None. |
| SNMPv3ContextName |
SNMP v3 Context Name. Multiple names are supported, separated by a semicolon |
string |
None. |
| SNMPv3ContextNames |
SNMP v3 Context Name. Multiple names are supported, separated by a semicolon |
string |
None. |
| Community |
SNMP v1/v2 community name |
string |
None. |
| StatusCheckInterval |
Interval to check device status, in minutes |
integer |
None. |
| ConsumablesScanInterval |
Interval to check consumable status, in minutes |
integer |
None. |
| EnableDiscoverySchedule |
Whether discovery scan is run as a separate process from reading scan |
boolean |
None. |
Request Formats
application/json, text/json
{
"ScanScheduleID": 1,
"GroupID": 2,
"ScheduleType": 1,
"RunDays": "sample string 3",
"RunDate": 1,
"RunTime": "2026-07-07T14:50:16.3223676+01:00",
"Ranges": "sample string 4",
"Devices": "sample string 5",
"Description": "sample string 6",
"Excluded": "sample string 7",
"DestinationGroupID": 1,
"DiscoveryScheduleType": 1,
"DiscoveryRunDays": "sample string 8",
"DiscoveryRunDate": 1,
"DiscoveryRunTime": "2026-07-07T14:50:16.3223676+01:00",
"SNMPVersion": 1,
"SNMPv3SecurityLevel": 1,
"SNMPv3AuthenticationEncryption": 1,
"SNMPv3PrivacyEncryption": 1,
"SNMPv3UserName": "sample string 9",
"SNMPv3AuthenticationPassword": "sample string 10",
"SNMPv3PrivacyPassword": "sample string 11",
"SNMPv3ContextName": "sample string 12",
"SNMPv3ContextNames": "sample string 13",
"Community": "sample string 14",
"StatusCheckInterval": 1,
"ConsumablesScanInterval": 1,
"EnableDiscoverySchedule": true
}
application/xml, text/xml
<ScanScheduleDetailDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneStopWebAPI.DTO"> <Community>sample string 14</Community> <ConsumablesScanInterval>1</ConsumablesScanInterval> <Description>sample string 6</Description> <DestinationGroupID>1</DestinationGroupID> <Devices>sample string 5</Devices> <DiscoveryRunDate>1</DiscoveryRunDate> <DiscoveryRunDays>sample string 8</DiscoveryRunDays> <DiscoveryRunTime>2026-07-07T14:50:16.3223676+01:00</DiscoveryRunTime> <DiscoveryScheduleType>1</DiscoveryScheduleType> <EnableDiscoverySchedule>true</EnableDiscoverySchedule> <Excluded>sample string 7</Excluded> <GroupID>2</GroupID> <Ranges>sample string 4</Ranges> <RunDate>1</RunDate> <RunDays>sample string 3</RunDays> <RunTime>2026-07-07T14:50:16.3223676+01:00</RunTime> <SNMPVersion>1</SNMPVersion> <SNMPv3AuthenticationEncryption>1</SNMPv3AuthenticationEncryption> <SNMPv3AuthenticationPassword>sample string 10</SNMPv3AuthenticationPassword> <SNMPv3ContextName>sample string 12</SNMPv3ContextName> <SNMPv3ContextNames>sample string 13</SNMPv3ContextNames> <SNMPv3PrivacyEncryption>1</SNMPv3PrivacyEncryption> <SNMPv3PrivacyPassword>sample string 11</SNMPv3PrivacyPassword> <SNMPv3SecurityLevel>1</SNMPv3SecurityLevel> <SNMPv3UserName>sample string 9</SNMPv3UserName> <ScanScheduleID>1</ScanScheduleID> <ScheduleType>1</ScheduleType> <StatusCheckInterval>1</StatusCheckInterval> </ScanScheduleDetailDTO>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ScanScheduleDetailDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ScanScheduleID | integer |
None. |
|
| GroupID | integer |
None. |
|
| ScheduleType |
0 for weekly schedule, 1 for monthly schedule |
integer |
None. |
| RunDays |
Days to run if weekly schedule. Simple string value containing numeric for each day, starting from 1 for Monday 124 would run on Monday, Tuesday and Thursday. Default if not set 12345 |
string |
None. |
| RunDate |
Date of month to run on if monthly schedule |
integer |
None. |
| RunTime |
Time of day to run schedule. Default if not set is random time between 9:30 and 16:30 |
date |
None. |
| Ranges |
IP ranges to check, in the form 192.168.100.1-192.168.100.255 Multiple ranges separated by CRLF |
string |
None. |
| Devices |
List of devices to check, separated by CRLF. Can be either IP address or hostname |
string |
None. |
| Description |
Description of scan schedule |
string |
None. |
| Excluded |
List of devices to exclude from discovery, separated by CRLF. Can be either IP address or hostname |
string |
None. |
| DestinationGroupID |
ID of group to add devices to if not the scan group. Must be a group under scan group |
integer |
None. |
| DiscoveryScheduleType |
0 for weekly schedule, 1 for monthly schedule |
integer |
None. |
| DiscoveryRunDays |
Days to run if weekly schedule. Simple string value containing numeric for each day, starting from 1 for Monday 124 would run on Monday, Tuesday and Thursday.Default if not set 12345 |
string |
None. |
| DiscoveryRunDate |
Date of month to run on if monthly schedule |
integer |
None. |
| DiscoveryRunTime |
Time of day to run schedule. Default if not set is random time between 9:30 and 16:30 |
date |
None. |
| SNMPVersion |
Version of SNMP to use 1,2 or 3 |
integer |
None. |
| SNMPv3SecurityLevel |
SNMP v3 Security level NoAuthNoPriv=0, AuthNoPriv=1, AuthPriv=2 |
integer |
None. |
| SNMPv3AuthenticationEncryption |
SNMP v3 Authentication Encryption MD5=0, SHA1=1 |
integer |
None. |
| SNMPv3PrivacyEncryption |
SNMP v3 Privacy Encryption DES=0, 3DES=1, AES=2 |
integer |
None. |
| SNMPv3UserName |
SNMP v3 User Name |
string |
None. |
| SNMPv3AuthenticationPassword |
SNMP v3 Authentication Password |
string |
None. |
| SNMPv3PrivacyPassword |
SNMP v3 Privacy Password |
string |
None. |
| SNMPv3ContextName |
SNMP v3 Context Name. Multiple names are supported, separated by a semicolon |
string |
None. |
| SNMPv3ContextNames |
SNMP v3 Context Name. Multiple names are supported, separated by a semicolon |
string |
None. |
| Community |
SNMP v1/v2 community name |
string |
None. |
| StatusCheckInterval |
Interval to check device status, in minutes |
integer |
None. |
| ConsumablesScanInterval |
Interval to check consumable status, in minutes |
integer |
None. |
| EnableDiscoverySchedule |
Whether discovery scan is run as a separate process from reading scan |
boolean |
None. |
Response Formats
application/json, text/json
{
"ScanScheduleID": 1,
"GroupID": 2,
"ScheduleType": 1,
"RunDays": "sample string 3",
"RunDate": 1,
"RunTime": "2026-07-07T14:50:16.3223676+01:00",
"Ranges": "sample string 4",
"Devices": "sample string 5",
"Description": "sample string 6",
"Excluded": "sample string 7",
"DestinationGroupID": 1,
"DiscoveryScheduleType": 1,
"DiscoveryRunDays": "sample string 8",
"DiscoveryRunDate": 1,
"DiscoveryRunTime": "2026-07-07T14:50:16.3223676+01:00",
"SNMPVersion": 1,
"SNMPv3SecurityLevel": 1,
"SNMPv3AuthenticationEncryption": 1,
"SNMPv3PrivacyEncryption": 1,
"SNMPv3UserName": "sample string 9",
"SNMPv3AuthenticationPassword": "sample string 10",
"SNMPv3PrivacyPassword": "sample string 11",
"SNMPv3ContextName": "sample string 12",
"SNMPv3ContextNames": "sample string 13",
"Community": "sample string 14",
"StatusCheckInterval": 1,
"ConsumablesScanInterval": 1,
"EnableDiscoverySchedule": true
}
application/xml, text/xml
<ScanScheduleDetailDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneStopWebAPI.DTO"> <Community>sample string 14</Community> <ConsumablesScanInterval>1</ConsumablesScanInterval> <Description>sample string 6</Description> <DestinationGroupID>1</DestinationGroupID> <Devices>sample string 5</Devices> <DiscoveryRunDate>1</DiscoveryRunDate> <DiscoveryRunDays>sample string 8</DiscoveryRunDays> <DiscoveryRunTime>2026-07-07T14:50:16.3223676+01:00</DiscoveryRunTime> <DiscoveryScheduleType>1</DiscoveryScheduleType> <EnableDiscoverySchedule>true</EnableDiscoverySchedule> <Excluded>sample string 7</Excluded> <GroupID>2</GroupID> <Ranges>sample string 4</Ranges> <RunDate>1</RunDate> <RunDays>sample string 3</RunDays> <RunTime>2026-07-07T14:50:16.3223676+01:00</RunTime> <SNMPVersion>1</SNMPVersion> <SNMPv3AuthenticationEncryption>1</SNMPv3AuthenticationEncryption> <SNMPv3AuthenticationPassword>sample string 10</SNMPv3AuthenticationPassword> <SNMPv3ContextName>sample string 12</SNMPv3ContextName> <SNMPv3ContextNames>sample string 13</SNMPv3ContextNames> <SNMPv3PrivacyEncryption>1</SNMPv3PrivacyEncryption> <SNMPv3PrivacyPassword>sample string 11</SNMPv3PrivacyPassword> <SNMPv3SecurityLevel>1</SNMPv3SecurityLevel> <SNMPv3UserName>sample string 9</SNMPv3UserName> <ScanScheduleID>1</ScanScheduleID> <ScheduleType>1</ScheduleType> <StatusCheckInterval>1</StatusCheckInterval> </ScanScheduleDetailDTO>