project

Gets or lists a project resource.

Overview

Name	project
Type	Resource
Id	gitlab.projects.project

Fields

The following fields are returned by SELECT queries:

get

GraphQL response envelope

Name	Datatype	Description
id	string	ID of the project.
name	string	Name of the project without the namespace.
actual_repository_size_limit	number	Size limit for the repository in bytes.
admin_edit_path	string	Admin path for editing project. Only available to admins.
admin_show_path	string	Admin path of the project. Only available to admins.
allow_merge_on_skipped_pipeline	boolean	If only_allow_merge_if_pipeline_succeeds is true, indicates if merge requests of the project can also be merged with skipped jobs.
allows_multiple_merge_request_assignees	boolean	Project allows assigning multiple users to a merge request.
allows_multiple_merge_request_reviewers	boolean	Project allows assigning multiple reviewers to a merge request.
archived	boolean	Indicates if the project or any ancestor is archived.
autoclose_referenced_issues	boolean	Indicates if issues referenced by merge requests and commits within the default branch are closed automatically.
avatar_url	string	Avatar URL of the project.
ci_config_path_or_default	string	Path of the CI configuration file.
container_registry_enabled	boolean	Indicates if Container registry is enabled for the current user
container_scanning_for_registry_enabled	boolean	Indicates whether container scanning for registry is enabled or not for the project. Returns null if unauthorized.
created_at	string	Timestamp of the project creation.
description	string	Short description of the project.
edit_path	string	Path for editing project.
forks_count	integer	Number of times the project has been forked.
full_path	string	Full path of the project.
group_	object	Group identity (id, full_path, name)
has_jira_vulnerability_issue_creation_enabled	boolean	Indicates whether Jira issue creation from vulnerabilities is enabled.
http_url_to_repo	string	URL to connect to the project via HTTPS.
import_status	string	Status of import background job of the project.
is_forked	boolean	Project is forked.
issues_enabled	boolean	Indicates if Issues are enabled for the current user
jira_import_status	string	Status of Jira import background job of the project.
jobs_enabled	boolean	Indicates if CI/CD pipeline jobs are enabled for the current user.
last_activity_at	string	Timestamp of the project last activity.
lfs_enabled	boolean	Indicates if the project has Large File Storage (LFS) enabled.
merge_commit_template	string	Template used to create merge commit message in merge requests.
merge_request_title_regex	string	Regex used to validate the title of merge requests.
merge_request_title_regex_description	string	Description of the regex used to validate the title of merge requests.
merge_requests_disable_committers_approval	boolean	Indicates that committers of the given merge request cannot approve.
merge_requests_enabled	boolean	Indicates if Merge requests are enabled for the current user
merge_requests_ff_only_enabled	boolean	Indicates if no merge commits should be created and all merges should instead be fast-forwarded, which means that merging is only allowed if the branch could be fast-forwarded.
name_with_namespace	string	Name of the project including the namespace.
namespace	object	Namespace identity (id, full_path, name)
only_allow_merge_if_all_discussions_are_resolved	boolean	Indicates if merge requests of the project can only be merged when all the discussions are resolved.
only_allow_merge_if_all_status_checks_passed	boolean	Indicates that merges of merge requests should be blocked unless all status checks have passed.
only_allow_merge_if_pipeline_succeeds	boolean	Indicates if merge requests of the project can only be merged with successful jobs.
open_issues_count	integer	Number of open issues for the project.
open_merge_requests_count	integer	Number of open merge requests for the project.
pages_force_https	boolean	Project's Pages site redirects unsecured connections to HTTPS.
pages_use_unique_domain	boolean	Project's Pages site uses a unique subdomain.
path	string	Path of the project.
pre_receive_secret_detection_enabled	boolean	Indicates whether secret push protection is on or not for the project.
prevent_merge_without_jira_issue_enabled	boolean	Indicates if an associated issue from Jira is required.
printing_merge_request_link_enabled	boolean	Indicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line.
public_jobs	boolean	Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts.
remove_source_branch_after_merge	boolean	Indicates if Delete source branch option should be enabled by default for all new merge requests of the project.
repository_size_excess	number	Size of repository that exceeds the limit in bytes.
request_access_enabled	boolean	Indicates if users can request member access to the project.
secret_push_protection_enabled	boolean	Indicates whether secret push protection is on or not for the project.
security_configuration_path	string	Path to project's security configuration.
security_dashboard_path	string	Path to project's security dashboard.
service_desk_address	string	E-mail address of the Service Desk.
service_desk_enabled	boolean	Indicates if the project has Service Desk enabled.
shared_runners_enabled	boolean	Indicates if shared runners are enabled for the project.
snippets_enabled	boolean	Indicates if Snippets are enabled for the current user
squash_commit_template	string	Template used to create squash commit message in merge requests.
squash_read_only	boolean	Indicates if squashReadOnly is enabled.
ssh_url_to_repo	string	URL to connect to the project via SSH.
star_count	integer	Number of times the project has been starred.
suggestion_commit_message	string	Commit message used to apply merge request suggestions.
topics	array
updated_at	string	Timestamp of when the project was last updated.
visibility	string	Visibility of the project.
web_path	string	Web path of the project.
web_url	string	Web URL of the project.
wiki_enabled	boolean	Indicates if Wikis are enabled for the current user

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	full_path, host		Find a project. Generated from the GitLab GraphQL schema field Query.project (Project).

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-foss.
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

get

Find a project. Generated from the GitLab GraphQL schema field Query.project (Project).

SELECT
id,
name,
actual_repository_size_limit,
admin_edit_path,
admin_show_path,
allow_merge_on_skipped_pipeline,
allows_multiple_merge_request_assignees,
allows_multiple_merge_request_reviewers,
archived,
autoclose_referenced_issues,
avatar_url,
ci_config_path_or_default,
container_registry_enabled,
container_scanning_for_registry_enabled,
created_at,
description,
edit_path,
forks_count,
full_path,
group_,
has_jira_vulnerability_issue_creation_enabled,
http_url_to_repo,
import_status,
is_forked,
issues_enabled,
jira_import_status,
jobs_enabled,
last_activity_at,
lfs_enabled,
merge_commit_template,
merge_request_title_regex,
merge_request_title_regex_description,
merge_requests_disable_committers_approval,
merge_requests_enabled,
merge_requests_ff_only_enabled,
name_with_namespace,
namespace,
only_allow_merge_if_all_discussions_are_resolved,
only_allow_merge_if_all_status_checks_passed,
only_allow_merge_if_pipeline_succeeds,
open_issues_count,
open_merge_requests_count,
pages_force_https,
pages_use_unique_domain,
path,
pre_receive_secret_detection_enabled,
prevent_merge_without_jira_issue_enabled,
printing_merge_request_link_enabled,
public_jobs,
remove_source_branch_after_merge,
repository_size_excess,
request_access_enabled,
secret_push_protection_enabled,
security_configuration_path,
security_dashboard_path,
service_desk_address,
service_desk_enabled,
shared_runners_enabled,
snippets_enabled,
squash_commit_template,
squash_read_only,
ssh_url_to_repo,
star_count,
suggestion_commit_message,
topics,
updated_at,
visibility,
web_path,
web_url,
wiki_enabled
FROM gitlab.projects.project
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;