PUT datacollectors

Update DataCollector client. Roles: ApiRole/FreeRole

Request Information

URI Parameters

None.

Body Parameters

Object to update DC Client.

DCClientUpdate
NameDescriptionTypeAdditional information
ClientID

Client ID

integer

Required

Name

Client name

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ClientID": 1,
  "Name": "sample string 2"
}

application/xml, text/xml

Sample:
<DCClientUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ClientID>1</ClientID>
  <Name>sample string 2</Name>
</DCClientUpdate>

Response Information

Resource Description

Returns the updated DC Client object.

DCClient
NameDescriptionTypeAdditional information
ClientID

Client ID

integer

None.

AccountID

Customer/Account ID

integer

None.

Name

Client name

string

None.

Created

Client created date

date

None.

LastDiscovered

Client last Discovered

date

None.

LastCollect

Client last collect

date

None.

LastActivity

Client last activity

date

None.

IPv4

IPv4 address of client installed machine

string

None.

Version

Client version

string

None.

IsActivated

Is client activated

boolean

None.

IsInUse

Is client in use

boolean

None.

Ranges

Client ranges.

Collection of DCClientRange

None.

State

Client state

ClientState

None.

Response Formats

application/json, text/json

Sample:
{
  "ClientID": 1,
  "AccountID": 2,
  "Name": "sample string 3",
  "Created": "2018-08-18T15:52:46.4071606+00:00",
  "LastDiscovered": "2018-08-18T15:52:46.4071606+00:00",
  "LastCollect": "2018-08-18T15:52:46.4071606+00:00",
  "LastActivity": "2018-08-18T15:52:46.4071606+00:00",
  "AllowedOffline": "00:00:00.1234567",
  "IPv4": "sample string 9",
  "Version": "sample string 10",
  "IsActivated": true,
  "IsInUse": true,
  "Ranges": [
    {
      "ClientRangeID": 1,
      "ClientID": 2,
      "Name": "sample string 3",
      "StartIP": "sample string 4",
      "EndIP": "sample string 5",
      "State": "sample string 6",
      "IsEnabled": true,
      "Community": "sample string 8",
      "NumOfDevices": 1,
      "Created": "2018-08-18T15:52:46.4071606+00:00",
      "Comment": "sample string 10",
      "Exclude": true
    },
    {
      "ClientRangeID": 1,
      "ClientID": 2,
      "Name": "sample string 3",
      "StartIP": "sample string 4",
      "EndIP": "sample string 5",
      "State": "sample string 6",
      "IsEnabled": true,
      "Community": "sample string 8",
      "NumOfDevices": 1,
      "Created": "2018-08-18T15:52:46.4071606+00:00",
      "Comment": "sample string 10",
      "Exclude": true
    }
  ],
  "State": "Online"
}

application/xml, text/xml

Sample:
<DCClient xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ClientID>1</ClientID>
  <AccountID>2</AccountID>
  <Name>sample string 3</Name>
  <Created>2018-08-18T15:52:46.4071606+00:00</Created>
  <LastDiscovered>2018-08-18T15:52:46.4071606+00:00</LastDiscovered>
  <LastCollect>2018-08-18T15:52:46.4071606+00:00</LastCollect>
  <LastActivity>2018-08-18T15:52:46.4071606+00:00</LastActivity>
  <IPv4>sample string 9</IPv4>
  <Version>sample string 10</Version>
  <IsActivated>true</IsActivated>
  <IsInUse>true</IsInUse>
  <Ranges>
    <DCClientRange>
      <ClientRangeID>1</ClientRangeID>
      <ClientID>2</ClientID>
      <Name>sample string 3</Name>
      <StartIP>sample string 4</StartIP>
      <EndIP>sample string 5</EndIP>
      <State>sample string 6</State>
      <IsEnabled>true</IsEnabled>
      <Community>sample string 8</Community>
      <NumOfDevices>1</NumOfDevices>
      <Created>2018-08-18T15:52:46.4071606+00:00</Created>
      <Comment>sample string 10</Comment>
      <Exclude>true</Exclude>
    </DCClientRange>
    <DCClientRange>
      <ClientRangeID>1</ClientRangeID>
      <ClientID>2</ClientID>
      <Name>sample string 3</Name>
      <StartIP>sample string 4</StartIP>
      <EndIP>sample string 5</EndIP>
      <State>sample string 6</State>
      <IsEnabled>true</IsEnabled>
      <Community>sample string 8</Community>
      <NumOfDevices>1</NumOfDevices>
      <Created>2018-08-18T15:52:46.4071606+00:00</Created>
      <Comment>sample string 10</Comment>
      <Exclude>true</Exclude>
    </DCClientRange>
  </Ranges>
</DCClient>