The deleteScheduledSearch()
For more information on scheduled searches, see the
Scheduled searches documentation page.
Also, look at the Searching Data documentation
page as it relates to saving queries.
Below is the syntax for the
deleteScheduledSearch()
deleteScheduledSearch(
input : DeleteScheduledSearch!
) : boolean!
Below is an example of how this mutation field might be used:
Show:
Raw Mac OS or Linux (curl) Mac OS or Linux (curl) One-line Windows Cmd and curl Windows Powershell and curl Perl Python Node.js
Raw mutation {
deleteScheduledSearch( input :
{ id : "F8XbE9eYUlJB0JgaWQLfkGwWiHrLpyID" ,
viewName : "humio"
} )
} Mac OS or Linux (curl) 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\"
} )
}"
}
EOFMac OS or Linux (curl) One-line 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\"
} )
}"
}
EOFWindows Cmd and curl 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 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
use HTTP::Request;
use LWP;
my $INGEST_TOKEN = "TOKEN" ;
my $uri = '$YOUR_LOGSCALE_URL/graphql' ;
my $json = '{"query" : "mutation {
deleteScheduledSearch( input:
{ id: \"F8XbE9eYUlJB0JgaWQLfkGwWiHrLpyID\",
viewName: \"humio\"
} )
}"
}' ;
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
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 const https = require ('https' );
const data = JSON .stringify (
{"query" : "mutation {
deleteScheduledSearch( input:
{ id: \"F8XbE9eYUlJB0JgaWQLfkGwWiHrLpyID\",
viewName: \"humio\"
} )
}"
}
);
const options = {
hostname : '$YOUR_LOGSCALE_URL/graphql' ,
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 Show:
Success (HTTP Response Code 200 OK)
Success (HTTP Response Code 200 OK) {
"data" : {
"deleteScheduledSearch" : true }
}
For deleteScheduledSearch ,
there are a couple of parameters that may be given. They're listed
below along with a description of each:
Table: DeleteScheduledSearch
Parameter Type Required Default Stability Description Some arguments may be required, as indicated in the Required Table last updated: Sep 18, 2024 idstring yes Long-TermThe unique identifier of the scheduled search. viewNamestring yes Long-TermThe name of the scheduled search.
