ci_variables

Gets or lists a ci_variables resource.

Overview

Name	ci_variables
Type	Resource
Id	gitlab.ci.ci_variables

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
id	string	ID of the variable.
description	string	Description of the variable.
hidden	boolean	Indicates whether the variable is hidden.
key	string	Name of the variable.
masked	boolean	Indicates whether the variable is masked.
protected	boolean	Indicates whether the variable is protected.
raw	boolean	Indicates whether the variable is raw.
value	string	Value of the variable.
variable_type	string	Type of the variable. (ENV_VAR, FILE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	host	sort	List of the instance's CI/CD variables. Generated from the GitLab GraphQL schema field Query.ciVariables (connection of CiInstanceVariable 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
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)
sort	string	Sort order of results.

SELECT examples

list

List of the instance's CI/CD variables. Generated from the GitLab GraphQL schema field Query.ciVariables (connection of CiInstanceVariable nodes).

SELECT
id,
description,
hidden,
key,
masked,
protected,
raw,
value,
variable_type
FROM gitlab.ci.ci_variables
WHERE host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND sort = '{{ sort }}'
;