clearErrorOnAggregateAlert()

API Stability	`Long-Term`

The clearErrorOnAggregateAlert() GraphQL mutation is used to clear an error on an aggregate alert. The status will be updated, though, if the error reoccurs.

For more information on aggregate alerts, see the Aggregate alerts documentation page.

Syntax

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

graphql

clearErrorOnAggregateAlert(
      input: ClearErrorOnAggregateAlertInput!
   ): AggregateAlert!

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

Show:

graphql

mutation {
  clearErrorOnAggregateAlert(input:
       { viewName: "humio", 
         id: "jmcLeo2mnELCmeS87HE1oZseiocfOGdN"} )
  {name, enabled}
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  clearErrorOnAggregateAlert(input:
       { viewName: \"humio\", 
         id: \"jmcLeo2mnELCmeS87HE1oZseiocfOGdN\"} )
  {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 {
  clearErrorOnAggregateAlert(input:
       { viewName: \"humio\", 
         id: \"jmcLeo2mnELCmeS87HE1oZseiocfOGdN\"} )
  {name, enabled}
}"
}
EOF

shell

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

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  clearErrorOnAggregateAlert(input:
       { viewName: \"humio\", 
         id: \"jmcLeo2mnELCmeS87HE1oZseiocfOGdN\"} )
  {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 {
  clearErrorOnAggregateAlert(input:
       { viewName: \"humio\", 
         id: \"jmcLeo2mnELCmeS87HE1oZseiocfOGdN\"} )
  {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 {
  clearErrorOnAggregateAlert(input:
       { viewName: \"humio\", 
         id: \"jmcLeo2mnELCmeS87HE1oZseiocfOGdN\"} )
  {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 {
  clearErrorOnAggregateAlert(input:
       { viewName: \"humio\", 
         id: \"jmcLeo2mnELCmeS87HE1oZseiocfOGdN\"} )
  {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": {
    "clearErrorOnAggregateAlert": {
      "name": "Special Aggregator",
      "enabled": true
    }
  }
}

Given Datatypes

For ClearErrorOnAggregateAlertInput, there are a couple of parameters. Below is a list of them along with a description of each:

Table: ClearErrorOnAggregateAlertInput

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`	long	yes	`Long-Term`	The unique identifier of the aggregate alert.
`viewName`	`RepoOrViewName`	yes	`Long-Term`	The name of the view of the aggregate alert. `RepoOrViewName` is a scalar.

Returned Datatypes

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

Table: AggregateAlert

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 25, 2025
`actions`	[`Action`]	yes	`Long-Term`	List of actions to fire on query result. See `Action`.
`allowedActions`	[`AssetAction`]	yes	`Preview`	List of actions allowed to fire on query result. See `AssetAction`.
`description`	string		`Long-Term`	Description of the aggregate alert.
`enabled`	boolean	yes	`Long-Term`	Flag indicating whether the aggregate alert is enabled.
`id`	string	yes	`Long-Term`	Unique identifier of of the aggregate alert.
`labels`	[string]	yes	`Long-Term`	Labels attached to the aggregate alert.
`lastError`	string		`Long-Term`	Last error encountered while running the aggregate alert.
`lastSuccessfulPoll`	long		`Long-Term`	Unix timestamp for last successful poll of the aggregate alert query. If this isn't very recent, the alert might have problems.
`lastTriggered`	long		`Long-Term`	Unix timestamp for last execution of trigger.
`lastWarnings`	[string]	yes	`Long-Term`	Last warnings encountered while running the aggregate alert.
`modifiedInfo`	`ModifiedInfo`	yes	`Preview`	Information about the aggregate alert that was modified. See `ModifiedInfo`.
`name`	string	yes	`Long-Term`	Name of the aggregate alert.
`package`	`PackageInstallation`		`Long-Term`	The package of which the aggregate alert was installed. See `PackageInstallation`.
`packageId`	`VersionedPackageSpecifier`		`Long-Term`	The unique identifier of the package of the aggregate alert template. `VersionedPackageSpecifier` is a scalar.
`queryOwnership`	`queryOwnership`	yes	`Long-Term`	Ownership of the query run by this alert. See `queryOwnership`.
`queryString`	string	yes	`Long-Term`	LogScale query to execute.
`queryTimestampType`	`QueryTimestampType`	yes	`Long-Term`	Timestamp type to use for a query. See `QueryTimestampType` and the FAQ: How Does LogScale Handle Ingest Delays in Aggregate Alerts KB article.
`resource`	string	yes	`Short-Term`	The resource identifier for the aggregate alert.
`searchIntervalSeconds`	long	yes	`Long-Term`	Search interval in seconds.
`throttleField`	string		`Long-Term`	A field to throttle on.
`throttleTimeSeconds`	long	yes	`Long-Term`	Throttle time in seconds.
`triggerMode`	`TriggerMode`	yes	`Long-Term`	Trigger mode used for triggering the alert. See `TriggerMode` and the FAQ: How Does LogScale Handle Ingest Delays in Aggregate Alerts KB article.
`yamlTemplate`	`yaml`	yes	`Long-Term`	YAML specification of the aggregate alert.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes