Summary

Large LogScale deployments can accumulate many actions — for example, webhook or PagerDuty actions — making them difficult to manage. Labels categorize actions by purpose or team ownership so administrators can audit coverage more efficiently.

The addActionLabels() mutation adds one or more labels to an existing action. An action can have at most 10 labels, each with a maximum length of 60 characters. On success, the mutation returns the updated Action object. On failure, it returns null and the GraphQL errors array in the response body contains the error details.

Syntax

graphql
addActionLabels(
      input: AddActionLabels!
   ): Action

The input argument is required and takes an AddActionLabels object. Provide the view or repository name, the unique identifier of the action, and a list of labels to add. Use the following expandable query to retrieve action identifiers from a repository.

The mutation returns a nullable Action object. The Returned Values section describes the available fields, including the updated label list.

Hide Query Example

Show Action Identifiers Query

Example

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

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 {
  addActionLabels(
    input: { 
      viewName: \"humio\",
      id: \"abc123\",
      labels: [ \"act-one\",
                \"morning-shift\" ]
    }
  )
  { displayName, isAllowedToRun }
}"
}
);


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": {
    "addActionLabels": {
      "displayName": "First Action",
      "isAllowedToRun": true
    }
  }
}

Input Parameters

Provide the view or repository name, the unique identifier of the action, and a list of labels to add. Each label can be at most 60 characters, and an action can have at most 10 labels total. The Syntax section contains an expandable query for retrieving action identifiers.

Table: AddActionLabels Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
idStringyes   Id of the action.
labelsStringyes   Labels for the action. There can be at most 10 labels with a max length of 60 characters per label.
viewNameRepoOrViewNameyes   Name of the view of the action.

Returned Values

The mutation returns the updated Action object, including creation and modification metadata. Include labels in the return fields to confirm the labels now assigned to the action.

Table: Action Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
allowedActionsAssetActionyes Short-Term Allowed asset actions
createdInfoAssetCommitMetadata  Long-Term Metadata related to the creation of the action
displayNameStringyes Long-Term The display name of the action.
idStringyes Long-Term The id of the action.
isAllowedToRunBooleanyes Long-Term False if this type of action is disabled because of a security policy, true otherwise
labelsStringyes Long-Term Labels to categorize the action.
modifiedInfoAssetCommitMetadata  Long-Term Metadata related to the latest modification of the action
nameStringyes Long-Term The name of the action.
packagePackageInstallation  Long-Term The package, if any, which the action is part of.
packageIdVersionedPackageSpecifier  Long-Term  
requiresOrganizationOwnedQueriesPermissionToEditBooleanyes Long-Term True if this action is used by triggers, where the query is run by the organization. If true, then the OrganizationOwnedQueries permission is required to edit the action.
resourceStringyes Short-Term The resource identifier for this action.
yamlTemplateYAMLyes Long-Term A template that can be used to recreate the action.