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

For more information on alerts, see the Alerts documentation page.

Syntax

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

graphql
clearErrorOnAlert(
      input: ClearErrorOnAlertInput!
   ): Alert!

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

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

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  clearErrorOnAlert(input:
       { viewName: \"humio\", 
         id: \"eweKcj7zbRDJqnS87HE1oZseiocfOGdN\" } )
  {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 {
  clearErrorOnAlert(input:
       { viewName: \"humio\", 
         id: \"eweKcj7zbRDJqnS87HE1oZseiocfOGdN\" } )
  {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
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "clearErrorOnAlert": {
      "name": "Late Night",
      "enabled": true
    }
  }
}

Given Datatypes

For the input, ClearErrorOnAlertInput, there are a couple of parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: ClearErrorOnAlertInput

ParameterTypeRequiredDefaultDescription
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
idstringyes Unique identifier of the alert.
viewNamestringyes Name of the view of the alert.

Returned Datatypes

The returned datatype Alert has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: Alert

ParameterTypeRequiredDefaultDescription
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.
actionsstringyes List of identifiers for actions to fire on query result.
actionsV2[Action]yes List of unique identifiers for actions to fire on query result. See Action.
allowedActions[AssetAction]yes List of allowed actions. The is a preview; it may be changed. See AssetAction.
assetTypeAssetTypeyes 

The type of asset from an enumerated list. See AssetType.

This parameter has been deprecated and will be removed in version 1.136 of LogScale.

descriptionstring  Description of alert.
displayNamestringyes Name of the alert.
enabledbooleanyes Flag indicating whether the alert is enabled.
idstringyes The identifier of the alert.
isStarredbooleanyes 

Whether the calling user has starred the alert.

This has been deprecated and is no longer in use and has no effect. It will be removed in version 1.213.

labels[string]yes Labels attached to the alert.
lastErrorstring  Last error encountered while running the alert.
lastWarnings[string]yes Last warnings encountered while running the alert.
namestringyes The name of the alert.
packagePackageInstallation  A package installation. See PackageInstallation.
packageIdVersionedPackageSpecifier  The unique identifier of the package installed, if one was used. VersionedPackageSpecifier is a scalar.
queryOwnershipQueryOwnershipyes Ownership of the query run by the alert. See QueryOwnership.
queryStartstringyes Start of the relative time interval for the query.
queryStringstringyes LogScale query to execute.
runAsUserUser  Identifier of user by which the alert is run. See User.
throttleFieldstring  Field on which to throttle alert.
throttleTimeMillislongyes Throttle time in milliseconds.
timeOfLastTriggerlong  UNIX timestamp for when the alert was last triggered.
yamlTemplatestringyes A YAML formatted string that describes the alert.