deleteScheduledSearchV2()

🎯API Stability

Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The deleteScheduledSearchV2() mutation permanently removes a scheduled search from a repository or view. This operation is irreversible. To suspend a scheduled search without removing it, use disableScheduledSearchV2() instead.

The mutation returns a nullable Boolean. A true result confirms deletion. A false result means no matching scheduled search was found. A null result indicates a failure; check the errors field in the response for details.

To create a scheduled search, use createScheduledSearchV2(). To modify an existing scheduled search, use updateScheduledSearchV3(). To suspend or resume a scheduled search without deleting it, use disableScheduledSearchV2() and enableScheduledSearchV2().

Both the scheduled search ID and the view or repository name are required inputs for this mutation. Use the following query to retrieve scheduled search IDs.

Hide Query Example

Show Scheduled Searches Query

To get a list of scheduled searches, use 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

deleteScheduledSearchV2(
      input: DeleteScheduledSearchV2!
   ): Boolean

The required input argument takes a DeleteScheduledSearchV2 object. Provide the scheduled search ID and the name of the associated repository or view. Use the Show Scheduled Searches Query in the Related section to retrieve the scheduled search ID.

The mutation returns a nullable Boolean. The Summary section describes the three possible return values.

Example

Raw

graphql

mutation {
  deleteScheduledSearchV2( input:
    { viewName: "humio",
      id: "abc123",
    } )
}

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 {
  deleteScheduledSearchV2( input:
    { viewName: \"humio\",
      id: \"abc123\",
    } )
}"
}
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 {
  deleteScheduledSearchV2( input:
    { viewName: \"humio\",
      id: \"abc123\",
    } )
}"
}
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 { ^
  deleteScheduledSearchV2( input: ^
    { viewName: \"humio\", ^
      id: \"abc123\", ^
    } ) ^
}" ^
} '

Windows Powershell and curl

powershell

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

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


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

Input Parameters

The DeleteScheduledSearchV2 input type requires two fields. The id field is the unique system-assigned identifier for the scheduled search to delete. The viewName field accepts either a repository or a view name using the RepoOrViewName scalar. Use the Show Scheduled Searches Query in the Related section to retrieve the scheduled search ID.

Versions of this Page

GraphQL Mutations

GraphQL API

GraphQL Queries

GraphQL Datatypes