SAsalesforce
collectors

Get collector

Retrieve the specified collector metadata by the collector's id or name. You may also optionally specify a list of fields to include in the response.

get/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 retrieve.

Query parameters

fieldsstring[]

Comma-delimited list of field names to include in the response.

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

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