๐ŸŽฏAPI Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The disableScheduledSearchV2() mutation disables execution of a scheduled search in a view or repository. The search definition, query string, and associated actions are preserved; only execution is paused. A disabled scheduled search does not run on its schedule and does not trigger any configured actions. Use this mutation to temporarily suspend a scheduled search without deleting it. To resume execution, call enableScheduledSearchV2().

Syntax

graphql
disableScheduledSearchV2(
      input: DisableScheduledSearch!
   ): ScheduledSearch

The input argument takes a DisableScheduledSearch object with two required fields: viewName, the name of the view or repository containing the scheduled search, and id, the unique identifier of the scheduled search. Use the repositories() query in the preceding example to retrieve the identifier.

The mutation returns a nullable ScheduledSearch object. A null return indicates the scheduled search was not found. On success, the enabled field in the returned object is false, confirming the search is disabled. See the Returned Values section for available fields.

Example

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

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 {
  disableScheduledSearchV2( input:  
    { viewName: \"humio\",
      id: \"abc123\" } )
  { id, enabled }
}"
}
);


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": {
    "disableScheduledSearchV2": {
      "id": "abc123",
      "enabled": false
    }
  }
}

Input Parameters

The input argument takes a DisableScheduledSearch object with two required fields. The viewName field identifies the view or repository containing the scheduled search. The id field is the unique identifier of the scheduled search to disable. Use the repositories() query in the preceding example to retrieve both values.

Returned Values

The mutation returns a nullable ScheduledSearch object. A null return indicates the scheduled search was not found or the caller lacks access to the specified view. On success, the enabled field is false, confirming that execution is disabled. The returned object also includes the query string, schedule expression, any configured action references, and the results of the last execution including errors and warnings. The following table lists all available fields.