๐ŸŽฏAPI Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The disableAggregateAlertV2() mutation disables an active aggregate alert in a LogScale repository or view. Use this mutation to pause an alert temporarily without deleting its configuration. To re-enable the alert, use enableAggregateAlertV2().

Syntax

graphql
disableAggregateAlertV2(
      input: DisableAggregateAlert!
   ): AggregateAlert

The mutation accepts a single required input argument of type DisableAggregateAlert!. Provide the unique identifier of the aggregate alert and the name of its associated repository or view. The mutation returns an AggregateAlert object, or null if the alert is not found. See the Input Parameters section for the required fields.

The returned AggregateAlert object reflects the alert's configuration after disabling. See the Returned Values section for the available fields.

Example

Raw
graphql
mutation {
  disableAggregateAlertV2( 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 {
  disableAggregateAlertV2( 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 {
  disableAggregateAlertV2( 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 { ^
  disableAggregateAlertV2( 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 {
  disableAggregateAlertV2( 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 {
  disableAggregateAlertV2( 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 {
  disableAggregateAlertV2( 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 {
  disableAggregateAlertV2( 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": {
    "disableAggregateAlertV2": {
      "name": "Special Aggregator",
      "enabled": true
    }
  }
}

Input Parameters

Provide the unique identifier of the aggregate alert to disable and the name of the associated repository or view. Use the repositories() query in the preceding Related section to retrieve aggregate alert identifiers.

Returned Values

The mutation returns an AggregateAlert object containing the alert's full configuration after disabling. Available fields include the query string, associated actions, trigger mode, last-triggered timestamp, and any warnings or errors from evaluation. The return value is nullable; a null result indicates the alert was not found.