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

Summary

The addLegacyAlertLabels() mutation adds one or more labels to an existing legacy alert in a LogScale repository or view. Organize alerts, identify duplicates, or group related alerts for easier management. Each alert supports at most ten labels, each with a maximum length of sixty characters.

Syntax

graphql
addLegacyAlertLabels(
      input: AddLegacyAlertLabels!
   ): Alert

The required input argument takes an AddLegacyAlertLabels object specifying the target repository or view name, the legacy alert ID, and the list of labels to add.

The return type is Alert, which is nullable. The mutation returns the updated alert on success. See the Returned Values section for the available fields.

Hide Query Example

Show Legacy Alert Identifiers Query

Example

Raw
graphql
mutation {
  addLegacyAlertLabels(input: {
    viewName: "humio",
    id: "abc123", 
    labels: [ "key-alerts",
              "night-shift",
              "admin-focus" ]
  )
  { displayName, description }
}
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 {
  addLegacyAlertLabels(input: {
    viewName: \"humio\",
    id: \"abc123\", 
    labels: [ \"key-alerts\",
              \"night-shift\",
              \"admin-focus\" ]
  )
  { displayName, description }
}"
}
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 {
  addLegacyAlertLabels(input: {
    viewName: \"humio\",
    id: \"abc123\", 
    labels: [ \"key-alerts\",
              \"night-shift\",
              \"admin-focus\" ]
  )
  { displayName, description }
}"
}
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 { ^
  addLegacyAlertLabels(input: { ^
    viewName: \"humio\", ^
    id: \"abc123\",  ^
    labels: [ \"key-alerts\", ^
              \"night-shift\", ^
              \"admin-focus\" ] ^
  ) ^
  { displayName, description } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  addLegacyAlertLabels(input: {
    viewName: \"humio\",
    id: \"abc123\", 
    labels: [ \"key-alerts\",
              \"night-shift\",
              \"admin-focus\" ]
  )
  { displayName, description }
}"
}'
    "$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 {
  addLegacyAlertLabels(input: {
    viewName: \"humio\",
    id: \"abc123\", 
    labels: [ \"key-alerts\",
              \"night-shift\",
              \"admin-focus\" ]
  )
  { displayName, description }
}";
$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 {
  addLegacyAlertLabels(input: {
    viewName: \"humio\",
    id: \"abc123\", 
    labels: [ \"key-alerts\",
              \"night-shift\",
              \"admin-focus\" ]
  )
  { displayName, description }
}"
}'''

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 {
  addLegacyAlertLabels(input: {
    viewName: \"humio\",
    id: \"abc123\", 
    labels: [ \"key-alerts\",
              \"night-shift\",
              \"admin-focus\" ]
  )
  { displayName, description }
}"
}
);


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": {
    "addLegacyAlertLabels": {
      "displayName": "Late Night",
      "description": "Any activities late at night."
    }
  }
}

Input Parameters

Provide the repository or view name in viewName, the legacy alert's unique identifier in id, and a list of label strings in labels. To find legacy alert identifiers, select the Show Legacy Alert Identifiers Query link in the preceding Syntax section.

Returned Values

The mutation returns an Alert object containing the updated alert's full label list, query string, triggered actions, and last-execution error messages. Include labels in your return fields to confirm which labels are now attached to the alert.