API Stability Long-Term

The removeStarFromField() GraphQL mutation is used to remove a star from a field in LogScale.

For more information on fields, see the Event Fields documentation page.

Syntax

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

graphql
removeStarFromField(
      input: RemoveStarToFieldInput!
   ): RemoveStarToFieldMutation!

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

Show:
graphql
mutation {
  removeStarFromField(input: 
       { fieldName: "connectionSource"
         searchDomainName: "humio" } )
  { starredFields }
}
Example Responses
Show:
json
{
  "data": {
    "removeStarFromField": {
      "starredFields": [
        "@timestamp"
      ]
    }
  }
}

Given Datatypes

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

Table: RemoveStarToFieldInput

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 19, 2024
fieldNamestringyes Long-TermThe name of the field from which to remove the star.
searchDomainNamestringyes Long-TermThe search domain where the field is located.

Returned Datatypes

RemoveStarToFieldMutation has one parameter. It's described below:

Table: RemoveStarToFieldMutation

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: Oct 3, 2024
starredFields[string]yes Long-TermFields which are marked with a star.