LogCollectorConfiguration is a datatype for a configuration file for a log collector.

This datatype is used primarily by five mutation fields: createLogCollectorConfiguration(); updateDraftLogCollectorConfiguration(); updateLogCollectorConfigurationDescription(); updateLogCollectorConfigurationName(); and publishLogCollectorConfiguration(). It's also used by the logCollectorConfiguration() query field.

Table: LogCollectorConfiguration

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results. 
Table last updated: Oct 14, 2026 
descriptionString  Short-Term A description of the Log Collector configuration.
draftString  Short-Term The configuration draft.
draftModifiedAtDateTime  Short-Term The date and time of the last draft of the configuration.
idStringyes Short-Term The unique identifier for the log collector configuration.
instancesIntyes Short-Term The number of instances.
isTestRunningBooleanyes Short-Term Whether a test is running.
modifiedAtDateTimeyes Short-Term The date and time of the current configuration.
modifiedByStringyes Short-Term Who last modified the configuration.
nameStringyes Short-Term The name assigned to the log collector configuration.
versionIntyes Short-Term The version used.
yamlString  Short-Term Configuration in YAML format.
yamlCharactersCountIntyes Short-Term The yaml character count.