collectors

Update collector (partial)

Update the specified collector's config data. If a field is not included in the querybody, that field will not be updated.

patch/collectors/{key}

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/collectors/{key}
  • Auth
    API key in header Authorization

Path parameters

keystring required

The id or name of the collector to update.

Request body

collectorGroupstring

Name of the collectorGroup this collector belongs to.

descriptionstring

Describes this Collector; helps a user determine which Collectors they should assign to run their collection.

helpEmailstring

The email address where a user can go to get more help about the collector.

helpUrlstring

The url where a user can go to get more help about the collector.

hoststring

Access restricted to Refocus Collector only.

ipAddressstring

Access restricted to Refocus Collector only.

osInfoobject

Access restricted to Refocus Collector only.

processInfoobject

Access restricted to Refocus Collector only.

versionstring

Access restricted to Refocus Collector only.

ownerstring

The name of the user to assign as the owner. Defaults to the user that created it

Changes

No recorded changes to this operation across all 70 revisions of this API.