clearErrorOnFilterAlert()

API Stability	`Long-Term`

The clearErrorOnFilterAlert() GraphQL mutation may be used to clear the error status on a filter alert. The status will be updated, though, if the error reoccurs.

For more information on filter alerts, see the Filter alerts documentation page.

Syntax

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

graphql

clearErrorOnFilterAlert(
      input: ClearErrorOnFilterAlertInput!
   ): FilterAlert!

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

Show:

graphql

mutation {
  clearErrorOnFilterAlert(input:
       { viewName: "humio", 
         id: "pvnPez4zbRDJqnS87HE1oZseiocfOGdN" } )
  {name, enabled}
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  clearErrorOnFilterAlert(input:
       { viewName: \"humio\", 
         id: \"pvnPez4zbRDJqnS87HE1oZseiocfOGdN\" } )
  {name, enabled}
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  clearErrorOnFilterAlert(input:
       { viewName: \"humio\", 
         id: \"pvnPez4zbRDJqnS87HE1oZseiocfOGdN\" } )
  {name, enabled}
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  clearErrorOnFilterAlert(input: ^
       { viewName: \"humio\",  ^
         id: \"pvnPez4zbRDJqnS87HE1oZseiocfOGdN\" } ) ^
  {name, enabled} ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  clearErrorOnFilterAlert(input:
       { viewName: \"humio\", 
         id: \"pvnPez4zbRDJqnS87HE1oZseiocfOGdN\" } )
  {name, enabled}
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

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

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  clearErrorOnFilterAlert(input:
       { viewName: \"humio\", 
         id: \"pvnPez4zbRDJqnS87HE1oZseiocfOGdN\" } )
  {name, enabled}
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  clearErrorOnFilterAlert(input:
       { viewName: \"humio\", 
         id: \"pvnPez4zbRDJqnS87HE1oZseiocfOGdN\" } )
  {name, enabled}
}"
}
);


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:

json

{
  "data": {
    "clearErrorOnFilterAlert": {
      "name": "Great Filtration Watcher",
      "enabled": true
    }
  }
}

Given Datatypes

For ClearErrorOnFilterAlertInput, there are only two parameters. Below is a list of them along with a description of each:

Table: ClearErrorOnFilterAlertInput

Parameter	Type	Required	Stability	Description
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 17, 2024
`id`	string	yes	`Long-Term`	The unique identifier of the filter alert.
`viewName`	`RepoOrViewName`	yes	`Long-Term`	Name of the view of the filter alert. `RepoOrViewName` is a scalar.

Returned Datatypes

The returned datatype filterAlert has many parameters. Below is a list of them along with a description of each:

Table: FilterAlert

Parameter	Type	Required	Stability	Description
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: Mar 26, 2025
`actions`	[`action`]	yes	`Long-Term`	List of unique identifiers for actions to fire on query result. See `Action`.
`allowedActions`	[`AssetAction`]	yes	`Preview`	List of actions allowed on which to filter query results. See `AssetAction`.
`description`	string		`Long-Term`	Description of the filter alert.
`enabled`	boolean	yes	`Long-Term`	Whether the filter alert is enabled.
`id`	string	yes	`Long-Term`	The unique identifier of the filter alert.
`labels`	[string]	yes	`Long-Term`	Labels attached to the filter alert.
`lastError`	string		`Long-Term`	Last error encountered while running the filter alert.
`lastErrorTime`	long		`Long-Term`	Unix timestamp for last error.
`lastSuccessfulPoll`	long		`Long-Term`	Unix timestamp for last successful poll of the filter alert query. If this is not quite recent, then the alert might be having problems.
`lastTriggered`	long		`Long-Term`	Unix timestamp for last execution of trigger.
`lastWarnings`	[string]	yes	`Long-Term`	Last warnings encountered while running the filter alert.
`modifiedInfo`	`modifiedInfo`		`Long-Term`	User or token used to modify the asset. See `ModifiedInfo`. This is a preview and subject to change.
`name`	string	yes	`Long-Term`	The name of the filter alert.
`package`	`PackageInstallation`		`Long-Term`	The package of which the alert was installed. See `PackageInstallation`.
`packageId`	`VersionedPackageSpecifier`		`Long-Term`	The unique identifier of the package of which the alert was installed. `VersionedPackageSpecifier` is a scalar.
`queryOwnership`	`queryOwnership`	yes	`Long-Term`	Ownership of the query run by this alert. See `QueryOwnership`.
`queryString`	string	yes	`Long-Term`	The LogScale query to execute.
`resource`	string	yes	`Short-Term`	The resource identifier for this filter alert.
`throttleField`	string		`Long-Term`	A field to throttle on. Can only be set if throttleTimeSeconds is set.
`throttleTimeSeconds`	long		`Long-Term`	The throttle time in seconds.
`yamlTemplate`	`yaml`	yes	`Long-Term`	YAML specification of the filter alert.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes