API Stability Long-Term

The deleteSavedQuery() GraphQL mutation may be used to delete a saved query in LogScale.

For more information on saved queries, see the User Functions (Saved Searches) reference page where saved queries are discussed. Also, look at the Searching Data documentation page as it relates to recent queries and saving queries.

Syntax

Below is the syntax for the deleteSavedQuery() mutation field:

graphql
deleteSavedQuery(
      input: DeleteSavedQueryInput!
   ): BooleanResultType!

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

Raw
graphql
mutation {
  deleteSavedQuery(input: 
       {viewName: "humio", 
        id: "dPfVwHJ2QbCTnvRBAoCDLLZf9gTowSdA"}
  )
  {result}
}
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 {
  deleteSavedQuery(input: 
       {viewName: \"humio\", 
        id: \"dPfVwHJ2QbCTnvRBAoCDLLZf9gTowSdA\"}
  )
  {result}
}"
}
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 {
  deleteSavedQuery(input: 
       {viewName: \"humio\", 
        id: \"dPfVwHJ2QbCTnvRBAoCDLLZf9gTowSdA\"}
  )
  {result}
}"
}
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 { ^
  deleteSavedQuery(input:  ^
       {viewName: \"humio\",  ^
        id: \"dPfVwHJ2QbCTnvRBAoCDLLZf9gTowSdA\"} ^
  ) ^
  {result} ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  deleteSavedQuery(input: 
       {viewName: \"humio\", 
        id: \"dPfVwHJ2QbCTnvRBAoCDLLZf9gTowSdA\"}
  )
  {result}
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  deleteSavedQuery(input: 
       {viewName: \"humio\", 
        id: \"dPfVwHJ2QbCTnvRBAoCDLLZf9gTowSdA\"}
  )
  {result}
}"
}';
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 {
  deleteSavedQuery(input: 
       {viewName: \"humio\", 
        id: \"dPfVwHJ2QbCTnvRBAoCDLLZf9gTowSdA\"}
  )
  {result}
}"
}'''

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


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
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "deleteSavedQuery": {
      "result": true
    }
  }
}

Given Datatypes

For DeleteSavedQueryInput, there are two parameters. Below are descriptions of them:

Table: DeleteSavedQueryInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 18, 2024
idstringyes Long-TermThe unique identifier of the saved query.
viewNamestringyes Long-TermThe name of the view associated with the saved query.

Returned Datatypes

BooleanResultType has a simple, boolean parameter. See the example above to understand better.

Table: BooleanResultType

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 24, 2024
resultsbooleanyes Long-TermWhether the mutation was performed.