Sign in

v1

latestSwagger 2.0BSD 3-Clause2026-07-1720953437.1 KB
collectors

Find collectors

Find a collector or collectors. You may query using field filters with asterisk (*) wildcards. You may also optionally specify sort, limit, offset, and a list of fields to include in the response. The global default limit will apply if no limit param is specified.

get/collectors

Query parameters

fieldsstring[]

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

sortstring[]

Specify the sort order using a field name, e.g. '...?sort=name'. Prepend the field name with a minus sign to specify descending order, e.g. '...?sort=-name'.

limitinteger

Maximum number of records to return in the response; also useful for pagination in the UI.

offsetinteger

Offset for paginating the response.

namestring

Filter by name; asterisk (*) wildcards ok.

statusstring

Filter by status; asterisk (*) wildcards ok.

registeredboolean

Filter by registered (true|false).

helpEmailstring

Filter by helpEmail; asterisk (*) wildcards ok.

helpUrlstring

Filter by helpUrl; asterisk (*) wildcards ok.

hoststring

Filter by host; asterisk (*) wildcards ok.

versionstring

Filter by version; asterisk (*) wildcards ok.

createdAtstring

Filter by time period when collectors were created.

updatedAtstring

Filter by time period when collectors were updated.

Response

Success, returns an array of zero or more Refocus collectors.

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.