API Stability Short-Term

The killQuery() GraphQL mutation may be used to kill a running query in LogScale.

For more information on queries, see the Query Language Syntax reference page. You may also want to look at Live Queries.

Syntax

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

graphql
killQuery(
     viewName: string!
     pattern: string!
   ): BooleanResultType!

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

Show:
graphql
mutation {
  killQuery (
    viewName: "humio",
    pattern: "localhost"
  )
  { result }
}
Example Responses
Show:
json
{
  "data": {
    "killQuery": {
      "result": true
    }
  }
}

Returned Datatype

The returned datatype BooleanResultType has its own parameter. Below is a description of it:

Table: BooleanResultType

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 24, 2024
resultsbooleanyes Long-TermWhether the mutation was performed.