🎯API Stability
Short-TermThis API may change in future versions. Use with caution in production environments.

Summary

The stopStreamingQueries() mutation stops all streaming queries cluster-wide. Streaming queries are live queries that continuously process newly ingested data; they consume cluster resources for as long as they run. Use this mutation to reduce live query load without interrupting historical searches, for example before performing maintenance or when cluster resources are under pressure. Requires ManageCluster permission.

Syntax

graphql
stopStreamingQueries(
      input: StopQueriesInput
   ): Boolean!

The input argument accepts a StopQueriesInput object. See the Input Parameters section for details on its fields.

The mutation returns a non-null Boolean!. A value of true indicates the stop request succeeded.

Example

Raw
graphql
mutation {
  stopStreamingQueries( input:
    { clusterWide: true }
  )
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  stopStreamingQueries( input:
    { clusterWide: true }
  )
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  stopStreamingQueries( input:
    { clusterWide: true }
  )
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  stopStreamingQueries( input: ^
    { clusterWide: true } ^
  ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  stopStreamingQueries( input:
    { clusterWide: true }
  )
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  stopStreamingQueries( input:
    { clusterWide: true }
  )
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  stopStreamingQueries( input:
    { clusterWide: true }
  )
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  stopStreamingQueries( input:
    { clusterWide: true }
  )
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "stopStreamingQueries": true
  }
}

Input Parameters

The input argument takes a StopQueriesInput object. The fields are described in the following table:

Table: StopQueriesInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
clusterWideBoolean  Short-Term Whether to stop queries globally. Requires the ManageCluster permission.