API Stability Long-Term

The updateLogCollectorGroupName() GraphQL mutation is used to update Log Collector's group name.

Syntax

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

graphql
updateLogCollectorGroupName(
      id: string!, 
      name: string!
   ): LogCollectorGroup!

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

Show:
graphql
mutation {
  updateLogCollectorGroupName( 
     id: "abc123",
     name: "we-happy-few"
  )
 { id }
}
Example Responses
Show:
json
{
  "data": {
    "updateLogCollectorGroupName": {
      "id": "abc123"
    }
  }
}

Returned Datatypes

For LogCollectorGroup, there are several parameters. Below is a list of them along with a description of each:

Table: LogCollectorGroup

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
collectorCountinteger   text
configurations[LogCollectorConfiguration]yes Short-TermThe log collector's configurations. See LogCollectorConfiguration.
filterstring  Short-TermThe filter used with the log collector.
idstringyes Short-TermThe unique identifier for the group.
namestringyes Short-TermThe name of the log collector group.
onlyUsesRemoteUpdatesbooleanyes Short-TermWhether the group only uses remove updates.
wantedVersionstring  Short-TermThe wanted version.