Security Requirements and Controls
API Stability Deprecated

The deleteScheduledSearch() GraphQL mutation may be used to delete a scheduled search in LogScale.

This mutation field is deprecated. It will be removed at the earliest in version 1.267. Use instead deleteScheduledSearchV2().

To create a scheduled search, you can use the createScheduledSearchV2() mutation. To enable and disable a scheduled search, use the enableScheduledSearchV2() and disableScheduledSearchV2() mutations. To make changes to a scheduled search, use updateScheduledSearchV3().

Hide Query Example

Show Scheduled Searches Query

For more information on scheduled searches, see the Scheduled searches documentation page. Also, look at the Search Data documentation page as it relates to saving queries.

Syntax

graphql
deleteScheduledSearch(
     input: DeleteScheduledSearch!
   ): boolean

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

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

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


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

Given Datatype

For this input datatype, you would give the unique identifier of the scheduled search to delete, and the name of the associated view. This is described in the table here:

Table: DeleteScheduledSearch

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 18, 2024
idstringyes Long-TermThe unique identifier of the scheduled search.
viewNamestringyes Long-TermThe name of the scheduled search.