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

Summary

The clearErrorOnFilterAlert() mutation clears the error status on a filter alert in LogScale. Use this mutation after you investigate and resolve the underlying cause of the error. If the error reoccurs, LogScale updates the status automatically.

Syntax

graphql
clearErrorOnFilterAlert(
      input: ClearErrorOnFilterAlertInput!
   ): FilterAlert!

The required input argument takes a ClearErrorOnFilterAlertInput object. Provide the view name and the unique identifier of the filter alert. The preceding query example shows how to retrieve the identifier.

The mutation returns a FilterAlert! object (non-null). The returned object contains the alert's current state, including its query string, triggered actions, and error information.

Example

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

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


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": {
    "clearErrorOnFilterAlert": {
      "name": "Great Filtration Watcher",
      "enabled": true
    }
  }
}

Input Parameters

Provide the view name and the unique identifier of the filter alert on which to clear the error. The query example in the preceding Related section shows how to retrieve the identifier from the repositories() query.

Table: ClearErrorOnFilterAlertInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
idStringyes Long-Term The unique identifier of the filter alert.
viewNameRepoOrViewNameyes Long-Term Name of the view of the filter alert. RepoOrViewName is a scalar.

Returned Values

The mutation returns the updated FilterAlert object. The returned fields include the alert's query string, the actions it triggers, and the most recent error or warning details. The following table lists all available fields.

Table: FilterAlert Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
actionsActionyes Long-Term List of unique identifiers for actions to fire on query result. See Action.
allowedActionsAssetActionyes Short-Term List of actions allowed on which to filter query results. See AssetAction .
createdInfoAssetCommitMetadata  Long-Term Metadata related to the creation of the filter alert. See AssetCommitMetadata.
descriptionString  Long-Term Description of the filter alert.
enabledBooleanyes Long-Term Whether the filter alert is enabled.
idStringyes Long-Term The unique identifier of the filter alert.
labelsStringyes Long-Term Labels attached to the filter alert.
lastErrorString  Long-Term Last error encountered while running the filter alert.
lastErrorTimeLong  Long-Term Unix timestamp for last error.
lastSuccessfulPollLong  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.
lastTriggeredLong  Long-Term Unix timestamp for last execution of trigger.
lastWarningsStringyes Long-Term Last warnings encountered while running the filter alert.
modifiedInfoModifiedInfoyes Long-Term User or token used to modify the asset. See ModifiedInfo. This is a preview and subject to change.
nameStringyes Long-Term The name of the filter alert.
packagePackageInstallation  Long-Term The package of which the alert was installed. See PackageInstallation.
packageIdVersionedPackageSpecifier  Long-Term The unique identifier of the package of which the alert was installed. VersionedPackageSpecifier is a scalar.
queryOwnershipQueryOwnershipyes Long-Term Ownership of the query run by this alert. See QueryOwnership.
queryStringStringyes Long-Term The LogScale query to execute.
resourceStringyes Short-Term The resource identifier for this filter alert.
throttleFieldString  Deprecateddeprecated in 1.282The field on which to throttle. This can be set only if throttleTimeSeconds is set. Filter alerts now support multiple throttle fields. This field will be removed at the earliest in version 1.279. Use instead the throttleFields field.
throttleFieldsStringyes Long-Term The fields on which to throttle. This can be set only if throttleTimeSeconds is set.
throttleTimeSecondsLong  Long-Term The throttle time in seconds.
yamlTemplateYAMLyes Long-Term The yaml specification of the filter alert. YAML is a scalar.