project_target_branch_rules

Gets or lists a project_target_branch_rules resource.

Overview

Name	project_target_branch_rules
Type	Resource
Id	gitlab.projects.project_target_branch_rules

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
id	string	ID of the target branch rule.
name	string	Name of the target branch rule.
created_at	string	Timestamp of when the target branch rule was created.
target_branch	string	Target branch for the target branch rule.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	full_path, host		Target branch rules of the project. Generated from the GitLab GraphQL schema field Project.targetBranchRules (connection of ProjectTargetBranchRule 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)

SELECT examples

list

Target branch rules of the project. Generated from the GitLab GraphQL schema field Project.targetBranchRules (connection of ProjectTargetBranchRule nodes).

SELECT
id,
name,
created_at,
target_branch
FROM gitlab.projects.project_target_branch_rules
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;