createLogCollectorConfiguration()

API Stability Short-Term

The createLogCollectorConfiguration() GraphQL mutation field is used to creates a log collector configuration. It's a preview and subject to change.

Syntax

Below is the syntax for the createLogCollectorConfiguration() mutation field:

graphql
createLogCollectorConfiguration(
       name: string!, draft: string
    ): LogCollectorConfiguration!

Below is an example of how this mutation field might be used:

Show:
graphql
mutation {
  createLogCollectorConfiguration(
         name: "my-lc-config" )
  { id, name }
}
Example Responses
Show:
json
{
  "data": {
    "createLogCollectorConfiguration": {
      "id": "IkJ0r6zoS64rgGxHAUyz6zhKLrY0JpXN",
      "name": "my-lc-config"
    }
  }
}

Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, LogCollectorConfiguration. Below is the parameter of that datatype:

Table: LogCollectorConfiguration

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 26, 2024
descriptionstring  Short-TermA description of the Log Collector configuration.
draftstring  Short-TermThe configuration draft.
draftModifiedAtdatetimeyes Short-TermThe date and time of the last draft of the configuration.
idstringyes Short-TermThe unique identifier for the log collector configuration.
instancesintegeryes Short-TermThe number of instances.
isTestRunningbooleanyes Short-TermWhether a test is running.
modifiedAtdatetimeyes Short-TermThe date and time of the current configuration.
modifiedBystringyes Short-TermWho last modified the configuration.
namestringyes Short-TermThe name assigned to the log collector configuration.
versionintegeryes Short-TermThe version used.
yamlstring  Short-TermConfiguration in YAML format.
yamlCharactersCountintegeryes Short-TermThe YAML character count.