API Stability Short-Term

The stopHistoricalQueries() GraphQL mutation is used to stop all historical queries. It ignores live and streaming queries. It requires Manage Cluster permission. This field is not yet available. It's described here as a preview and is still in development.

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 stopHistoricalQueries() mutation field:

graphql
stopHistoricalQueries(
      input: StopQueriesInput
   ): boolean!

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

Show:
graphql
mutation {
  stopHistoricalQueries( input:
    {
      clusterWide: true
    }
  )
}
Example Responses
Show:
json
{
  "data": {
    "stopHistoricalQueries": true
  }
}

Given Datatypes

StopQueriesInput has one parameter that may be given. It's described in the table here:

Table: StopQueriesInput

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: Mar 28, 2025
clusterWideboolean falseShort-TermWhether to stop queries globally. Requires the ManageCluster permission.