API Stability Long-Term

The updateSavedQuery() GraphQL mutation is used to update a saved query in LogScale.

Related to this mutation, there are the mutations, createSavedQuery(), copySavedQuery(), and deleteSavedQueryV2() for creating, copying, and deleting saved queries. There are also the createSavedQueryFromTemplate() mutation for creating a saved query using a YAML template, and createSavedQueryFromPackageTemplate() to create one from a template in a package. There is also setDefaultSavedQuery() for marking a saved query as the default, and the query savedQuery() to get details on a specific saved query.

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

Hide Query Example

Show Saved Queries Query

Syntax

graphql
updateSavedQuery(
     input: UpdateSavedQueryInput!
   ): UpdateSavedQueryPayload!

Example

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

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

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


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": {
    "updateSavedQuery": {
      "savedQuery": {
        "id": "abc123"
      }
    }
  }
}

Given Datatype

For the input datatype, you'll have to give the name of the view and the unique identifier of the saved query you want to update. After that, you can change many parameters, such as the query used by it. See the table below for more parameters:

Table: UpdateSavedQueryInput

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 23, 2024
customLinkInteractions[CustomLinkInteractionInput]yes Long-TermThe custom links for interactions. See CustomLinkInteractionInput.
dashboardLinkInteractions[DashboardLinkInteractionInput]yes Long-TermThe dashboard links for interactions. See DashboardLinkInteractionInput.
endstring  Long-TermThe ending point of the saved query.
idstringyes Long-TermThe unique identifier of the saved query to update.
isLiveboolean  Long-TermWhether the saved query is executed continuously on live, streaming data.
namestring  Long-TermThe name of the saved query to update.
optionsstring  Long-TermAny options related to the saved query.
queryStringstring  Long-TermThe new query.
searchLinkInteractions[SearchLinkInteractionInput]yes Long-TermThe search links for interactions. See SearchLinkInteractionInput.
startstring  Long-TermThe starting point of the saved query.
updateParametersInteractions[UpdateParametersInteractionInput]yes Long-TermThe parameters to update for interactions. See UpdateParametersInteractionInput.
viewNamestringyes Long-TermThe name of the view associated with the saved query.
widgetTypestring  Long-TermThe type of widget for displaying the results of the saved query.

Returned Datatype

With the returned datatype, by way of sub-parameters, you can get a yaml template of the saved query, when and who created it, and other related data. The table below contains a link to another table with the sub-parameters:

Table: UpdateSavedQueryPayload

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: Oct 4, 2024
savedQuerySavedQueryyes Long-TermThe saved query to update. See SavedQuery.