๐Ÿ”’Security Requirements and Controls

Summary

The deleteAlert() mutation deletes a legacy alert by alert ID and view name. This mutation is deprecated. Use deleteLegacyAlert() instead, which accepts equivalent inputs and follows the current API naming convention.

LogScale will remove this mutation no earlier than version 1.267.

Syntax

graphql
deleteAlert(
      input: DeleteAlert!
   ): Boolean!

The mutation takes a single required input argument of type DeleteAlert. Provide the unique identifier of the legacy alert to delete and the name of the associated view. The return type Boolean! is non-nullable: the mutation returns true on success and false on failure.

Use the following collapsed query to find legacy alert identifiers before calling this mutation.

Hide Query Example

Show Alert Identifiers Query

Example

Raw
graphql
mutation {
  deleteAlert(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 {
  deleteAlert(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 {
  deleteAlert(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 { ^
  deleteAlert(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 {
  deleteAlert(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 {
  deleteAlert(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 {
  deleteAlert(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 {
  deleteAlert(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": {
    "deleteAlert": true
  }
}

Input Parameters

Provide the unique identifier of the legacy alert to delete and the name of the associated view. The Syntax section contains a collapsed query for retrieving legacy alert identifiers.

Table: DeleteAlert Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
idStringyesย Long-Termย The unique identifier of the alert.
viewNameStringyesย Long-Termย The name of the view for the alert.

Returned Values

This mutation returns Boolean!. A value of true indicates the legacy alert was deleted successfully. A value of false indicates the operation failed. To confirm the alert no longer exists, query repositories() after the mutation completes.