GET OneStop/Groups/{GroupID}/ScanSettings
Gets general scan settings for specified group
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ScanSettingsDetailDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ScanSettingsID | integer |
None. |
|
| GroupID | integer |
None. |
|
| TimeOut | integer |
None. |
|
| ProxyServer |
Proxy server address |
string |
None. |
| ProxyPort |
Proxy server port |
integer |
None. |
| ProxyUser |
Proxy server user name |
string |
None. |
| ProxyPassword |
Proxy server password. Always blank when retrieved. |
string |
None. |
| UseProxy |
Whether to use proxy server |
boolean |
None. |
| LastScanTime |
Time last meter scan received |
date |
Read Only |
| LastStatusTime |
Time last status scan received |
date |
Read Only |
| LastConsumableTime |
Time last consumable scan received |
date |
Read Only |
| LastHeartBeatTime |
Time last heartbeat received |
date |
Read Only |
| LastUpdateTime |
Time last any communication received |
date |
Read Only |
| HeartBeat |
How often (in minutes) heartbeat is sent |
integer |
None. |
| Version |
Current agent version |
string |
Read Only |
| LinkKey |
Unique key used by agent when requesting new configuration |
string |
Read Only |
| AllowClientUpdate |
Whether settings changed at client can be uploaded to server |
boolean |
None. |
| AllowAutoConfigUpdate |
Whether agent will automatically check for new configuration |
boolean |
None. |
| AllowAutoAgentUpdate |
Whether agent will automatically check for new version |
boolean |
None. |
| AutoUpdateInterval |
How often (in minutes) agent will check for new config / agent |
integer |
None. |
| TransferSecurityLevel | integer |
None. |
|
| AgentPublicIPAddress |
Public IP address of agent |
string |
Read Only |
| AgentComputer |
Name of computer agent installed on |
string |
Read Only |
| CommandCheckInterval |
How often (in minutes) agent will check for commands |
integer |
None. |
| AgentDownloadLink |
Link to download agent installer from |
string |
Read Only |
| AgentZippedDownloadLink |
Link to download zipped agent installer from |
string |
Read Only |
| AgentMSIDownloadLink |
Link to download .msi agent installer from |
string |
Read Only |
| AgentZippedMSIDownloadLink |
Link to download zipped msi agent installer from |
string |
Read Only |
Response Formats
application/json, text/json
{
"ScanSettingsID": 1,
"GroupID": 2,
"TimeOut": 3,
"ProxyServer": "sample string 4",
"ProxyPort": 1,
"ProxyUser": "sample string 5",
"ProxyPassword": "sample string 6",
"UseProxy": true,
"LastScanTime": "2026-07-07T14:50:16.1903481+01:00",
"LastStatusTime": "2026-07-07T14:50:16.1903481+01:00",
"LastConsumableTime": "2026-07-07T14:50:16.1903481+01:00",
"LastHeartBeatTime": "2026-07-07T14:50:16.1903481+01:00",
"LastUpdateTime": "2026-07-07T14:50:16.1903481+01:00",
"HeartBeat": 1,
"Version": "sample string 7",
"LinkKey": "sample string 8",
"AllowClientUpdate": true,
"AllowAutoConfigUpdate": true,
"AllowAutoAgentUpdate": true,
"AutoUpdateInterval": 1,
"TransferSecurityLevel": 9,
"AgentPublicIPAddress": "sample string 10",
"AgentComputer": "sample string 11",
"CommandCheckInterval": 12,
"AgentDownloadLink": "sample string 13",
"AgentZippedDownloadLink": "sample string 14",
"AgentMSIDownloadLink": "sample string 15",
"AgentZippedMSIDownloadLink": "sample string 16"
}
application/xml, text/xml
<ScanSettingsDetailDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneStopWebAPI.DTO"> <AgentDownloadLink>sample string 13</AgentDownloadLink> <AgentMSIDownloadLink>sample string 15</AgentMSIDownloadLink> <AgentZippedDownloadLink>sample string 14</AgentZippedDownloadLink> <AgentZippedMSIDownloadLink>sample string 16</AgentZippedMSIDownloadLink> <AllowAutoAgentUpdate>true</AllowAutoAgentUpdate> <AllowAutoConfigUpdate>true</AllowAutoConfigUpdate> <AllowClientUpdate>true</AllowClientUpdate> <AutoUpdateInterval>1</AutoUpdateInterval> <CommandCheckInterval>12</CommandCheckInterval> <GroupID>2</GroupID> <HeartBeat>1</HeartBeat> <ProxyPassword>sample string 6</ProxyPassword> <ProxyPort>1</ProxyPort> <ProxyServer>sample string 4</ProxyServer> <ProxyUser>sample string 5</ProxyUser> <ScanSettingsID>1</ScanSettingsID> <TimeOut>3</TimeOut> <TransferSecurityLevel>9</TransferSecurityLevel> <UseProxy>true</UseProxy> </ScanSettingsDetailDTO>