removeDashboardLabel()

When creating dashboards, you can include labels, but you may have only ten labels for each. So you may want to delete some labels at some point. You can use the removeDashboardLabel() GraphQL mutation to remove a label from a dashboard. It will return the updated dashboard if successful — null with errors if not.

This mutation is deprecated, though, since it doesn't support multiple labels. It will be removed at the earliest in version 1.273. Use instead removeDashboardLabels().

There is not a mutation for changing labels. Instead, you'll have to use this mutation or the new one, and then use addDashboardLabels() to add new labels.

Hide Query Example

Show Dashboard Labels Query

To get a list of all dashboard labels, use the entitiesLabels() query like this:

graphql

query {
     entitiesLabels {
       entityTypes: Dashboard
     }
   }

To get a list of labels for a each dashboard, you could execute the dashboardsPage() like this:

graphql

query {
     dashboardsPage ( 
        search: "conference-room",
        pageSize: 10, pageNumber: 1 )
       { page { labels } }
   }

For more information on dashboards, see the Dashboards documentation page. To manage labels through the UI, see the Manage Triggers page of the main documentation.

API Stability Deprecated

Syntax

graphql

removeDashboardLabel(
     id: string!, 
     label: string!
   ): Dashboard!

You have to give the unique identifier of the dashboard from which you want to remove a label (click on Show Query below), and the label to remove.

For the results, you can get details on the dashboard, including a list of labels for it. See the Returned Datatype section farther down this page.

Hide Query Example

Show Dashboard Identifiers Query

To get a list of all dashboards for a repository, use the repository() query like this:

graphql

query {
     repository(name: "humio")
        { dashboards { name, id } }
   }

With these results you can use a dashboard's unique identifier to remove a label from it.

Example

Raw

graphql

mutation {
  removeDashboardLabel(
      id: "abc123",
      label: "admin" 
  )
  { labels }
}

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 {
  removeDashboardLabel(
      id: \"abc123\",
      label: \"admin\" 
  )
  { labels }
}"
}
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 {
  removeDashboardLabel(
      id: \"abc123\",
      label: \"admin\" 
  )
  { labels }
}"
}
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 { ^
  removeDashboardLabel( ^
      id: \"abc123\", ^
      label: \"admin\"  ^
  ) ^
  { labels } ^
}" ^
} '

Windows Powershell and curl

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  removeDashboardLabel(
      id: \"abc123\",
      label: \"admin\" 
  )
  { labels }
}"
}'
    "$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 {
  removeDashboardLabel(
      id: \"abc123\",
      label: \"admin\" 
  )
  { labels }
}";
$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 {
  removeDashboardLabel(
      id: \"abc123\",
      label: \"admin\" 
  )
  { labels }
}"
}'''

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 {
  removeDashboardLabel(
      id: \"abc123\",
      label: \"admin\" 
  )
  { labels }
}"
}
);


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": {
    "removeDashboardLabel": {
      "labels": []
    }
  }
}

Given Datatype

For the input, you'll have to give the unique identifier of the dashboard, and the label to remove from it. Click on the Show Query link in the Syntax section to see how to get the dashboard's identifier and to see the list of labels associated already with it.

Table: Input Using Standard Datatypes

Parameter	Type	Required	Default	Description
id	string	yes		The unique identifier of the dashboard.
label	string	yes		The label to remove from the dashboard.

Returned Datatype

For the returned datatype, there are several parameters related to the dashboard. For this mutation, though, you may want to get the dashboard's remaining labels in case you want to remove or add more. To see this, include the labels parameter.

Table: Dashboard

Parameter	Type	Required	Stability	Description
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Aug 19, 2025
allowedActions	[AssetAction]	yes	`Short-Term`	The allowed asset actions. See AssetAction Table). This is feature is a preview and may be changed.
createdInfo	AssetCommitMetadata		`Long-Term`	Metadata related to the creation of the dashboard. See AssetCommitMetadata.
defaultFilter	DashboardFilter		`Long-Term`	The default filter used with the dashboard (see DashboardFilter Table).
defaultSharedTimeEnabled	boolean	yes	`Long-Term`	Whether the shared time by default is enabled.
defaultSharedTimeEnd	string	yes	`Long-Term`	The default shared ending time.
defaultSharedTimeStart	string	yes	`Long-Term`	The default shared starting time.
description	string		`Long-Term`	A description of the dashboard.
displayName	string	yes	`Long-Term`	The display name of the dashboard.
filters	[DashboardFilter]	yes	`Long-Term`	The filters used with the dashboard. See DashboardFilter.
id	string	yes	`Long-Term`	The unique identifier for the dashboard.
isStarred	boolean	yes	`Long-Term`	Whether the dashboard is marked with a star.
labels	[string]	yes	`Long-Term`	Any labels associated with the dashboard.
modifiedInfo	AssetCommitMetadata		`Long-Term`	Metadata related to the latest modification of the dashboard. See AssetCommitMetadata.
name	string	yes	`Long-Term`	The name of the dashboard.
package	PackageInstallation	yes	`Long-Term`	The package, if there is one, in which the dashboard is included (see PackageInstallation Table).
packageId	VersionedPackageSpecifier	yes	`Long-Term`	The unique identifiers of the package. VersionedPackageSpecifier is a scalar.
parameters	[DashboardParameter]	yes	`Long-Term`	List of dashboard parameters (see DashboardParameter Table).
readOnlyTokens	[DashboardLink]	yes	`Long-Term`	List of tokens used to access the dashboard without logging in. Useful for wall mounted dashboards or public dashboards. See DashboardLink.
resource	string	yes	`Short-Term`	The resource identifier for this dashboard.
searchDomain	SearchDomain	yes	`Long-Term`	The search domain for the dashboard. See SearchDomain.
sections	[Section]	yes	`Long-Term`	The sections for the dashboard. See Section.
series	[SeriesConfig]	yes	`Long-Term`	The series configuration for the dashboard. See SeriesConfig.
templateYaml	string	yes	`Deprecated`	A yaml formatted string that describes the dashboard. This field has been replaced with yamlTemplate. It will be removed at the earliest in version 1.225.
timeJumpSizeInMs	integer		`Long-Term`	The skip time in milliseconds for the dashboard.
updateFrequency	DashboardUpdateFrequencyType	yes	`Long-Term`	The frequency in which dashboard is updated. See DashboardUpdateFrequencyType, and the explanations under the DashboardParameter.
widgets	[Widget]	yes	`Long-Term`	Widgets for the dashboard (see Widget Table).
yamlTemplate	YAML	yes	`Long-Term`	A yaml formatted string that describes the dashboard. YAML is a scalar. It doesn't contain links or permissions, and is safe to share and use for making copies of a dashboard. This replaced templateYaml starting in LogScale version 1.165.

Versions of this Page

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes