Summary

Large LogScale deployments can accumulate many actions — for example, webhook or email actions — with multiple labels assigned to categorize them by purpose or team ownership. Labels must be explicitly removed when they become stale or need replacement.

The removeActionLabels() mutation removes one or more labels from an existing action. 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
removeActionLabels(
      input: RemoveActionLabels!
   ): Action

The input argument is required and takes a RemoveActionLabels object. Provide the view or repository name, the unique identifier of the action, and a list of labels to remove. 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 {
  removeActionLabels(
    input: { 
      viewName: "humio",
      id: "abc123",
      labels: [ "morning-shift" ]
    }
  )
  { labels, 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 {
  removeActionLabels(
    input: { 
      viewName: \"humio\",
      id: \"abc123\",
      labels: [ \"morning-shift\" ]
    }
  )
  { labels, 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 {
  removeActionLabels(
    input: { 
      viewName: \"humio\",
      id: \"abc123\",
      labels: [ \"morning-shift\" ]
    }
  )
  { labels, 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 { ^
  removeActionLabels( ^
    input: {  ^
      viewName: \"humio\", ^
      id: \"abc123\", ^
      labels: [ \"morning-shift\" ] ^
    } ^
  ) ^
  { labels, isAllowedToRun } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  removeActionLabels(
    input: { 
      viewName: \"humio\",
      id: \"abc123\",
      labels: [ \"morning-shift\" ]
    }
  )
  { labels, 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 {
  removeActionLabels(
    input: { 
      viewName: \"humio\",
      id: \"abc123\",
      labels: [ \"morning-shift\" ]
    }
  )
  { labels, 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 {
  removeActionLabels(
    input: { 
      viewName: \"humio\",
      id: \"abc123\",
      labels: [ \"morning-shift\" ]
    }
  )
  { labels, 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 {
  removeActionLabels(
    input: { 
      viewName: \"humio\",
      id: \"abc123\",
      labels: [ \"morning-shift\" ]
    }
  )
  { labels, 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": {
    "removeActionLabels": {
      "labels": [ "morning-shift" ],
      "isAllowedToRun": true
    }
  }
}

Input Parameters

Provide the view or repository name, the unique identifier of the action, and a list of labels to remove. An action can have at most 10 labels, each with a maximum length of 60 characters. The Syntax section contains an expandable query for retrieving action identifiers.

Table: RemoveActionLabels Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
idStringyes   Id of the action.
labelsStringyes   Labels to remove from the action, at most 100 at a time.
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 that remain on the action after removal.