🎯API Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The setAutomaticSearching() mutation enables or disables automatic query execution when a user opens the search page for a repository or view. When enabled, LogScale runs the repository's default saved query immediately on page load without requiring the user to select Run. Disabling automatic searching reduces unnecessary resource usage for repositories where users typically refine the query before running it. Use setDefaultSavedQuery() to configure which query runs automatically.

Syntax

graphql
setAutomaticSearching(
      name: String!,
      automaticSearch: Boolean!
   ): setAutomaticSearching!

Both arguments are required. Provide the name of the target repository or view in name, and set automaticSearch to true to enable automatic searching or false to disable it. The mutation returns a non-null setAutomaticSearching object confirming the updated setting.

Example

Raw
graphql
mutation {
  setAutomaticSearching( 
    name: "humio",
    automaticSearch: true
  )
  { automaticSearch }
}
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 {
  setAutomaticSearching( 
    name: \"humio\",
    automaticSearch: true
  )
  { automaticSearch }
}"
}
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 {
  setAutomaticSearching( 
    name: \"humio\",
    automaticSearch: true
  )
  { automaticSearch }
}"
}
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 { ^
  setAutomaticSearching(  ^
    name: \"humio\", ^
    automaticSearch: true ^
  ) ^
  { automaticSearch } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  setAutomaticSearching( 
    name: \"humio\",
    automaticSearch: true
  )
  { automaticSearch }
}"
}'
    "$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 {
  setAutomaticSearching( 
    name: \"humio\",
    automaticSearch: true
  )
  { automaticSearch }
}";
$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 {
  setAutomaticSearching( 
    name: \"humio\",
    automaticSearch: true
  )
  { automaticSearch }
}"
}'''

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 {
  setAutomaticSearching( 
    name: \"humio\",
    automaticSearch: true
  )
  { automaticSearch }
}"
}
);


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": {
    "setAutomaticSearching": {
      "automaticSearch": true
    }
  }
}

Input Parameters

This mutation requires the name of the target repository or view and a boolean flag that specifies the automatic searching behavior.

Table: Input Parameters and Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
automaticSearch Boolean yes   Set to true to run the default query automatically when a user opens the search page. Set to false to require the user to run the search manually.
name String yes   The name of the repository or view to configure.

Returned Values

The mutation returns a setAutomaticSearching object. The automaticSearch field reflects the new state of the setting after the mutation completes — true if automatic searching is now enabled, false if disabled. Use this value to confirm the change was applied as expected.

Table: setAutomaticSearching Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
automaticSearchBooleanyes Long-Term Whether automatic search is enabled or not.