group_label

Gets or lists a group_label resource.

Overview

Name	group_label
Type	Resource
Id	gitlab.groups.group_label

Fields

The following fields are returned by SELECT queries:

get

GraphQL response envelope

Name	Datatype	Description
id	string	Global ID of the label.
archived	boolean	Indicates the label is archived.
color	string	Background color of the label.
created_at	string	When the label was created.
description	string	Description of the label (Markdown rendered as HTML for caching).
lock_on_merge	boolean	Indicates this label is locked for merge requests that have been merged.
text_color	string	Text color of the label.
title	string	Content of the label.
updated_at	string	When the label was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	full_path, title, host		Label available on the group. Generated from the GitLab GraphQL schema field Group.label (Label).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
full_path	string	Full path of the group, for example gitlab-org
host	string	GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST)
title	string	Title of the label.

SELECT examples

get

Label available on the group. Generated from the GitLab GraphQL schema field Group.label (Label).

SELECT
id,
archived,
color,
created_at,
description,
lock_on_merge,
text_color,
title,
updated_at
FROM gitlab.groups.group_label
WHERE full_path = '{{ full_path }}' -- required
AND title = '{{ title }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;