v1

latestSwagger 2.0BSD 3-Clause2026-07-1720953437.1 KB

generators

Update generator (partial)

Update the specified generator. Requires user to have write permision. If a field is not included in the query body, that field will not be updated.

patch/generators/{key}

Path parameters

keystring required

The id or key of the generator to update.

Request body

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.

intervalSecsinteger

Interval (seconds) between each collection.

namestring

The generator's name.

subjectQuerystring

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

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.

collectorGroupstring

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

isActiveboolean

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

ownerstring

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

Response

Success, returns the updated generator.