addAlertLabelV2()

API Stability	`Long-Term`

The addAlertLabelV2() GraphQL mutation is used to add a label to an alert.

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

Syntax

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

graphql

addAlertLabelV2(
      input: AddAlertLabel!
    ): Alert!

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

Show:

graphql

mutation {
  addAlertLabelV2(input: {
    viewName: "humio",
    id: "eweKcj7zbRDJqnS87HE1oZseiocfOGdN", 
    label: "humioator" } 
    )
  { displayName, description }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  addAlertLabelV2(input: {
    viewName: \"humio\",
    id: \"eweKcj7zbRDJqnS87HE1oZseiocfOGdN\", 
    label: \"humioator\" } 
    )
  { displayName, description }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  addAlertLabelV2(input: {
    viewName: \"humio\",
    id: \"eweKcj7zbRDJqnS87HE1oZseiocfOGdN\", 
    label: \"humioator\" } 
    )
  { displayName, description }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  addAlertLabelV2(input: { ^
    viewName: \"humio\", ^
    id: \"eweKcj7zbRDJqnS87HE1oZseiocfOGdN\",  ^
    label: \"humioator\" }  ^
    ) ^
  { displayName, description } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  addAlertLabelV2(input: {
    viewName: \"humio\",
    id: \"eweKcj7zbRDJqnS87HE1oZseiocfOGdN\", 
    label: \"humioator\" } 
    )
  { displayName, description }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  addAlertLabelV2(input: {
    viewName: \"humio\",
    id: \"eweKcj7zbRDJqnS87HE1oZseiocfOGdN\", 
    label: \"humioator\" } 
    )
  { displayName, description }
}"
}';
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

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  addAlertLabelV2(input: {
    viewName: \"humio\",
    id: \"eweKcj7zbRDJqnS87HE1oZseiocfOGdN\", 
    label: \"humioator\" } 
    )
  { displayName, description }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  addAlertLabelV2(input: {
    viewName: \"humio\",
    id: \"eweKcj7zbRDJqnS87HE1oZseiocfOGdN\", 
    label: \"humioator\" } 
    )
  { displayName, description }
}"
}
);


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

Show:

json

{
  "data": {
    "addAlertLabelV2": {
      "displayName": "Late Night",
      "description": "Any activities late at night."
    }
  }
}

Given Datatypes

For AddAlertLabel, there are a few parameters that may be given. Below is a list of them along with a description of each:

Table: AddAlertLabel

Parameter	Type	Required	Stability	Description
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 17, 2024
`id`	string	yes	`Long-Term`	Identifier of the alert.
`label`	string	yes	`Long-Term`	Label for the alert.
`viewName`	string	yes	`Long-Term`	Name of the view of the alert.

Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, alert. Below is a list of the parameters of that data type:

Table: Alert

Parameter	Type	Required	Stability	Description
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: Mar 28, 2025
`actions`	string	yes	`Long-Term`	List of identifiers for actions to fire on query result.
`actionsV2`	[`Action`]	yes	`Long-Term`	List of unique identifiers for actions to fire on query result. See `Action`.
`allowedActions`	[`AssetAction`]	yes	`Preview`	List of allowed actions. The is a preview; it may be changed. See `AssetAction`.
`description`	string		`Long-Term`	Description of alert.
`displayName`	string	yes	`Long-Term`	Name of the alert.
`enabled`	boolean	yes	`Long-Term`	Flag indicating whether the alert is enabled.
`id`	string	yes	`Long-Term`	The identifier of the alert.
`isStarred`	boolean	yes	`Long-Term`	Whether the calling user has starred the alert. This has been deprecated and is no longer in use and has no effect. It will be removed in version 1.213.
`labels`	[string]	yes	`Long-Term`	Labels attached to the alert.
`lastError`	string		`Long-Term`	Last error encountered while running the alert.
`lastWarnings`	[string]	yes	`Long-Term`	Last warnings encountered while running the alert.
`name`	string	yes	`Long-Term`	The name of the alert.
`package`	`PackageInstallation`		`Long-Term`	A package installation. See `PackageInstallation`.
`packageId`	`VersionedPackageSpecifier`		`Long-Term`	The unique identifier of the package installed, if one was used. `VersionedPackageSpecifier` is a scalar.
`queryOwnership`	`QueryOwnership`	yes	`Long-Term`	Ownership of the query run by the alert. See `QueryOwnership`.
`queryStart`	string	yes	`Long-Term`	Start of the relative time interval for the query.
`queryString`	string	yes	`Long-Term`	LogScale query to execute.
`resource`	string	yes	`Short-Term`	The resource identifier for the alert.
`runAsUser`	`User`		`Long-Term`	Identifier of user by which the alert is run. See `User`.
`throttleField`	string		`Long-Term`	Field on which to throttle alert.
`throttleTimeMillis`	long	yes	`Long-Term`	Throttle time in milliseconds.
`timeOfLastTrigger`	long		`Long-Term`	UNIX timestamp for when the alert was last triggered.
`yamlTemplate`	string	yes	`Long-Term`	A YAML formatted string that describes the alert.

For the alert parameters, there are a few special datatypes. One is the AssetType, but that merely requires a choice from an enumerated list, which is given in the alert table above.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes