v1

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

Find generators

Get a generator or all generators. 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/generators

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.

descriptionstring

Filter by the generator description; asterisk (*) wildcards ok.

createdBystring

Filter by the generator id; asterisk (*) wildcards ok.

isActiveboolean

Filter by whether or not the generator is active.

intervalSecsinteger

Interval (seconds) between each collection.

namestring

Filter by the generator name; asterisk (*) wildcards ok.

subjectQuerystring

Filter by the query to append to GET subjects. Only "absolutePath", "name", "tags" are allowed in subjectQuery.

aspectsstring[]

Filter by the names of the aspects.

tagsstring[]

Comma-separated list of tags to include/exclude. Tag names are case-insensitive. For example, ?tags=FOO,BAR will only return aspects with tags FOO and BAR. Prefix each of the tag name with a negative sign to indicate that a aspect with that tag should be excluded. For example, ?tags=-BAZ,FOO will return only the aspects with tag name not equal to BAZ or FOO. A mix of tag names with and without minus signs, for example ?tags=BAZ,-FOO are not allowed. Generators without tags are not included in the include result set.

createdAtstring

Filter by time period when generators were created.

updatedAtstring

Filter by time period when generators were updated.

Response

Success, returns a list of generators

descriptionstring

A description of the generator.

helpEmailstring

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

helpUrlstring

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

createdBystring

Id of the User who created this Generator.

idstring

The collector id.

intervalSecsinteger

Interval (seconds) between each collection.

isActiveboolean

Default false. When set to true, the generator will be assigned to a running collector and regularly send in samples.

namestring

The generator's name.

subjectQuerystring

The query to append to GET subjects. Only "absolutePath", "name", "tags" are allowed in subjectQuery.

collectorGroupobject

Specifies set of collectors this Sample Generator should try to use.

aspectsstring[]

Names of the aspects.

tagsstring[]

Array of tag names. Tag name: Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-). Tag names cannot start with a dash (-).

connectionobject

Information about the connection.

contextobject

Variables accessible inside the transform function.

currentCollectorobject

Current collector assigned to the generator.