project_branch_rules

Gets or lists a project_branch_rules resource.

Overview

Name	project_branch_rules
Type	Resource
Id	gitlab.projects.project_branch_rules

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
id	string	ID of the branch rule.
name	string	Name of the branch rule target. Includes wildcards.
created_at	string	Timestamp of when the branch rule was created.
is_default	boolean	Check if the branch rule protects the project's default branch.
is_protected	boolean	Check if the branch rule protects access for the branch.
matching_branches_count	integer	Number of existing branches that match the branch rule.
updated_at	string	Timestamp of when the branch rule was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	full_path, host	build_missing	Branch rules configured for the project. Generated from the GitLab GraphQL schema field Project.branchRules (connection of BranchRule 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 project, for example gitlab-org/gitlab
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)
build_missing	boolean	Return unpersisted custom branch rules.

SELECT examples

list

Branch rules configured for the project. Generated from the GitLab GraphQL schema field Project.branchRules (connection of BranchRule nodes).

SELECT
id,
name,
created_at,
is_default,
is_protected,
matching_branches_count,
updated_at
FROM gitlab.projects.project_branch_rules
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND build_missing = '{{ build_missing }}'
;