API Stability Long-Term

The deleteAggregateAlert() GraphQL mutation is used to delete an aggregate alert.

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

Syntax

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

graphql
deleteAggregateAlert(
      input: DeleteAggregateAlert!
   ): boolean!

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

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

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


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

Given Datatypes

For DeleteAggregateAlert, there are a couple of parameters that may be given. Below is description of each:

Table: DeleteAggregateAlert

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