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

Summary

The cancelScheduledSearchRerun() mutation cancels a previously queued rerun of a scheduled search. Use it after calling rerunScheduledSearch() when you want to abort the rerun before it executes. You must specify the exact rerun time to cancel, because a scheduled search can have multiple reruns queued.

Syntax

graphql
cancelScheduledSearchRerun(
      input: CancelScheduledSearchRerun!
   ): ScheduledSearch!

The mutation requires a single non-null input argument of type CancelScheduledSearchRerun. Provide the repository or view name, the scheduled search ID, and the specific rerun timestamp to cancel. The mutation returns a non-null ScheduledSearch object representing the updated scheduled search.

To find the scheduled search ID and available rerun times, use the repository() query shown in the Related section. See Input Parameters for full argument details.

Example

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

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 {
  cancelScheduledSearchRerun(
    input: { viewName: \"humio\",
             id: \"abc123\",
             rerunTimeToCancel: \"1774618413\" }
  ) { id, name, lastExecuted }
}"
}
);


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": {
    "cancelScheduledSearchRerun": {
      "id": "abc123",
      "name": "run-one",
      "lastExecuted": "1774483200"
    }
  }
}

Input Parameters

Provide the repository or view name, the scheduled search ID, and the Unix timestamp in milliseconds for the specific rerun to cancel. Use the repository() query shown in the Related section to retrieve scheduled search IDs and their queued rerun times.

Returned Values

The mutation returns a ScheduledSearch object reflecting the state of the scheduled search after cancellation. The object includes the query string, associated actions, execution history, errors or warnings from the last run, and the next scheduled execution time.