The disableAggregateAlert() GraphQL mutation is used to disable an aggregate alert.

This mutation is deprecated. It will be removed at the earliest in version 1.273. Use instead disableAggregateAlertV2().

To enable an aggregate alert, you can use the enableAggregateAlertV2(). To create an aggregate alert, use the createAggregateAlert() mutation. Use the updateAggregateAlertV2() mutation to update an aggregate alert. You can delete one with deleteAggregateAlertV2().

Hide Query Example

Show Aggregate Alerts Query

For a better understanding of aggregate alerts, see the Triggers page in the main documentation.

API Stability Deprecated
Security Requirement & Control UpdateTriggers API permission

Syntax

graphql
disableAggregateAlert(
      input: DisableAggregateAlert!
   ): boolean

For the input, you'll have to give the unique identifier of the aggregate alert to disable. Click on Show Query above to see how to get that. See the Given Datatype section for the parameters to use.

For the results, you'll receive confirmation if successful.

Example

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

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


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": {
    "disableAggregateAlert": true
  }
}

Given Datatype

For this input datatype, you would give the unique identifier of the aggregate alert to disable, and the name of the associated view. Click on Show Query above to see how to get that.

Table: DisableAggregateAlert

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 18, 2024
idstringyes Long-TermThe unique identifier of the aggregate alert.
viewNameRepoOrViewNameyes Long-TermName of the view of the aggregate alert. RepoOrViewName is a scalar