SAsalesforce
collectors

Start collector

Changed on

Starts the specified collector.

post/collectors/start

Request

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

Request body

namestring required

Access restricted to Refocus Collector only.

descriptionstring

Access restricted to Refocus Collector only.

helpEmailstring

Access restricted to Refocus Collector only.

helpUrlstring

Access restricted to Refocus Collector only.

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 required

Access restricted to Refocus Collector only.

ownerstring

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

Response

Success, returns the specified collector's metadata.

idstring

The collector id.

namestring required

Should be unique.

currentGeneratorsobject[]

Generators assigned to this collector.

registeredtrue | false

Boolean. If false, means deregistered. Changed by the DEREGISTER command

status'Stopped' | 'Running' | 'Paused' | 'MissedHeartbeat'

The collector status.

lastHeartbeatstring

Timestamp at which the last heartbeat was sent.

lastModifiedAtstring

Timestamp of the collector's most recent modification.

createdBystring

Id of the User who created this Collector.

lastUpdatedBystring

Timestamp of the collector's most recent update.

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

The host where the collector is installed.

ipAddressstring

The ipAddress where the collector is installed.

Changes