API Stability Short-Term

The updateDraftLogCollectorConfiguration() GraphQL mutation may be used to update a Log Collector configuration.

Syntax

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

graphql
updateDraftLogCollectorConfiguration(
      id: string!, draft: string
   ): LogCollectorConfiguration!

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

Show:
graphql
mutation {
  updateDraftLogCollectorConfiguration( 
      id: "abc123",
      draft: "something"
  )
  { id }
}
Example Responses
Show:
json
{
  "updateDraftLogCollectorConfiguration": {
    "id": "abc123"
    }
  }
}

Returned Datatypes

The returned datatype LogCollectorConfiguration has several parameters. Below is a list of them along with a description of each:

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.