deleteScheduledSearch()

Summary

The deleteScheduledSearch() mutation deletes a scheduled search from a repository or view. This mutation is deprecated. Use deleteScheduledSearchV2() instead, which returns richer status information. LogScale will not remove this mutation before version 1.267.

Because this mutation is deprecated, use deleteScheduledSearchV2() for new integrations. To create a scheduled search, use createScheduledSearchV2(). To enable or disable a scheduled search without deleting it, use enableScheduledSearchV2() or disableScheduledSearchV2(). To modify a scheduled search, use updateScheduledSearchV3().

Hide Query Example

Show Scheduled Searches Query

To get a list of scheduled searches, execute the repositories() query like this:

graphql

query {
     repositories
      { id, name, __typename,
        scheduledSearches { id, name,
                            timeOfLastExecution,
                            queryString }
        }
   }

For more information on scheduled searches, see Scheduled Searches. For information on saving queries, see Search Data.

Syntax

graphql

deleteScheduledSearch(
      input: DeleteScheduledSearch!
   ): Boolean!

The required input argument takes a DeleteScheduledSearch object. Provide the unique identifier of the scheduled search to delete and the name of the associated view or repository. Use the preceding Show Scheduled Searches Query example to retrieve the scheduled search identifier. See the Input Parameters section for details.

The mutation returns a Boolean. A true result confirms deletion.

Example

Raw

graphql

mutation {
  deleteScheduledSearch( input:
    { id: "abc123",
      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: \"abc123\",
      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: \"abc123\",
      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: \"abc123\", ^
      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: \"abc123\",
      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: \"abc123\",
      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: \"abc123\",
      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: \"abc123\",
      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
  }
}

Input Parameters

Provide the unique identifier of the scheduled search to delete and the name of the associated view or repository. Use the Show Scheduled Searches Query example in the Related section to retrieve the scheduled search identifier.

Table: DeleteScheduledSearch Input Datatype

Parameter	Type	Required	Default	Stability	Availability	Description
id	String	yes		`Long-Term`		The unique identifier of the scheduled search.
viewName	String	yes		`Long-Term`		The name of the scheduled search.

Versions of this Page

GraphQL Mutations

GraphQL API

GraphQL Queries

GraphQL Datatypes