The disableAlert() GraphQL mutation may be used to disable an alert.

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

To enable an alert, use the enableLegacyAlert() mutation. To create a new alert, you can use the createAlert() mutation. To update an alert, you'd use the updateAlert() mutation. And you'd use the deleteLegacyAlert() to delete one.

Hide Query Example

Show Alerts Query

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

API Stability Deprecated
Security Requirement & Control UpdateTriggers API permission

Syntax

graphql
disableAlert(
      input: DisableAlert!
   ): boolean

For the input, you have to give the unique identifier of the alert to disable, and the name of the view or repository. 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 {
  disableAlert( 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 {
  disableAlert( 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 {
  disableAlert( 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 { ^
  disableAlert( 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 {
  disableAlert( 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 {
  disableAlert( 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 {
  disableAlert( 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 {
  disableAlert( 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": {
    "disableAlert": true
  }
}

Given Datatype

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

Table: DisableAlert

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 alert.
viewNamestringyes Long-TermThe name of the view of the alert.