group_cluster_agents

Gets or lists a group_cluster_agents resource.

Overview

Name	group_cluster_agents
Type	Resource
Id	gitlab.groups.group_cluster_agents

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
id	string	ID of the cluster agent.
name	string	Name of the cluster agent.
created_at	string	Timestamp the cluster agent was created.
is_receptive	boolean	Whether the cluster agent is receptive or not.
project	object	Project identity (id, full_path, name)
updated_at	string	Timestamp the cluster agent was updated.
web_path	string	Web path of the cluster agent.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	full_path, host	has_remote_development_enabled, has_vulnerabilities, has_workspaces_agent_config	Cluster agents associated with projects in the group and its subgroups. Generated from the GitLab GraphQL schema field Group.clusterAgents (connection of ClusterAgent nodes).

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)
has_remote_development_enabled	boolean	Returns only cluster agents which have been enabled with the remote development feature.
has_vulnerabilities	boolean	Returns only cluster agents which have vulnerabilities.
has_workspaces_agent_config	boolean	Returns only cluster agents which have an associated workspaces agent config.

SELECT examples

list

Cluster agents associated with projects in the group and its subgroups. Generated from the GitLab GraphQL schema field Group.clusterAgents (connection of ClusterAgent nodes).

SELECT
id,
name,
created_at,
is_receptive,
project,
updated_at,
web_path
FROM gitlab.groups.group_cluster_agents
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND has_remote_development_enabled = '{{ has_remote_development_enabled }}'
AND has_vulnerabilities = '{{ has_vulnerabilities }}'
AND has_workspaces_agent_config = '{{ has_workspaces_agent_config }}'
;