Viewing docs for GitLab v10.0.0
published on Friday, Jun 26, 2026 by Pulumi
published on Friday, Jun 26, 2026 by Pulumi
Viewing docs for GitLab v10.0.0
published on Friday, Jun 26, 2026 by Pulumi
published on Friday, Jun 26, 2026 by Pulumi
The gitlab.Project data source allows details of a project to be retrieved by either its ID or its path with namespace.
Upstream API: GitLab REST API docs
Using getProject
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>
function getProjectOutput(args: GetProjectOutputArgs, opts?: InvokeOptions): Output<GetProjectResult>def get_project(id: Optional[str] = None,
path_with_namespace: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetProjectResult
def get_project_output(id: pulumi.Input[Optional[str]] = None,
path_with_namespace: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetProjectResult]func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput> Note: This function is named LookupProject in the Go SDK.
public static class GetProject
{
public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
public static Output<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
fn::invoke:
function: gitlab:index/getProject:getProject
arguments:
# arguments dictionarydata "gitlab_getproject" "name" {
# arguments
}The following arguments are supported:
- Id string
- The integer that uniquely identifies the project within the gitlab install.
- Path
With stringNamespace - The path of the repository with namespace.
- Id string
- The integer that uniquely identifies the project within the gitlab install.
- Path
With stringNamespace - The path of the repository with namespace.
- id string
- The integer that uniquely identifies the project within the gitlab install.
- path_
with_ stringnamespace - The path of the repository with namespace.
- id String
- The integer that uniquely identifies the project within the gitlab install.
- path
With StringNamespace - The path of the repository with namespace.
- id string
- The integer that uniquely identifies the project within the gitlab install.
- path
With stringNamespace - The path of the repository with namespace.
- id str
- The integer that uniquely identifies the project within the gitlab install.
- path_
with_ strnamespace - The path of the repository with namespace.
- id String
- The integer that uniquely identifies the project within the gitlab install.
- path
With StringNamespace - The path of the repository with namespace.
getProject Result
The following output properties are available:
- Allow
Merge boolOn Skipped Pipeline - Whether
allowMergeOnSkippedPipelineis enabled for the project. - Allow
Pipeline boolTrigger Approve Deployment - Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only.
- Analytics
Access stringLevel - Set the analytics access level. Valid values are
disabled,private,enabled. - Approvals
Before intMerge - The number of approvals needed in a merge request.
- Archived bool
- Whether the project is in read-only mode (archived).
- Auto
Cancel stringPending Pipelines - Auto-cancel pending pipelines. This isn't a boolean, but
enabled/disabled. - Auto
Devops stringDeploy Strategy - Auto Deploy strategy. Valid values are
continuous,manual,timedIncremental. - Auto
Devops boolEnabled - Enable Auto DevOps for this project.
- Auto
Duo boolCode Review Enabled - Whether GitLab Duo code review is enabled for the project.
- Autoclose
Referenced boolIssues - Set whether auto-closing referenced issues on default branch.
- Avatar
Url string - The avatar URL of the project.
- Build
Coverage stringRegex - Build coverage regex for the project.
- Build
Git stringStrategy - The Git strategy. Defaults to
fetch. - Build
Timeout int - The maximum amount of time, in seconds, that a job can run.
- Builds
Access stringLevel - Set the builds access level. Valid values are
disabled,private,enabled. - Can
Create boolMerge Request In - Whether the calling user can create merge requests in this project.
- Ci
Allow boolFork Pipelines To Run In Parent Project - Whether pipelines triggered from merge requests opened from forks may run in the parent project.
- Ci
Config stringPath - CI config file path for the project.
- Ci
Default intGit Depth - Default number of revisions for shallow cloning.
- Ci
Delete intPipelines In Seconds - Pipelines older than the configured time are deleted.
- Ci
Display boolPipeline Variables - Whether pipeline variables are displayed in the UI.
- Ci
Forward boolDeployment Enabled - When a new deployment job starts, skip older deployment jobs that are still pending.
- Ci
Forward boolDeployment Rollback Allowed - Allow job retries even if the deployment job is outdated.
- Ci
Id List<string>Token Sub Claim Components - Fields included in the sub claim of the ID Token. Accepts an array starting with
projectPath. The array might also includerefTypeandref. Defaults to["projectPath", "refType", "ref"]. Introduced in GitLab 17.10. - Ci
Job boolToken Scope Enabled - Whether the CI/CD job token access scope is enabled (limits which projects can be accessed using the job token).
- Ci
Opt boolIn Jwt - Whether the project must explicitly opt in to receive ID tokens in CI jobs.
- Ci
Pipeline stringVariables Minimum Override Role - The minimum role required to set variables when running pipelines and jobs. Introduced in GitLab 17.1. Valid values are
developer,maintainer,owner,noOneAllowed. - Ci
Push boolRepository For Job Token Allowed - Whether pushes to the repository using the CI/CD job token are allowed.
- Ci
Restrict stringPipeline Cancellation Role - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer,maintainer,noOne. - Ci
Separated boolCaches - Use separate caches for protected branches.
- Compliance
Frameworks List<string> - Compliance frameworks applied to the project. Premium and Ultimate only.
- Container
Expiration List<Pulumi.Policies Git Lab. Outputs. Get Project Container Expiration Policy> - The image cleanup policy for this project.
- Container
Registry stringAccess Level - Set visibility of container registry for this project. Valid values are
disabled,private,enabled. - Container
Registry boolEnabled - Whether the container registry is enabled for the project.
- Container
Registry stringImage Prefix - The image prefix used by the container registry for this project.
- Created
At string - Creation time for the project.
- Creator
Id int - Creator ID for the project.
- Custom
Attributes List<ImmutableDictionary<string, string>> - Custom attributes for the project.
- Default
Branch string - The default branch name of the project.
- Description string
- A description of the project.
- Emails
Disabled bool - Whether email notifications are disabled for the project.
- Emails
Enabled bool - Enable email notifications.
- Empty
Repo bool - Whether the project is empty.
- Enforce
Auth boolChecks On Uploads - Whether authentication checks are enforced when uploading to the project.
- Environments
Access stringLevel - Set the environments access level. Valid values are
disabled,private,enabled. - string
- The classification label for the project.
- Feature
Flags stringAccess Level - Set the feature flags access level. Valid values are
disabled,private,enabled. - Forked
From List<Pulumi.Projects Git Lab. Outputs. Get Project Forked From Project> - Present if the project is a fork. Contains information about the upstream project.
- Forking
Access stringLevel - Set the forking access level. Valid values are
disabled,private,enabled. - Forks
Count int - The number of forks of the project.
- Group
Runners boolEnabled - Whether group runners are enabled for the project.
- Http
Url stringTo Repo - The HTTP clone URL of the project.
- Id string
- The integer that uniquely identifies the project within the gitlab install.
- Import
Error string - The import error, if it exists, for the project.
- Import
Status string - The import status of the project.
- Import
Type string - The type of import used to create the project (for example
github,bitbucket). - Import
Url string - URL the project was imported from.
- Infrastructure
Access stringLevel - Set the infrastructure access level. Valid values are
disabled,private,enabled. - Issue
Branch stringTemplate - Template used to suggest a branch name when creating one from an issue.
- Issues
Access stringLevel - Set the issues access level. Valid values are
disabled,private,enabled. - Issues
Enabled bool - Whether issues are enabled for the project.
- Issues
Template string - Default description template for new issues.
- Jobs
Enabled bool - Whether jobs are enabled for the project.
- Keep
Latest boolArtifact - Disable or enable the ability to keep the latest artifact for this project.
- Last
Activity stringAt - Last activity time for the project.
- Lfs
Enabled bool - Whether LFS (large file storage) is enabled for the project.
- License
Url string - URL of the project's license file.
- Licenses
List<Pulumi.
Git Lab. Outputs. Get Project License> - Information about the project's license, if one is detected.
- Links Dictionary<string, string>
- Links for the project.
- Marked
For boolDeletion - Whether the project is marked for deletion.
- Marked
For stringDeletion At - Timestamp at which the project was marked for deletion. Premium and Ultimate only.
- Marked
For stringDeletion On - Timestamp at which the project was marked for deletion. Premium and Ultimate only.
- Max
Artifacts intSize - Maximum artifacts size, in MB, for the project. Overrides the instance-wide setting when set.
- Merge
Commit stringTemplate - Template used to create merge commit message in merge requests.
- Merge
Method string - Merge method for the project.
- Merge
Pipelines boolEnabled - Enable or disable merge pipelines.
- Merge
Request stringTitle Regex - Regular expression that merge request titles must match.
- Merge
Request stringTitle Regex Description - Human-readable description of
mergeRequestTitleRegex. - Merge
Requests stringAccess Level - Set the merge requests access level. Valid values are
disabled,private,enabled. - Merge
Requests boolEnabled - Whether merge requests are enabled for the project.
- Merge
Requests stringTemplate - Default description template for new merge requests.
- Merge
Trains boolEnabled - Enable or disable merge trains.
- Merge
Trains boolSkip Train Allowed - Allows merge train merge requests to be merged without waiting for pipelines to finish.
- Mirror bool
- Whether pull mirroring is enabled for the project.
- Mirror
Overwrites boolDiverged Branches - Whether
mirrorOverwritesDivergedBranchesis enabled for the project. - Mirror
Trigger boolBuilds - Whether pull mirroring triggers builds for the project.
- Mirror
User intId - The mirror user ID for the project.
- Model
Experiments stringAccess Level - The visibility of machine learning model experiments.
- Model
Registry stringAccess Level - The visibility of machine learning model registry.
- Monitor
Access stringLevel - Set the monitor access level. Valid values are
disabled,private,enabled. - Mr
Default boolTarget Self - For forks, whether merge requests target the fork itself rather than the upstream project by default.
- Name string
- The name of the project.
- Name
With stringNamespace - In
group / subgroup / projectoruser / projectformat. - Namespace
Id int - The namespace (group or user) ID of the project. Alias for
namespace[0].id. - Namespaces
List<Pulumi.
Git Lab. Outputs. Get Project Namespace> - Namespace of the project (parent group/s).
- Only
Allow boolMerge If All Discussions Are Resolved - Whether
onlyAllowMergeIfAllDiscussionsAreResolvedis enabled for the project. - Only
Allow boolMerge If Pipeline Succeeds - Whether
onlyAllowMergeIfPipelineSucceedsis enabled for the project. - Only
Mirror boolProtected Branches - Whether
onlyMirrorProtectedBranchesis enabled for the project. - Open
Issues intCount - The number of open issues for the project.
- Operations
Access stringLevel - Set the operations access level. Valid values are
disabled,private,enabled. - Owners
List<Pulumi.
Git Lab. Outputs. Get Project Owner> - The owner of the project. Only populated when the calling token has administrator scope.
- Package
Registry stringAccess Level - The visibility of the package registry.
- Packages
Enabled bool - Whether packages are enabled for the project.
- Pages
Access stringLevel - Set the GitLab Pages access level. Valid values are
disabled,private,enabled. - Path string
- The path of the project.
- Path
With stringNamespace - The path of the repository with namespace.
- Permissions
List<Pulumi.
Git Lab. Outputs. Get Project Permission> - Permissions for the project.
- Pre
Receive boolSecret Detection Enabled - Whether pre-receive secret detection is enabled for the project.
- Prevent
Merge boolWithout Jira Issue - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- Printing
Merge boolRequest Link Enabled - Show link to create/view merge request when pushing from the command line.
- Protect
Merge boolRequest Pipelines - Whether pipelines triggered for merge requests run with project secrets and protected variables, instead of the contributor's lower-privileged context.
- Public
Builds bool - If true, jobs can be viewed by non-project members. Alias for
publicJobs. - Public
Jobs bool - If true, jobs can be viewed by non-project members.
- Push
Rules List<Pulumi.Git Lab. Outputs. Get Project Push Rule> - Push rules for the project. Push rules are only available on Enterprise plans and if the authenticated user has permission to read them.
- Readme
Url string - The URL of the project README.
- Releases
Access stringLevel - Set the releases access level. Valid values are
disabled,private,enabled. - Remove
Source boolBranch After Merge - Enable
Delete source branchoption by default for all new merge requests. - Repository
Access stringLevel - Set the repository access level. Valid values are
disabled,private,enabled. - Repository
Storage string - Which storage shard the repository is on. (administrator only)
- Request
Access boolEnabled - Whether requesting access is enabled for the project.
- Requirements
Access stringLevel - Set the requirements access level. Valid values are
disabled,private,enabled. - Requirements
Enabled bool - Whether the requirements feature is enabled. Premium and Ultimate only.
- Resolve
Outdated boolDiff Discussions - Automatically resolve merge request diffs discussions on lines changed with a push.
- Resource
Group stringDefault Process Mode - The default resource group process mode for the project.
- Restrict
User boolDefined Variables - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- Runner
Token intExpiration Interval - Runner token expiration interval, in seconds.
- Runners
Token string - Registration token to use during runner setup.
- Security
And stringCompliance Access Level - Set the security and compliance access level. Valid values are
disabled,private,enabled. - Security
And boolCompliance Enabled - Whether the security and compliance feature is enabled.
- Service
Desk stringAddress - The Service Desk email address for the project.
- Service
Desk boolEnabled - Whether Service Desk is enabled for the project.
- bool
- Whether shared runners are enabled for the project.
-
List<Pulumi.
Git Lab. Outputs. Get Project Shared With Group> - Describes groups which have access shared to this project.
- Snippets
Access stringLevel - Set the snippets access level. Valid values are
disabled,private,enabled. - Snippets
Enabled bool - Whether snippets are enabled for the project.
- Squash
Commit stringTemplate - Template used to create squash commit message in merge requests.
- Squash
Option string - The project's squash option for merge requests (
never,always,defaultOn,defaultOff). - Ssh
Url stringTo Repo - The SSH clone URL of the project.
- Star
Count int - The number of stars on the project.
- Statistics Dictionary<string, int>
- Statistics for the project.
- Suggestion
Commit stringMessage - The commit message used to apply merge request suggestions.
- Tag
Lists List<string> - The list of project topics (formerly project tags).
- Topics List<string>
- The list of topics for the project.
- Updated
At string - The time the project was last updated.
- Visibility string
- The visibility of the project (
private,internal,public). - Visibility
Level string - The visibility of the project. Alias for
visibility. - Web
Url string - URL that can be used to find the project in a browser.
- Wiki
Access stringLevel - Set the wiki access level. Valid values are
disabled,private,enabled. - Wiki
Enabled bool - Whether wiki is enabled for the project.
- Allow
Merge boolOn Skipped Pipeline - Whether
allowMergeOnSkippedPipelineis enabled for the project. - Allow
Pipeline boolTrigger Approve Deployment - Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only.
- Analytics
Access stringLevel - Set the analytics access level. Valid values are
disabled,private,enabled. - Approvals
Before intMerge - The number of approvals needed in a merge request.
- Archived bool
- Whether the project is in read-only mode (archived).
- Auto
Cancel stringPending Pipelines - Auto-cancel pending pipelines. This isn't a boolean, but
enabled/disabled. - Auto
Devops stringDeploy Strategy - Auto Deploy strategy. Valid values are
continuous,manual,timedIncremental. - Auto
Devops boolEnabled - Enable Auto DevOps for this project.
- Auto
Duo boolCode Review Enabled - Whether GitLab Duo code review is enabled for the project.
- Autoclose
Referenced boolIssues - Set whether auto-closing referenced issues on default branch.
- Avatar
Url string - The avatar URL of the project.
- Build
Coverage stringRegex - Build coverage regex for the project.
- Build
Git stringStrategy - The Git strategy. Defaults to
fetch. - Build
Timeout int - The maximum amount of time, in seconds, that a job can run.
- Builds
Access stringLevel - Set the builds access level. Valid values are
disabled,private,enabled. - Can
Create boolMerge Request In - Whether the calling user can create merge requests in this project.
- Ci
Allow boolFork Pipelines To Run In Parent Project - Whether pipelines triggered from merge requests opened from forks may run in the parent project.
- Ci
Config stringPath - CI config file path for the project.
- Ci
Default intGit Depth - Default number of revisions for shallow cloning.
- Ci
Delete intPipelines In Seconds - Pipelines older than the configured time are deleted.
- Ci
Display boolPipeline Variables - Whether pipeline variables are displayed in the UI.
- Ci
Forward boolDeployment Enabled - When a new deployment job starts, skip older deployment jobs that are still pending.
- Ci
Forward boolDeployment Rollback Allowed - Allow job retries even if the deployment job is outdated.
- Ci
Id []stringToken Sub Claim Components - Fields included in the sub claim of the ID Token. Accepts an array starting with
projectPath. The array might also includerefTypeandref. Defaults to["projectPath", "refType", "ref"]. Introduced in GitLab 17.10. - Ci
Job boolToken Scope Enabled - Whether the CI/CD job token access scope is enabled (limits which projects can be accessed using the job token).
- Ci
Opt boolIn Jwt - Whether the project must explicitly opt in to receive ID tokens in CI jobs.
- Ci
Pipeline stringVariables Minimum Override Role - The minimum role required to set variables when running pipelines and jobs. Introduced in GitLab 17.1. Valid values are
developer,maintainer,owner,noOneAllowed. - Ci
Push boolRepository For Job Token Allowed - Whether pushes to the repository using the CI/CD job token are allowed.
- Ci
Restrict stringPipeline Cancellation Role - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer,maintainer,noOne. - Ci
Separated boolCaches - Use separate caches for protected branches.
- Compliance
Frameworks []string - Compliance frameworks applied to the project. Premium and Ultimate only.
- Container
Expiration []GetPolicies Project Container Expiration Policy - The image cleanup policy for this project.
- Container
Registry stringAccess Level - Set visibility of container registry for this project. Valid values are
disabled,private,enabled. - Container
Registry boolEnabled - Whether the container registry is enabled for the project.
- Container
Registry stringImage Prefix - The image prefix used by the container registry for this project.
- Created
At string - Creation time for the project.
- Creator
Id int - Creator ID for the project.
- Custom
Attributes []map[string]string - Custom attributes for the project.
- Default
Branch string - The default branch name of the project.
- Description string
- A description of the project.
- Emails
Disabled bool - Whether email notifications are disabled for the project.
- Emails
Enabled bool - Enable email notifications.
- Empty
Repo bool - Whether the project is empty.
- Enforce
Auth boolChecks On Uploads - Whether authentication checks are enforced when uploading to the project.
- Environments
Access stringLevel - Set the environments access level. Valid values are
disabled,private,enabled. - string
- The classification label for the project.
- Feature
Flags stringAccess Level - Set the feature flags access level. Valid values are
disabled,private,enabled. - Forked
From []GetProjects Project Forked From Project - Present if the project is a fork. Contains information about the upstream project.
- Forking
Access stringLevel - Set the forking access level. Valid values are
disabled,private,enabled. - Forks
Count int - The number of forks of the project.
- Group
Runners boolEnabled - Whether group runners are enabled for the project.
- Http
Url stringTo Repo - The HTTP clone URL of the project.
- Id string
- The integer that uniquely identifies the project within the gitlab install.
- Import
Error string - The import error, if it exists, for the project.
- Import
Status string - The import status of the project.
- Import
Type string - The type of import used to create the project (for example
github,bitbucket). - Import
Url string - URL the project was imported from.
- Infrastructure
Access stringLevel - Set the infrastructure access level. Valid values are
disabled,private,enabled. - Issue
Branch stringTemplate - Template used to suggest a branch name when creating one from an issue.
- Issues
Access stringLevel - Set the issues access level. Valid values are
disabled,private,enabled. - Issues
Enabled bool - Whether issues are enabled for the project.
- Issues
Template string - Default description template for new issues.
- Jobs
Enabled bool - Whether jobs are enabled for the project.
- Keep
Latest boolArtifact - Disable or enable the ability to keep the latest artifact for this project.
- Last
Activity stringAt - Last activity time for the project.
- Lfs
Enabled bool - Whether LFS (large file storage) is enabled for the project.
- License
Url string - URL of the project's license file.
- Licenses
[]Get
Project License - Information about the project's license, if one is detected.
- Links map[string]string
- Links for the project.
- Marked
For boolDeletion - Whether the project is marked for deletion.
- Marked
For stringDeletion At - Timestamp at which the project was marked for deletion. Premium and Ultimate only.
- Marked
For stringDeletion On - Timestamp at which the project was marked for deletion. Premium and Ultimate only.
- Max
Artifacts intSize - Maximum artifacts size, in MB, for the project. Overrides the instance-wide setting when set.
- Merge
Commit stringTemplate - Template used to create merge commit message in merge requests.
- Merge
Method string - Merge method for the project.
- Merge
Pipelines boolEnabled - Enable or disable merge pipelines.
- Merge
Request stringTitle Regex - Regular expression that merge request titles must match.
- Merge
Request stringTitle Regex Description - Human-readable description of
mergeRequestTitleRegex. - Merge
Requests stringAccess Level - Set the merge requests access level. Valid values are
disabled,private,enabled. - Merge
Requests boolEnabled - Whether merge requests are enabled for the project.
- Merge
Requests stringTemplate - Default description template for new merge requests.
- Merge
Trains boolEnabled - Enable or disable merge trains.
- Merge
Trains boolSkip Train Allowed - Allows merge train merge requests to be merged without waiting for pipelines to finish.
- Mirror bool
- Whether pull mirroring is enabled for the project.
- Mirror
Overwrites boolDiverged Branches - Whether
mirrorOverwritesDivergedBranchesis enabled for the project. - Mirror
Trigger boolBuilds - Whether pull mirroring triggers builds for the project.
- Mirror
User intId - The mirror user ID for the project.
- Model
Experiments stringAccess Level - The visibility of machine learning model experiments.
- Model
Registry stringAccess Level - The visibility of machine learning model registry.
- Monitor
Access stringLevel - Set the monitor access level. Valid values are
disabled,private,enabled. - Mr
Default boolTarget Self - For forks, whether merge requests target the fork itself rather than the upstream project by default.
- Name string
- The name of the project.
- Name
With stringNamespace - In
group / subgroup / projectoruser / projectformat. - Namespace
Id int - The namespace (group or user) ID of the project. Alias for
namespace[0].id. - Namespaces
[]Get
Project Namespace - Namespace of the project (parent group/s).
- Only
Allow boolMerge If All Discussions Are Resolved - Whether
onlyAllowMergeIfAllDiscussionsAreResolvedis enabled for the project. - Only
Allow boolMerge If Pipeline Succeeds - Whether
onlyAllowMergeIfPipelineSucceedsis enabled for the project. - Only
Mirror boolProtected Branches - Whether
onlyMirrorProtectedBranchesis enabled for the project. - Open
Issues intCount - The number of open issues for the project.
- Operations
Access stringLevel - Set the operations access level. Valid values are
disabled,private,enabled. - Owners
[]Get
Project Owner - The owner of the project. Only populated when the calling token has administrator scope.
- Package
Registry stringAccess Level - The visibility of the package registry.
- Packages
Enabled bool - Whether packages are enabled for the project.
- Pages
Access stringLevel - Set the GitLab Pages access level. Valid values are
disabled,private,enabled. - Path string
- The path of the project.
- Path
With stringNamespace - The path of the repository with namespace.
- Permissions
[]Get
Project Permission - Permissions for the project.
- Pre
Receive boolSecret Detection Enabled - Whether pre-receive secret detection is enabled for the project.
- Prevent
Merge boolWithout Jira Issue - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- Printing
Merge boolRequest Link Enabled - Show link to create/view merge request when pushing from the command line.
- Protect
Merge boolRequest Pipelines - Whether pipelines triggered for merge requests run with project secrets and protected variables, instead of the contributor's lower-privileged context.
- Public
Builds bool - If true, jobs can be viewed by non-project members. Alias for
publicJobs. - Public
Jobs bool - If true, jobs can be viewed by non-project members.
- Push
Rules []GetProject Push Rule - Push rules for the project. Push rules are only available on Enterprise plans and if the authenticated user has permission to read them.
- Readme
Url string - The URL of the project README.
- Releases
Access stringLevel - Set the releases access level. Valid values are
disabled,private,enabled. - Remove
Source boolBranch After Merge - Enable
Delete source branchoption by default for all new merge requests. - Repository
Access stringLevel - Set the repository access level. Valid values are
disabled,private,enabled. - Repository
Storage string - Which storage shard the repository is on. (administrator only)
- Request
Access boolEnabled - Whether requesting access is enabled for the project.
- Requirements
Access stringLevel - Set the requirements access level. Valid values are
disabled,private,enabled. - Requirements
Enabled bool - Whether the requirements feature is enabled. Premium and Ultimate only.
- Resolve
Outdated boolDiff Discussions - Automatically resolve merge request diffs discussions on lines changed with a push.
- Resource
Group stringDefault Process Mode - The default resource group process mode for the project.
- Restrict
User boolDefined Variables - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- Runner
Token intExpiration Interval - Runner token expiration interval, in seconds.
- Runners
Token string - Registration token to use during runner setup.
- Security
And stringCompliance Access Level - Set the security and compliance access level. Valid values are
disabled,private,enabled. - Security
And boolCompliance Enabled - Whether the security and compliance feature is enabled.
- Service
Desk stringAddress - The Service Desk email address for the project.
- Service
Desk boolEnabled - Whether Service Desk is enabled for the project.
- bool
- Whether shared runners are enabled for the project.
-
[]Get
Project Shared With Group - Describes groups which have access shared to this project.
- Snippets
Access stringLevel - Set the snippets access level. Valid values are
disabled,private,enabled. - Snippets
Enabled bool - Whether snippets are enabled for the project.
- Squash
Commit stringTemplate - Template used to create squash commit message in merge requests.
- Squash
Option string - The project's squash option for merge requests (
never,always,defaultOn,defaultOff). - Ssh
Url stringTo Repo - The SSH clone URL of the project.
- Star
Count int - The number of stars on the project.
- Statistics map[string]int
- Statistics for the project.
- Suggestion
Commit stringMessage - The commit message used to apply merge request suggestions.
- Tag
Lists []string - The list of project topics (formerly project tags).
- Topics []string
- The list of topics for the project.
- Updated
At string - The time the project was last updated.
- Visibility string
- The visibility of the project (
private,internal,public). - Visibility
Level string - The visibility of the project. Alias for
visibility. - Web
Url string - URL that can be used to find the project in a browser.
- Wiki
Access stringLevel - Set the wiki access level. Valid values are
disabled,private,enabled. - Wiki
Enabled bool - Whether wiki is enabled for the project.
- allow_
merge_ boolon_ skipped_ pipeline - Whether
allowMergeOnSkippedPipelineis enabled for the project. - allow_
pipeline_ booltrigger_ approve_ deployment - Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only.
- analytics_
access_ stringlevel - Set the analytics access level. Valid values are
disabled,private,enabled. - approvals_
before_ numbermerge - The number of approvals needed in a merge request.
- archived bool
- Whether the project is in read-only mode (archived).
- auto_
cancel_ stringpending_ pipelines - Auto-cancel pending pipelines. This isn't a boolean, but
enabled/disabled. - auto_
devops_ stringdeploy_ strategy - Auto Deploy strategy. Valid values are
continuous,manual,timedIncremental. - auto_
devops_ boolenabled - Enable Auto DevOps for this project.
- auto_
duo_ boolcode_ review_ enabled - Whether GitLab Duo code review is enabled for the project.
- autoclose_
referenced_ boolissues - Set whether auto-closing referenced issues on default branch.
- avatar_
url string - The avatar URL of the project.
- build_
coverage_ stringregex - Build coverage regex for the project.
- build_
git_ stringstrategy - The Git strategy. Defaults to
fetch. - build_
timeout number - The maximum amount of time, in seconds, that a job can run.
- builds_
access_ stringlevel - Set the builds access level. Valid values are
disabled,private,enabled. - can_
create_ boolmerge_ request_ in - Whether the calling user can create merge requests in this project.
- ci_
allow_ boolfork_ pipelines_ to_ run_ in_ parent_ project - Whether pipelines triggered from merge requests opened from forks may run in the parent project.
- ci_
config_ stringpath - CI config file path for the project.
- ci_
default_ numbergit_ depth - Default number of revisions for shallow cloning.
- ci_
delete_ numberpipelines_ in_ seconds - Pipelines older than the configured time are deleted.
- ci_
display_ boolpipeline_ variables - Whether pipeline variables are displayed in the UI.
- ci_
forward_ booldeployment_ enabled - When a new deployment job starts, skip older deployment jobs that are still pending.
- ci_
forward_ booldeployment_ rollback_ allowed - Allow job retries even if the deployment job is outdated.
- ci_
id_ list(string)token_ sub_ claim_ components - Fields included in the sub claim of the ID Token. Accepts an array starting with
projectPath. The array might also includerefTypeandref. Defaults to["projectPath", "refType", "ref"]. Introduced in GitLab 17.10. - ci_
job_ booltoken_ scope_ enabled - Whether the CI/CD job token access scope is enabled (limits which projects can be accessed using the job token).
- ci_
opt_ boolin_ jwt - Whether the project must explicitly opt in to receive ID tokens in CI jobs.
- ci_
pipeline_ stringvariables_ minimum_ override_ role - The minimum role required to set variables when running pipelines and jobs. Introduced in GitLab 17.1. Valid values are
developer,maintainer,owner,noOneAllowed. - ci_
push_ boolrepository_ for_ job_ token_ allowed - Whether pushes to the repository using the CI/CD job token are allowed.
- ci_
restrict_ stringpipeline_ cancellation_ role - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer,maintainer,noOne. - ci_
separated_ boolcaches - Use separate caches for protected branches.
- compliance_
frameworks list(string) - Compliance frameworks applied to the project. Premium and Ultimate only.
- container_
expiration_ list(object)policies - The image cleanup policy for this project.
- container_
registry_ stringaccess_ level - Set visibility of container registry for this project. Valid values are
disabled,private,enabled. - container_
registry_ boolenabled - Whether the container registry is enabled for the project.
- container_
registry_ stringimage_ prefix - The image prefix used by the container registry for this project.
- created_
at string - Creation time for the project.
- creator_
id number - Creator ID for the project.
- custom_
attributes list(map(string)) - Custom attributes for the project.
- default_
branch string - The default branch name of the project.
- description string
- A description of the project.
- emails_
disabled bool - Whether email notifications are disabled for the project.
- emails_
enabled bool - Enable email notifications.
- empty_
repo bool - Whether the project is empty.
- enforce_
auth_ boolchecks_ on_ uploads - Whether authentication checks are enforced when uploading to the project.
- environments_
access_ stringlevel - Set the environments access level. Valid values are
disabled,private,enabled. - string
- The classification label for the project.
- feature_
flags_ stringaccess_ level - Set the feature flags access level. Valid values are
disabled,private,enabled. - forked_
from_ list(object)projects - Present if the project is a fork. Contains information about the upstream project.
- forking_
access_ stringlevel - Set the forking access level. Valid values are
disabled,private,enabled. - forks_
count number - The number of forks of the project.
- group_
runners_ boolenabled - Whether group runners are enabled for the project.
- http_
url_ stringto_ repo - The HTTP clone URL of the project.
- id string
- The integer that uniquely identifies the project within the gitlab install.
- import_
error string - The import error, if it exists, for the project.
- import_
status string - The import status of the project.
- import_
type string - The type of import used to create the project (for example
github,bitbucket). - import_
url string - URL the project was imported from.
- infrastructure_
access_ stringlevel - Set the infrastructure access level. Valid values are
disabled,private,enabled. - issue_
branch_ stringtemplate - Template used to suggest a branch name when creating one from an issue.
- issues_
access_ stringlevel - Set the issues access level. Valid values are
disabled,private,enabled. - issues_
enabled bool - Whether issues are enabled for the project.
- issues_
template string - Default description template for new issues.
- jobs_
enabled bool - Whether jobs are enabled for the project.
- keep_
latest_ boolartifact - Disable or enable the ability to keep the latest artifact for this project.
- last_
activity_ stringat - Last activity time for the project.
- lfs_
enabled bool - Whether LFS (large file storage) is enabled for the project.
- license_
url string - URL of the project's license file.
- licenses list(object)
- Information about the project's license, if one is detected.
- links map(string)
- Links for the project.
- marked_
for_ booldeletion - Whether the project is marked for deletion.
- marked_
for_ stringdeletion_ at - Timestamp at which the project was marked for deletion. Premium and Ultimate only.
- marked_
for_ stringdeletion_ on - Timestamp at which the project was marked for deletion. Premium and Ultimate only.
- max_
artifacts_ numbersize - Maximum artifacts size, in MB, for the project. Overrides the instance-wide setting when set.
- merge_
commit_ stringtemplate - Template used to create merge commit message in merge requests.
- merge_
method string - Merge method for the project.
- merge_
pipelines_ boolenabled - Enable or disable merge pipelines.
- merge_
request_ stringtitle_ regex - Regular expression that merge request titles must match.
- merge_
request_ stringtitle_ regex_ description - Human-readable description of
mergeRequestTitleRegex. - merge_
requests_ stringaccess_ level - Set the merge requests access level. Valid values are
disabled,private,enabled. - merge_
requests_ boolenabled - Whether merge requests are enabled for the project.
- merge_
requests_ stringtemplate - Default description template for new merge requests.
- merge_
trains_ boolenabled - Enable or disable merge trains.
- merge_
trains_ boolskip_ train_ allowed - Allows merge train merge requests to be merged without waiting for pipelines to finish.
- mirror bool
- Whether pull mirroring is enabled for the project.
- mirror_
overwrites_ booldiverged_ branches - Whether
mirrorOverwritesDivergedBranchesis enabled for the project. - mirror_
trigger_ boolbuilds - Whether pull mirroring triggers builds for the project.
- mirror_
user_ numberid - The mirror user ID for the project.
- model_
experiments_ stringaccess_ level - The visibility of machine learning model experiments.
- model_
registry_ stringaccess_ level - The visibility of machine learning model registry.
- monitor_
access_ stringlevel - Set the monitor access level. Valid values are
disabled,private,enabled. - mr_
default_ booltarget_ self - For forks, whether merge requests target the fork itself rather than the upstream project by default.
- name string
- The name of the project.
- name_
with_ stringnamespace - In
group / subgroup / projectoruser / projectformat. - namespace_
id number - The namespace (group or user) ID of the project. Alias for
namespace[0].id. - namespaces list(object)
- Namespace of the project (parent group/s).
- only_
allow_ boolmerge_ if_ all_ discussions_ are_ resolved - Whether
onlyAllowMergeIfAllDiscussionsAreResolvedis enabled for the project. - only_
allow_ boolmerge_ if_ pipeline_ succeeds - Whether
onlyAllowMergeIfPipelineSucceedsis enabled for the project. - only_
mirror_ boolprotected_ branches - Whether
onlyMirrorProtectedBranchesis enabled for the project. - open_
issues_ numbercount - The number of open issues for the project.
- operations_
access_ stringlevel - Set the operations access level. Valid values are
disabled,private,enabled. - owners list(object)
- The owner of the project. Only populated when the calling token has administrator scope.
- package_
registry_ stringaccess_ level - The visibility of the package registry.
- packages_
enabled bool - Whether packages are enabled for the project.
- pages_
access_ stringlevel - Set the GitLab Pages access level. Valid values are
disabled,private,enabled. - path string
- The path of the project.
- path_
with_ stringnamespace - The path of the repository with namespace.
- permissions list(object)
- Permissions for the project.
- pre_
receive_ boolsecret_ detection_ enabled - Whether pre-receive secret detection is enabled for the project.
- prevent_
merge_ boolwithout_ jira_ issue - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- printing_
merge_ boolrequest_ link_ enabled - Show link to create/view merge request when pushing from the command line.
- protect_
merge_ boolrequest_ pipelines - Whether pipelines triggered for merge requests run with project secrets and protected variables, instead of the contributor's lower-privileged context.
- public_
builds bool - If true, jobs can be viewed by non-project members. Alias for
publicJobs. - public_
jobs bool - If true, jobs can be viewed by non-project members.
- push_
rules list(object) - Push rules for the project. Push rules are only available on Enterprise plans and if the authenticated user has permission to read them.
- readme_
url string - The URL of the project README.
- releases_
access_ stringlevel - Set the releases access level. Valid values are
disabled,private,enabled. - remove_
source_ boolbranch_ after_ merge - Enable
Delete source branchoption by default for all new merge requests. - repository_
access_ stringlevel - Set the repository access level. Valid values are
disabled,private,enabled. - repository_
storage string - Which storage shard the repository is on. (administrator only)
- request_
access_ boolenabled - Whether requesting access is enabled for the project.
- requirements_
access_ stringlevel - Set the requirements access level. Valid values are
disabled,private,enabled. - requirements_
enabled bool - Whether the requirements feature is enabled. Premium and Ultimate only.
- resolve_
outdated_ booldiff_ discussions - Automatically resolve merge request diffs discussions on lines changed with a push.
- resource_
group_ stringdefault_ process_ mode - The default resource group process mode for the project.
- restrict_
user_ booldefined_ variables - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- runner_
token_ numberexpiration_ interval - Runner token expiration interval, in seconds.
- runners_
token string - Registration token to use during runner setup.
- security_
and_ stringcompliance_ access_ level - Set the security and compliance access level. Valid values are
disabled,private,enabled. - security_
and_ boolcompliance_ enabled - Whether the security and compliance feature is enabled.
- service_
desk_ stringaddress - The Service Desk email address for the project.
- service_
desk_ boolenabled - Whether Service Desk is enabled for the project.
- bool
- Whether shared runners are enabled for the project.
- list(object)
- Describes groups which have access shared to this project.
- snippets_
access_ stringlevel - Set the snippets access level. Valid values are
disabled,private,enabled. - snippets_
enabled bool - Whether snippets are enabled for the project.
- squash_
commit_ stringtemplate - Template used to create squash commit message in merge requests.
- squash_
option string - The project's squash option for merge requests (
never,always,defaultOn,defaultOff). - ssh_
url_ stringto_ repo - The SSH clone URL of the project.
- star_
count number - The number of stars on the project.
- statistics map(number)
- Statistics for the project.
- suggestion_
commit_ stringmessage - The commit message used to apply merge request suggestions.
- tag_
lists list(string) - The list of project topics (formerly project tags).
- topics list(string)
- The list of topics for the project.
- updated_
at string - The time the project was last updated.
- visibility string
- The visibility of the project (
private,internal,public). - visibility_
level string - The visibility of the project. Alias for
visibility. - web_
url string - URL that can be used to find the project in a browser.
- wiki_
access_ stringlevel - Set the wiki access level. Valid values are
disabled,private,enabled. - wiki_
enabled bool - Whether wiki is enabled for the project.
- allow
Merge BooleanOn Skipped Pipeline - Whether
allowMergeOnSkippedPipelineis enabled for the project. - allow
Pipeline BooleanTrigger Approve Deployment - Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only.
- analytics
Access StringLevel - Set the analytics access level. Valid values are
disabled,private,enabled. - approvals
Before IntegerMerge - The number of approvals needed in a merge request.
- archived Boolean
- Whether the project is in read-only mode (archived).
- auto
Cancel StringPending Pipelines - Auto-cancel pending pipelines. This isn't a boolean, but
enabled/disabled. - auto
Devops StringDeploy Strategy - Auto Deploy strategy. Valid values are
continuous,manual,timedIncremental. - auto
Devops BooleanEnabled - Enable Auto DevOps for this project.
- auto
Duo BooleanCode Review Enabled - Whether GitLab Duo code review is enabled for the project.
- autoclose
Referenced BooleanIssues - Set whether auto-closing referenced issues on default branch.
- avatar
Url String - The avatar URL of the project.
- build
Coverage StringRegex - Build coverage regex for the project.
- build
Git StringStrategy - The Git strategy. Defaults to
fetch. - build
Timeout Integer - The maximum amount of time, in seconds, that a job can run.
- builds
Access StringLevel - Set the builds access level. Valid values are
disabled,private,enabled. - can
Create BooleanMerge Request In - Whether the calling user can create merge requests in this project.
- ci
Allow BooleanFork Pipelines To Run In Parent Project - Whether pipelines triggered from merge requests opened from forks may run in the parent project.
- ci
Config StringPath - CI config file path for the project.
- ci
Default IntegerGit Depth - Default number of revisions for shallow cloning.
- ci
Delete IntegerPipelines In Seconds - Pipelines older than the configured time are deleted.
- ci
Display BooleanPipeline Variables - Whether pipeline variables are displayed in the UI.
- ci
Forward BooleanDeployment Enabled - When a new deployment job starts, skip older deployment jobs that are still pending.
- ci
Forward BooleanDeployment Rollback Allowed - Allow job retries even if the deployment job is outdated.
- ci
Id List<String>Token Sub Claim Components - Fields included in the sub claim of the ID Token. Accepts an array starting with
projectPath. The array might also includerefTypeandref. Defaults to["projectPath", "refType", "ref"]. Introduced in GitLab 17.10. - ci
Job BooleanToken Scope Enabled - Whether the CI/CD job token access scope is enabled (limits which projects can be accessed using the job token).
- ci
Opt BooleanIn Jwt - Whether the project must explicitly opt in to receive ID tokens in CI jobs.
- ci
Pipeline StringVariables Minimum Override Role - The minimum role required to set variables when running pipelines and jobs. Introduced in GitLab 17.1. Valid values are
developer,maintainer,owner,noOneAllowed. - ci
Push BooleanRepository For Job Token Allowed - Whether pushes to the repository using the CI/CD job token are allowed.
- ci
Restrict StringPipeline Cancellation Role - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer,maintainer,noOne. - ci
Separated BooleanCaches - Use separate caches for protected branches.
- compliance
Frameworks List<String> - Compliance frameworks applied to the project. Premium and Ultimate only.
- container
Expiration List<GetPolicies Project Container Expiration Policy> - The image cleanup policy for this project.
- container
Registry StringAccess Level - Set visibility of container registry for this project. Valid values are
disabled,private,enabled. - container
Registry BooleanEnabled - Whether the container registry is enabled for the project.
- container
Registry StringImage Prefix - The image prefix used by the container registry for this project.
- created
At String - Creation time for the project.
- creator
Id Integer - Creator ID for the project.
- custom
Attributes List<Map<String,String>> - Custom attributes for the project.
- default
Branch String - The default branch name of the project.
- description String
- A description of the project.
- emails
Disabled Boolean - Whether email notifications are disabled for the project.
- emails
Enabled Boolean - Enable email notifications.
- empty
Repo Boolean - Whether the project is empty.
- enforce
Auth BooleanChecks On Uploads - Whether authentication checks are enforced when uploading to the project.
- environments
Access StringLevel - Set the environments access level. Valid values are
disabled,private,enabled. - String
- The classification label for the project.
- feature
Flags StringAccess Level - Set the feature flags access level. Valid values are
disabled,private,enabled. - forked
From List<GetProjects Project Forked From Project> - Present if the project is a fork. Contains information about the upstream project.
- forking
Access StringLevel - Set the forking access level. Valid values are
disabled,private,enabled. - forks
Count Integer - The number of forks of the project.
- group
Runners BooleanEnabled - Whether group runners are enabled for the project.
- http
Url StringTo Repo - The HTTP clone URL of the project.
- id String
- The integer that uniquely identifies the project within the gitlab install.
- import
Error String - The import error, if it exists, for the project.
- import
Status String - The import status of the project.
- import
Type String - The type of import used to create the project (for example
github,bitbucket). - import
Url String - URL the project was imported from.
- infrastructure
Access StringLevel - Set the infrastructure access level. Valid values are
disabled,private,enabled. - issue
Branch StringTemplate - Template used to suggest a branch name when creating one from an issue.
- issues
Access StringLevel - Set the issues access level. Valid values are
disabled,private,enabled. - issues
Enabled Boolean - Whether issues are enabled for the project.
- issues
Template String - Default description template for new issues.
- jobs
Enabled Boolean - Whether jobs are enabled for the project.
- keep
Latest BooleanArtifact - Disable or enable the ability to keep the latest artifact for this project.
- last
Activity StringAt - Last activity time for the project.
- lfs
Enabled Boolean - Whether LFS (large file storage) is enabled for the project.
- license
Url String - URL of the project's license file.
- licenses
List<Get
Project License> - Information about the project's license, if one is detected.
- links Map<String,String>
- Links for the project.
- marked
For BooleanDeletion - Whether the project is marked for deletion.
- marked
For StringDeletion At - Timestamp at which the project was marked for deletion. Premium and Ultimate only.
- marked
For StringDeletion On - Timestamp at which the project was marked for deletion. Premium and Ultimate only.
- max
Artifacts IntegerSize - Maximum artifacts size, in MB, for the project. Overrides the instance-wide setting when set.
- merge
Commit StringTemplate - Template used to create merge commit message in merge requests.
- merge
Method String - Merge method for the project.
- merge
Pipelines BooleanEnabled - Enable or disable merge pipelines.
- merge
Request StringTitle Regex - Regular expression that merge request titles must match.
- merge
Request StringTitle Regex Description - Human-readable description of
mergeRequestTitleRegex. - merge
Requests StringAccess Level - Set the merge requests access level. Valid values are
disabled,private,enabled. - merge
Requests BooleanEnabled - Whether merge requests are enabled for the project.
- merge
Requests StringTemplate - Default description template for new merge requests.
- merge
Trains BooleanEnabled - Enable or disable merge trains.
- merge
Trains BooleanSkip Train Allowed - Allows merge train merge requests to be merged without waiting for pipelines to finish.
- mirror Boolean
- Whether pull mirroring is enabled for the project.
- mirror
Overwrites BooleanDiverged Branches - Whether
mirrorOverwritesDivergedBranchesis enabled for the project. - mirror
Trigger BooleanBuilds - Whether pull mirroring triggers builds for the project.
- mirror
User IntegerId - The mirror user ID for the project.
- model
Experiments StringAccess Level - The visibility of machine learning model experiments.
- model
Registry StringAccess Level - The visibility of machine learning model registry.
- monitor
Access StringLevel - Set the monitor access level. Valid values are
disabled,private,enabled. - mr
Default BooleanTarget Self - For forks, whether merge requests target the fork itself rather than the upstream project by default.
- name String
- The name of the project.
- name
With StringNamespace - In
group / subgroup / projectoruser / projectformat. - namespace
Id Integer - The namespace (group or user) ID of the project. Alias for
namespace[0].id. - namespaces
List<Get
Project Namespace> - Namespace of the project (parent group/s).
- only
Allow BooleanMerge If All Discussions Are Resolved - Whether
onlyAllowMergeIfAllDiscussionsAreResolvedis enabled for the project. - only
Allow BooleanMerge If Pipeline Succeeds - Whether
onlyAllowMergeIfPipelineSucceedsis enabled for the project. - only
Mirror BooleanProtected Branches - Whether
onlyMirrorProtectedBranchesis enabled for the project. - open
Issues IntegerCount - The number of open issues for the project.
- operations
Access StringLevel - Set the operations access level. Valid values are
disabled,private,enabled. - owners
List<Get
Project Owner> - The owner of the project. Only populated when the calling token has administrator scope.
- package
Registry StringAccess Level - The visibility of the package registry.
- packages
Enabled Boolean - Whether packages are enabled for the project.
- pages
Access StringLevel - Set the GitLab Pages access level. Valid values are
disabled,private,enabled. - path String
- The path of the project.
- path
With StringNamespace - The path of the repository with namespace.
- permissions
List<Get
Project Permission> - Permissions for the project.
- pre
Receive BooleanSecret Detection Enabled - Whether pre-receive secret detection is enabled for the project.
- prevent
Merge BooleanWithout Jira Issue - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- printing
Merge BooleanRequest Link Enabled - Show link to create/view merge request when pushing from the command line.
- protect
Merge BooleanRequest Pipelines - Whether pipelines triggered for merge requests run with project secrets and protected variables, instead of the contributor's lower-privileged context.
- public
Builds Boolean - If true, jobs can be viewed by non-project members. Alias for
publicJobs. - public
Jobs Boolean - If true, jobs can be viewed by non-project members.
- push
Rules List<GetProject Push Rule> - Push rules for the project. Push rules are only available on Enterprise plans and if the authenticated user has permission to read them.
- readme
Url String - The URL of the project README.
- releases
Access StringLevel - Set the releases access level. Valid values are
disabled,private,enabled. - remove
Source BooleanBranch After Merge - Enable
Delete source branchoption by default for all new merge requests. - repository
Access StringLevel - Set the repository access level. Valid values are
disabled,private,enabled. - repository
Storage String - Which storage shard the repository is on. (administrator only)
- request
Access BooleanEnabled - Whether requesting access is enabled for the project.
- requirements
Access StringLevel - Set the requirements access level. Valid values are
disabled,private,enabled. - requirements
Enabled Boolean - Whether the requirements feature is enabled. Premium and Ultimate only.
- resolve
Outdated BooleanDiff Discussions - Automatically resolve merge request diffs discussions on lines changed with a push.
- resource
Group StringDefault Process Mode - The default resource group process mode for the project.
- restrict
User BooleanDefined Variables - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- runner
Token IntegerExpiration Interval - Runner token expiration interval, in seconds.
- runners
Token String - Registration token to use during runner setup.
- security
And StringCompliance Access Level - Set the security and compliance access level. Valid values are
disabled,private,enabled. - security
And BooleanCompliance Enabled - Whether the security and compliance feature is enabled.
- service
Desk StringAddress - The Service Desk email address for the project.
- service
Desk BooleanEnabled - Whether Service Desk is enabled for the project.
- Boolean
- Whether shared runners are enabled for the project.
-
List<Get
Project Shared With Group> - Describes groups which have access shared to this project.
- snippets
Access StringLevel - Set the snippets access level. Valid values are
disabled,private,enabled. - snippets
Enabled Boolean - Whether snippets are enabled for the project.
- squash
Commit StringTemplate - Template used to create squash commit message in merge requests.
- squash
Option String - The project's squash option for merge requests (
never,always,defaultOn,defaultOff). - ssh
Url StringTo Repo - The SSH clone URL of the project.
- star
Count Integer - The number of stars on the project.
- statistics Map<String,Integer>
- Statistics for the project.
- suggestion
Commit StringMessage - The commit message used to apply merge request suggestions.
- tag
Lists List<String> - The list of project topics (formerly project tags).
- topics List<String>
- The list of topics for the project.
- updated
At String - The time the project was last updated.
- visibility String
- The visibility of the project (
private,internal,public). - visibility
Level String - The visibility of the project. Alias for
visibility. - web
Url String - URL that can be used to find the project in a browser.
- wiki
Access StringLevel - Set the wiki access level. Valid values are
disabled,private,enabled. - wiki
Enabled Boolean - Whether wiki is enabled for the project.
- allow
Merge booleanOn Skipped Pipeline - Whether
allowMergeOnSkippedPipelineis enabled for the project. - allow
Pipeline booleanTrigger Approve Deployment - Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only.
- analytics
Access stringLevel - Set the analytics access level. Valid values are
disabled,private,enabled. - approvals
Before numberMerge - The number of approvals needed in a merge request.
- archived boolean
- Whether the project is in read-only mode (archived).
- auto
Cancel stringPending Pipelines - Auto-cancel pending pipelines. This isn't a boolean, but
enabled/disabled. - auto
Devops stringDeploy Strategy - Auto Deploy strategy. Valid values are
continuous,manual,timedIncremental. - auto
Devops booleanEnabled - Enable Auto DevOps for this project.
- auto
Duo booleanCode Review Enabled - Whether GitLab Duo code review is enabled for the project.
- autoclose
Referenced booleanIssues - Set whether auto-closing referenced issues on default branch.
- avatar
Url string - The avatar URL of the project.
- build
Coverage stringRegex - Build coverage regex for the project.
- build
Git stringStrategy - The Git strategy. Defaults to
fetch. - build
Timeout number - The maximum amount of time, in seconds, that a job can run.
- builds
Access stringLevel - Set the builds access level. Valid values are
disabled,private,enabled. - can
Create booleanMerge Request In - Whether the calling user can create merge requests in this project.
- ci
Allow booleanFork Pipelines To Run In Parent Project - Whether pipelines triggered from merge requests opened from forks may run in the parent project.
- ci
Config stringPath - CI config file path for the project.
- ci
Default numberGit Depth - Default number of revisions for shallow cloning.
- ci
Delete numberPipelines In Seconds - Pipelines older than the configured time are deleted.
- ci
Display booleanPipeline Variables - Whether pipeline variables are displayed in the UI.
- ci
Forward booleanDeployment Enabled - When a new deployment job starts, skip older deployment jobs that are still pending.
- ci
Forward booleanDeployment Rollback Allowed - Allow job retries even if the deployment job is outdated.
- ci
Id string[]Token Sub Claim Components - Fields included in the sub claim of the ID Token. Accepts an array starting with
projectPath. The array might also includerefTypeandref. Defaults to["projectPath", "refType", "ref"]. Introduced in GitLab 17.10. - ci
Job booleanToken Scope Enabled - Whether the CI/CD job token access scope is enabled (limits which projects can be accessed using the job token).
- ci
Opt booleanIn Jwt - Whether the project must explicitly opt in to receive ID tokens in CI jobs.
- ci
Pipeline stringVariables Minimum Override Role - The minimum role required to set variables when running pipelines and jobs. Introduced in GitLab 17.1. Valid values are
developer,maintainer,owner,noOneAllowed. - ci
Push booleanRepository For Job Token Allowed - Whether pushes to the repository using the CI/CD job token are allowed.
- ci
Restrict stringPipeline Cancellation Role - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer,maintainer,noOne. - ci
Separated booleanCaches - Use separate caches for protected branches.
- compliance
Frameworks string[] - Compliance frameworks applied to the project. Premium and Ultimate only.
- container
Expiration GetPolicies Project Container Expiration Policy[] - The image cleanup policy for this project.
- container
Registry stringAccess Level - Set visibility of container registry for this project. Valid values are
disabled,private,enabled. - container
Registry booleanEnabled - Whether the container registry is enabled for the project.
- container
Registry stringImage Prefix - The image prefix used by the container registry for this project.
- created
At string - Creation time for the project.
- creator
Id number - Creator ID for the project.
- custom
Attributes {[key: string]: string}[] - Custom attributes for the project.
- default
Branch string - The default branch name of the project.
- description string
- A description of the project.
- emails
Disabled boolean - Whether email notifications are disabled for the project.
- emails
Enabled boolean - Enable email notifications.
- empty
Repo boolean - Whether the project is empty.
- enforce
Auth booleanChecks On Uploads - Whether authentication checks are enforced when uploading to the project.
- environments
Access stringLevel - Set the environments access level. Valid values are
disabled,private,enabled. - string
- The classification label for the project.
- feature
Flags stringAccess Level - Set the feature flags access level. Valid values are
disabled,private,enabled. - forked
From GetProjects Project Forked From Project[] - Present if the project is a fork. Contains information about the upstream project.
- forking
Access stringLevel - Set the forking access level. Valid values are
disabled,private,enabled. - forks
Count number - The number of forks of the project.
- group
Runners booleanEnabled - Whether group runners are enabled for the project.
- http
Url stringTo Repo - The HTTP clone URL of the project.
- id string
- The integer that uniquely identifies the project within the gitlab install.
- import
Error string - The import error, if it exists, for the project.
- import
Status string - The import status of the project.
- import
Type string - The type of import used to create the project (for example
github,bitbucket). - import
Url string - URL the project was imported from.
- infrastructure
Access stringLevel - Set the infrastructure access level. Valid values are
disabled,private,enabled. - issue
Branch stringTemplate - Template used to suggest a branch name when creating one from an issue.
- issues
Access stringLevel - Set the issues access level. Valid values are
disabled,private,enabled. - issues
Enabled boolean - Whether issues are enabled for the project.
- issues
Template string - Default description template for new issues.
- jobs
Enabled boolean - Whether jobs are enabled for the project.
- keep
Latest booleanArtifact - Disable or enable the ability to keep the latest artifact for this project.
- last
Activity stringAt - Last activity time for the project.
- lfs
Enabled boolean - Whether LFS (large file storage) is enabled for the project.
- license
Url string - URL of the project's license file.
- licenses
Get
Project License[] - Information about the project's license, if one is detected.
- links {[key: string]: string}
- Links for the project.
- marked
For booleanDeletion - Whether the project is marked for deletion.
- marked
For stringDeletion At - Timestamp at which the project was marked for deletion. Premium and Ultimate only.
- marked
For stringDeletion On - Timestamp at which the project was marked for deletion. Premium and Ultimate only.
- max
Artifacts numberSize - Maximum artifacts size, in MB, for the project. Overrides the instance-wide setting when set.
- merge
Commit stringTemplate - Template used to create merge commit message in merge requests.
- merge
Method string - Merge method for the project.
- merge
Pipelines booleanEnabled - Enable or disable merge pipelines.
- merge
Request stringTitle Regex - Regular expression that merge request titles must match.
- merge
Request stringTitle Regex Description - Human-readable description of
mergeRequestTitleRegex. - merge
Requests stringAccess Level - Set the merge requests access level. Valid values are
disabled,private,enabled. - merge
Requests booleanEnabled - Whether merge requests are enabled for the project.
- merge
Requests stringTemplate - Default description template for new merge requests.
- merge
Trains booleanEnabled - Enable or disable merge trains.
- merge
Trains booleanSkip Train Allowed - Allows merge train merge requests to be merged without waiting for pipelines to finish.
- mirror boolean
- Whether pull mirroring is enabled for the project.
- mirror
Overwrites booleanDiverged Branches - Whether
mirrorOverwritesDivergedBranchesis enabled for the project. - mirror
Trigger booleanBuilds - Whether pull mirroring triggers builds for the project.
- mirror
User numberId - The mirror user ID for the project.
- model
Experiments stringAccess Level - The visibility of machine learning model experiments.
- model
Registry stringAccess Level - The visibility of machine learning model registry.
- monitor
Access stringLevel - Set the monitor access level. Valid values are
disabled,private,enabled. - mr
Default booleanTarget Self - For forks, whether merge requests target the fork itself rather than the upstream project by default.
- name string
- The name of the project.
- name
With stringNamespace - In
group / subgroup / projectoruser / projectformat. - namespace
Id number - The namespace (group or user) ID of the project. Alias for
namespace[0].id. - namespaces
Get
Project Namespace[] - Namespace of the project (parent group/s).
- only
Allow booleanMerge If All Discussions Are Resolved - Whether
onlyAllowMergeIfAllDiscussionsAreResolvedis enabled for the project. - only
Allow booleanMerge If Pipeline Succeeds - Whether
onlyAllowMergeIfPipelineSucceedsis enabled for the project. - only
Mirror booleanProtected Branches - Whether
onlyMirrorProtectedBranchesis enabled for the project. - open
Issues numberCount - The number of open issues for the project.
- operations
Access stringLevel - Set the operations access level. Valid values are
disabled,private,enabled. - owners
Get
Project Owner[] - The owner of the project. Only populated when the calling token has administrator scope.
- package
Registry stringAccess Level - The visibility of the package registry.
- packages
Enabled boolean - Whether packages are enabled for the project.
- pages
Access stringLevel - Set the GitLab Pages access level. Valid values are
disabled,private,enabled. - path string
- The path of the project.
- path
With stringNamespace - The path of the repository with namespace.
- permissions
Get
Project Permission[] - Permissions for the project.
- pre
Receive booleanSecret Detection Enabled - Whether pre-receive secret detection is enabled for the project.
- prevent
Merge booleanWithout Jira Issue - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- printing
Merge booleanRequest Link Enabled - Show link to create/view merge request when pushing from the command line.
- protect
Merge booleanRequest Pipelines - Whether pipelines triggered for merge requests run with project secrets and protected variables, instead of the contributor's lower-privileged context.
- public
Builds boolean - If true, jobs can be viewed by non-project members. Alias for
publicJobs. - public
Jobs boolean - If true, jobs can be viewed by non-project members.
- push
Rules GetProject Push Rule[] - Push rules for the project. Push rules are only available on Enterprise plans and if the authenticated user has permission to read them.
- readme
Url string - The URL of the project README.
- releases
Access stringLevel - Set the releases access level. Valid values are
disabled,private,enabled. - remove
Source booleanBranch After Merge - Enable
Delete source branchoption by default for all new merge requests. - repository
Access stringLevel - Set the repository access level. Valid values are
disabled,private,enabled. - repository
Storage string - Which storage shard the repository is on. (administrator only)
- request
Access booleanEnabled - Whether requesting access is enabled for the project.
- requirements
Access stringLevel - Set the requirements access level. Valid values are
disabled,private,enabled. - requirements
Enabled boolean - Whether the requirements feature is enabled. Premium and Ultimate only.
- resolve
Outdated booleanDiff Discussions - Automatically resolve merge request diffs discussions on lines changed with a push.
- resource
Group stringDefault Process Mode - The default resource group process mode for the project.
- restrict
User booleanDefined Variables - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- runner
Token numberExpiration Interval - Runner token expiration interval, in seconds.
- runners
Token string - Registration token to use during runner setup.
- security
And stringCompliance Access Level - Set the security and compliance access level. Valid values are
disabled,private,enabled. - security
And booleanCompliance Enabled - Whether the security and compliance feature is enabled.
- service
Desk stringAddress - The Service Desk email address for the project.
- service
Desk booleanEnabled - Whether Service Desk is enabled for the project.
- boolean
- Whether shared runners are enabled for the project.
-
Get
Project Shared With Group[] - Describes groups which have access shared to this project.
- snippets
Access stringLevel - Set the snippets access level. Valid values are
disabled,private,enabled. - snippets
Enabled boolean - Whether snippets are enabled for the project.
- squash
Commit stringTemplate - Template used to create squash commit message in merge requests.
- squash
Option string - The project's squash option for merge requests (
never,always,defaultOn,defaultOff). - ssh
Url stringTo Repo - The SSH clone URL of the project.
- star
Count number - The number of stars on the project.
- statistics {[key: string]: number}
- Statistics for the project.
- suggestion
Commit stringMessage - The commit message used to apply merge request suggestions.
- tag
Lists string[] - The list of project topics (formerly project tags).
- topics string[]
- The list of topics for the project.
- updated
At string - The time the project was last updated.
- visibility string
- The visibility of the project (
private,internal,public). - visibility
Level string - The visibility of the project. Alias for
visibility. - web
Url string - URL that can be used to find the project in a browser.
- wiki
Access stringLevel - Set the wiki access level. Valid values are
disabled,private,enabled. - wiki
Enabled boolean - Whether wiki is enabled for the project.
- allow_
merge_ boolon_ skipped_ pipeline - Whether
allowMergeOnSkippedPipelineis enabled for the project. - allow_
pipeline_ booltrigger_ approve_ deployment - Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only.
- analytics_
access_ strlevel - Set the analytics access level. Valid values are
disabled,private,enabled. - approvals_
before_ intmerge - The number of approvals needed in a merge request.
- archived bool
- Whether the project is in read-only mode (archived).
- auto_
cancel_ strpending_ pipelines - Auto-cancel pending pipelines. This isn't a boolean, but
enabled/disabled. - auto_
devops_ strdeploy_ strategy - Auto Deploy strategy. Valid values are
continuous,manual,timedIncremental. - auto_
devops_ boolenabled - Enable Auto DevOps for this project.
- auto_
duo_ boolcode_ review_ enabled - Whether GitLab Duo code review is enabled for the project.
- autoclose_
referenced_ boolissues - Set whether auto-closing referenced issues on default branch.
- avatar_
url str - The avatar URL of the project.
- build_
coverage_ strregex - Build coverage regex for the project.
- build_
git_ strstrategy - The Git strategy. Defaults to
fetch. - build_
timeout int - The maximum amount of time, in seconds, that a job can run.
- builds_
access_ strlevel - Set the builds access level. Valid values are
disabled,private,enabled. - can_
create_ boolmerge_ request_ in - Whether the calling user can create merge requests in this project.
- ci_
allow_ boolfork_ pipelines_ to_ run_ in_ parent_ project - Whether pipelines triggered from merge requests opened from forks may run in the parent project.
- ci_
config_ strpath - CI config file path for the project.
- ci_
default_ intgit_ depth - Default number of revisions for shallow cloning.
- ci_
delete_ intpipelines_ in_ seconds - Pipelines older than the configured time are deleted.
- ci_
display_ boolpipeline_ variables - Whether pipeline variables are displayed in the UI.
- ci_
forward_ booldeployment_ enabled - When a new deployment job starts, skip older deployment jobs that are still pending.
- ci_
forward_ booldeployment_ rollback_ allowed - Allow job retries even if the deployment job is outdated.
- ci_
id_ Sequence[str]token_ sub_ claim_ components - Fields included in the sub claim of the ID Token. Accepts an array starting with
projectPath. The array might also includerefTypeandref. Defaults to["projectPath", "refType", "ref"]. Introduced in GitLab 17.10. - ci_
job_ booltoken_ scope_ enabled - Whether the CI/CD job token access scope is enabled (limits which projects can be accessed using the job token).
- ci_
opt_ boolin_ jwt - Whether the project must explicitly opt in to receive ID tokens in CI jobs.
- ci_
pipeline_ strvariables_ minimum_ override_ role - The minimum role required to set variables when running pipelines and jobs. Introduced in GitLab 17.1. Valid values are
developer,maintainer,owner,noOneAllowed. - ci_
push_ boolrepository_ for_ job_ token_ allowed - Whether pushes to the repository using the CI/CD job token are allowed.
- ci_
restrict_ strpipeline_ cancellation_ role - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer,maintainer,noOne. - ci_
separated_ boolcaches - Use separate caches for protected branches.
- compliance_
frameworks Sequence[str] - Compliance frameworks applied to the project. Premium and Ultimate only.
- container_
expiration_ Sequence[Getpolicies Project Container Expiration Policy] - The image cleanup policy for this project.
- container_
registry_ straccess_ level - Set visibility of container registry for this project. Valid values are
disabled,private,enabled. - container_
registry_ boolenabled - Whether the container registry is enabled for the project.
- container_
registry_ strimage_ prefix - The image prefix used by the container registry for this project.
- created_
at str - Creation time for the project.
- creator_
id int - Creator ID for the project.
- custom_
attributes Sequence[Mapping[str, str]] - Custom attributes for the project.
- default_
branch str - The default branch name of the project.
- description str
- A description of the project.
- emails_
disabled bool - Whether email notifications are disabled for the project.
- emails_
enabled bool - Enable email notifications.
- empty_
repo bool - Whether the project is empty.
- enforce_
auth_ boolchecks_ on_ uploads - Whether authentication checks are enforced when uploading to the project.
- environments_
access_ strlevel - Set the environments access level. Valid values are
disabled,private,enabled. - str
- The classification label for the project.
- feature_
flags_ straccess_ level - Set the feature flags access level. Valid values are
disabled,private,enabled. - forked_
from_ Sequence[Getprojects Project Forked From Project] - Present if the project is a fork. Contains information about the upstream project.
- forking_
access_ strlevel - Set the forking access level. Valid values are
disabled,private,enabled. - forks_
count int - The number of forks of the project.
- group_
runners_ boolenabled - Whether group runners are enabled for the project.
- http_
url_ strto_ repo - The HTTP clone URL of the project.
- id str
- The integer that uniquely identifies the project within the gitlab install.
- import_
error str - The import error, if it exists, for the project.
- import_
status str - The import status of the project.
- import_
type str - The type of import used to create the project (for example
github,bitbucket). - import_
url str - URL the project was imported from.
- infrastructure_
access_ strlevel - Set the infrastructure access level. Valid values are
disabled,private,enabled. - issue_
branch_ strtemplate - Template used to suggest a branch name when creating one from an issue.
- issues_
access_ strlevel - Set the issues access level. Valid values are
disabled,private,enabled. - issues_
enabled bool - Whether issues are enabled for the project.
- issues_
template str - Default description template for new issues.
- jobs_
enabled bool - Whether jobs are enabled for the project.
- keep_
latest_ boolartifact - Disable or enable the ability to keep the latest artifact for this project.
- last_
activity_ strat - Last activity time for the project.
- lfs_
enabled bool - Whether LFS (large file storage) is enabled for the project.
- license_
url str - URL of the project's license file.
- licenses
Sequence[Get
Project License] - Information about the project's license, if one is detected.
- links Mapping[str, str]
- Links for the project.
- marked_
for_ booldeletion - Whether the project is marked for deletion.
- marked_
for_ strdeletion_ at - Timestamp at which the project was marked for deletion. Premium and Ultimate only.
- marked_
for_ strdeletion_ on - Timestamp at which the project was marked for deletion. Premium and Ultimate only.
- max_
artifacts_ intsize - Maximum artifacts size, in MB, for the project. Overrides the instance-wide setting when set.
- merge_
commit_ strtemplate - Template used to create merge commit message in merge requests.
- merge_
method str - Merge method for the project.
- merge_
pipelines_ boolenabled - Enable or disable merge pipelines.
- merge_
request_ strtitle_ regex - Regular expression that merge request titles must match.
- merge_
request_ strtitle_ regex_ description - Human-readable description of
mergeRequestTitleRegex. - merge_
requests_ straccess_ level - Set the merge requests access level. Valid values are
disabled,private,enabled. - merge_
requests_ boolenabled - Whether merge requests are enabled for the project.
- merge_
requests_ strtemplate - Default description template for new merge requests.
- merge_
trains_ boolenabled - Enable or disable merge trains.
- merge_
trains_ boolskip_ train_ allowed - Allows merge train merge requests to be merged without waiting for pipelines to finish.
- mirror bool
- Whether pull mirroring is enabled for the project.
- mirror_
overwrites_ booldiverged_ branches - Whether
mirrorOverwritesDivergedBranchesis enabled for the project. - mirror_
trigger_ boolbuilds - Whether pull mirroring triggers builds for the project.
- mirror_
user_ intid - The mirror user ID for the project.
- model_
experiments_ straccess_ level - The visibility of machine learning model experiments.
- model_
registry_ straccess_ level - The visibility of machine learning model registry.
- monitor_
access_ strlevel - Set the monitor access level. Valid values are
disabled,private,enabled. - mr_
default_ booltarget_ self - For forks, whether merge requests target the fork itself rather than the upstream project by default.
- name str
- The name of the project.
- name_
with_ strnamespace - In
group / subgroup / projectoruser / projectformat. - namespace_
id int - The namespace (group or user) ID of the project. Alias for
namespace[0].id. - namespaces
Sequence[Get
Project Namespace] - Namespace of the project (parent group/s).
- only_
allow_ boolmerge_ if_ all_ discussions_ are_ resolved - Whether
onlyAllowMergeIfAllDiscussionsAreResolvedis enabled for the project. - only_
allow_ boolmerge_ if_ pipeline_ succeeds - Whether
onlyAllowMergeIfPipelineSucceedsis enabled for the project. - only_
mirror_ boolprotected_ branches - Whether
onlyMirrorProtectedBranchesis enabled for the project. - open_
issues_ intcount - The number of open issues for the project.
- operations_
access_ strlevel - Set the operations access level. Valid values are
disabled,private,enabled. - owners
Sequence[Get
Project Owner] - The owner of the project. Only populated when the calling token has administrator scope.
- package_
registry_ straccess_ level - The visibility of the package registry.
- packages_
enabled bool - Whether packages are enabled for the project.
- pages_
access_ strlevel - Set the GitLab Pages access level. Valid values are
disabled,private,enabled. - path str
- The path of the project.
- path_
with_ strnamespace - The path of the repository with namespace.
- permissions
Sequence[Get
Project Permission] - Permissions for the project.
- pre_
receive_ boolsecret_ detection_ enabled - Whether pre-receive secret detection is enabled for the project.
- prevent_
merge_ boolwithout_ jira_ issue - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- printing_
merge_ boolrequest_ link_ enabled - Show link to create/view merge request when pushing from the command line.
- protect_
merge_ boolrequest_ pipelines - Whether pipelines triggered for merge requests run with project secrets and protected variables, instead of the contributor's lower-privileged context.
- public_
builds bool - If true, jobs can be viewed by non-project members. Alias for
publicJobs. - public_
jobs bool - If true, jobs can be viewed by non-project members.
- push_
rules Sequence[GetProject Push Rule] - Push rules for the project. Push rules are only available on Enterprise plans and if the authenticated user has permission to read them.
- readme_
url str - The URL of the project README.
- releases_
access_ strlevel - Set the releases access level. Valid values are
disabled,private,enabled. - remove_
source_ boolbranch_ after_ merge - Enable
Delete source branchoption by default for all new merge requests. - repository_
access_ strlevel - Set the repository access level. Valid values are
disabled,private,enabled. - repository_
storage str - Which storage shard the repository is on. (administrator only)
- request_
access_ boolenabled - Whether requesting access is enabled for the project.
- requirements_
access_ strlevel - Set the requirements access level. Valid values are
disabled,private,enabled. - requirements_
enabled bool - Whether the requirements feature is enabled. Premium and Ultimate only.
- resolve_
outdated_ booldiff_ discussions - Automatically resolve merge request diffs discussions on lines changed with a push.
- resource_
group_ strdefault_ process_ mode - The default resource group process mode for the project.
- restrict_
user_ booldefined_ variables - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- runner_
token_ intexpiration_ interval - Runner token expiration interval, in seconds.
- runners_
token str - Registration token to use during runner setup.
- security_
and_ strcompliance_ access_ level - Set the security and compliance access level. Valid values are
disabled,private,enabled. - security_
and_ boolcompliance_ enabled - Whether the security and compliance feature is enabled.
- service_
desk_ straddress - The Service Desk email address for the project.
- service_
desk_ boolenabled - Whether Service Desk is enabled for the project.
- bool
- Whether shared runners are enabled for the project.
-
Sequence[Get
Project Shared With Group] - Describes groups which have access shared to this project.
- snippets_
access_ strlevel - Set the snippets access level. Valid values are
disabled,private,enabled. - snippets_
enabled bool - Whether snippets are enabled for the project.
- squash_
commit_ strtemplate - Template used to create squash commit message in merge requests.
- squash_
option str - The project's squash option for merge requests (
never,always,defaultOn,defaultOff). - ssh_
url_ strto_ repo - The SSH clone URL of the project.
- star_
count int - The number of stars on the project.
- statistics Mapping[str, int]
- Statistics for the project.
- suggestion_
commit_ strmessage - The commit message used to apply merge request suggestions.
- tag_
lists Sequence[str] - The list of project topics (formerly project tags).
- topics Sequence[str]
- The list of topics for the project.
- updated_
at str - The time the project was last updated.
- visibility str
- The visibility of the project (
private,internal,public). - visibility_
level str - The visibility of the project. Alias for
visibility. - web_
url str - URL that can be used to find the project in a browser.
- wiki_
access_ strlevel - Set the wiki access level. Valid values are
disabled,private,enabled. - wiki_
enabled bool - Whether wiki is enabled for the project.
- allow
Merge BooleanOn Skipped Pipeline - Whether
allowMergeOnSkippedPipelineis enabled for the project. - allow
Pipeline BooleanTrigger Approve Deployment - Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only.
- analytics
Access StringLevel - Set the analytics access level. Valid values are
disabled,private,enabled. - approvals
Before NumberMerge - The number of approvals needed in a merge request.
- archived Boolean
- Whether the project is in read-only mode (archived).
- auto
Cancel StringPending Pipelines - Auto-cancel pending pipelines. This isn't a boolean, but
enabled/disabled. - auto
Devops StringDeploy Strategy - Auto Deploy strategy. Valid values are
continuous,manual,timedIncremental. - auto
Devops BooleanEnabled - Enable Auto DevOps for this project.
- auto
Duo BooleanCode Review Enabled - Whether GitLab Duo code review is enabled for the project.
- autoclose
Referenced BooleanIssues - Set whether auto-closing referenced issues on default branch.
- avatar
Url String - The avatar URL of the project.
- build
Coverage StringRegex - Build coverage regex for the project.
- build
Git StringStrategy - The Git strategy. Defaults to
fetch. - build
Timeout Number - The maximum amount of time, in seconds, that a job can run.
- builds
Access StringLevel - Set the builds access level. Valid values are
disabled,private,enabled. - can
Create BooleanMerge Request In - Whether the calling user can create merge requests in this project.
- ci
Allow BooleanFork Pipelines To Run In Parent Project - Whether pipelines triggered from merge requests opened from forks may run in the parent project.
- ci
Config StringPath - CI config file path for the project.
- ci
Default NumberGit Depth - Default number of revisions for shallow cloning.
- ci
Delete NumberPipelines In Seconds - Pipelines older than the configured time are deleted.
- ci
Display BooleanPipeline Variables - Whether pipeline variables are displayed in the UI.
- ci
Forward BooleanDeployment Enabled - When a new deployment job starts, skip older deployment jobs that are still pending.
- ci
Forward BooleanDeployment Rollback Allowed - Allow job retries even if the deployment job is outdated.
- ci
Id List<String>Token Sub Claim Components - Fields included in the sub claim of the ID Token. Accepts an array starting with
projectPath. The array might also includerefTypeandref. Defaults to["projectPath", "refType", "ref"]. Introduced in GitLab 17.10. - ci
Job BooleanToken Scope Enabled - Whether the CI/CD job token access scope is enabled (limits which projects can be accessed using the job token).
- ci
Opt BooleanIn Jwt - Whether the project must explicitly opt in to receive ID tokens in CI jobs.
- ci
Pipeline StringVariables Minimum Override Role - The minimum role required to set variables when running pipelines and jobs. Introduced in GitLab 17.1. Valid values are
developer,maintainer,owner,noOneAllowed. - ci
Push BooleanRepository For Job Token Allowed - Whether pushes to the repository using the CI/CD job token are allowed.
- ci
Restrict StringPipeline Cancellation Role - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer,maintainer,noOne. - ci
Separated BooleanCaches - Use separate caches for protected branches.
- compliance
Frameworks List<String> - Compliance frameworks applied to the project. Premium and Ultimate only.
- container
Expiration List<Property Map>Policies - The image cleanup policy for this project.
- container
Registry StringAccess Level - Set visibility of container registry for this project. Valid values are
disabled,private,enabled. - container
Registry BooleanEnabled - Whether the container registry is enabled for the project.
- container
Registry StringImage Prefix - The image prefix used by the container registry for this project.
- created
At String - Creation time for the project.
- creator
Id Number - Creator ID for the project.
- custom
Attributes List<Map<String>> - Custom attributes for the project.
- default
Branch String - The default branch name of the project.
- description String
- A description of the project.
- emails
Disabled Boolean - Whether email notifications are disabled for the project.
- emails
Enabled Boolean - Enable email notifications.
- empty
Repo Boolean - Whether the project is empty.
- enforce
Auth BooleanChecks On Uploads - Whether authentication checks are enforced when uploading to the project.
- environments
Access StringLevel - Set the environments access level. Valid values are
disabled,private,enabled. - String
- The classification label for the project.
- feature
Flags StringAccess Level - Set the feature flags access level. Valid values are
disabled,private,enabled. - forked
From List<Property Map>Projects - Present if the project is a fork. Contains information about the upstream project.
- forking
Access StringLevel - Set the forking access level. Valid values are
disabled,private,enabled. - forks
Count Number - The number of forks of the project.
- group
Runners BooleanEnabled - Whether group runners are enabled for the project.
- http
Url StringTo Repo - The HTTP clone URL of the project.
- id String
- The integer that uniquely identifies the project within the gitlab install.
- import
Error String - The import error, if it exists, for the project.
- import
Status String - The import status of the project.
- import
Type String - The type of import used to create the project (for example
github,bitbucket). - import
Url String - URL the project was imported from.
- infrastructure
Access StringLevel - Set the infrastructure access level. Valid values are
disabled,private,enabled. - issue
Branch StringTemplate - Template used to suggest a branch name when creating one from an issue.
- issues
Access StringLevel - Set the issues access level. Valid values are
disabled,private,enabled. - issues
Enabled Boolean - Whether issues are enabled for the project.
- issues
Template String - Default description template for new issues.
- jobs
Enabled Boolean - Whether jobs are enabled for the project.
- keep
Latest BooleanArtifact - Disable or enable the ability to keep the latest artifact for this project.
- last
Activity StringAt - Last activity time for the project.
- lfs
Enabled Boolean - Whether LFS (large file storage) is enabled for the project.
- license
Url String - URL of the project's license file.
- licenses List<Property Map>
- Information about the project's license, if one is detected.
- links Map<String>
- Links for the project.
- marked
For BooleanDeletion - Whether the project is marked for deletion.
- marked
For StringDeletion At - Timestamp at which the project was marked for deletion. Premium and Ultimate only.
- marked
For StringDeletion On - Timestamp at which the project was marked for deletion. Premium and Ultimate only.
- max
Artifacts NumberSize - Maximum artifacts size, in MB, for the project. Overrides the instance-wide setting when set.
- merge
Commit StringTemplate - Template used to create merge commit message in merge requests.
- merge
Method String - Merge method for the project.
- merge
Pipelines BooleanEnabled - Enable or disable merge pipelines.
- merge
Request StringTitle Regex - Regular expression that merge request titles must match.
- merge
Request StringTitle Regex Description - Human-readable description of
mergeRequestTitleRegex. - merge
Requests StringAccess Level - Set the merge requests access level. Valid values are
disabled,private,enabled. - merge
Requests BooleanEnabled - Whether merge requests are enabled for the project.
- merge
Requests StringTemplate - Default description template for new merge requests.
- merge
Trains BooleanEnabled - Enable or disable merge trains.
- merge
Trains BooleanSkip Train Allowed - Allows merge train merge requests to be merged without waiting for pipelines to finish.
- mirror Boolean
- Whether pull mirroring is enabled for the project.
- mirror
Overwrites BooleanDiverged Branches - Whether
mirrorOverwritesDivergedBranchesis enabled for the project. - mirror
Trigger BooleanBuilds - Whether pull mirroring triggers builds for the project.
- mirror
User NumberId - The mirror user ID for the project.
- model
Experiments StringAccess Level - The visibility of machine learning model experiments.
- model
Registry StringAccess Level - The visibility of machine learning model registry.
- monitor
Access StringLevel - Set the monitor access level. Valid values are
disabled,private,enabled. - mr
Default BooleanTarget Self - For forks, whether merge requests target the fork itself rather than the upstream project by default.
- name String
- The name of the project.
- name
With StringNamespace - In
group / subgroup / projectoruser / projectformat. - namespace
Id Number - The namespace (group or user) ID of the project. Alias for
namespace[0].id. - namespaces List<Property Map>
- Namespace of the project (parent group/s).
- only
Allow BooleanMerge If All Discussions Are Resolved - Whether
onlyAllowMergeIfAllDiscussionsAreResolvedis enabled for the project. - only
Allow BooleanMerge If Pipeline Succeeds - Whether
onlyAllowMergeIfPipelineSucceedsis enabled for the project. - only
Mirror BooleanProtected Branches - Whether
onlyMirrorProtectedBranchesis enabled for the project. - open
Issues NumberCount - The number of open issues for the project.
- operations
Access StringLevel - Set the operations access level. Valid values are
disabled,private,enabled. - owners List<Property Map>
- The owner of the project. Only populated when the calling token has administrator scope.
- package
Registry StringAccess Level - The visibility of the package registry.
- packages
Enabled Boolean - Whether packages are enabled for the project.
- pages
Access StringLevel - Set the GitLab Pages access level. Valid values are
disabled,private,enabled. - path String
- The path of the project.
- path
With StringNamespace - The path of the repository with namespace.
- permissions List<Property Map>
- Permissions for the project.
- pre
Receive BooleanSecret Detection Enabled - Whether pre-receive secret detection is enabled for the project.
- prevent
Merge BooleanWithout Jira Issue - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- printing
Merge BooleanRequest Link Enabled - Show link to create/view merge request when pushing from the command line.
- protect
Merge BooleanRequest Pipelines - Whether pipelines triggered for merge requests run with project secrets and protected variables, instead of the contributor's lower-privileged context.
- public
Builds Boolean - If true, jobs can be viewed by non-project members. Alias for
publicJobs. - public
Jobs Boolean - If true, jobs can be viewed by non-project members.
- push
Rules List<Property Map> - Push rules for the project. Push rules are only available on Enterprise plans and if the authenticated user has permission to read them.
- readme
Url String - The URL of the project README.
- releases
Access StringLevel - Set the releases access level. Valid values are
disabled,private,enabled. - remove
Source BooleanBranch After Merge - Enable
Delete source branchoption by default for all new merge requests. - repository
Access StringLevel - Set the repository access level. Valid values are
disabled,private,enabled. - repository
Storage String - Which storage shard the repository is on. (administrator only)
- request
Access BooleanEnabled - Whether requesting access is enabled for the project.
- requirements
Access StringLevel - Set the requirements access level. Valid values are
disabled,private,enabled. - requirements
Enabled Boolean - Whether the requirements feature is enabled. Premium and Ultimate only.
- resolve
Outdated BooleanDiff Discussions - Automatically resolve merge request diffs discussions on lines changed with a push.
- resource
Group StringDefault Process Mode - The default resource group process mode for the project.
- restrict
User BooleanDefined Variables - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- runner
Token NumberExpiration Interval - Runner token expiration interval, in seconds.
- runners
Token String - Registration token to use during runner setup.
- security
And StringCompliance Access Level - Set the security and compliance access level. Valid values are
disabled,private,enabled. - security
And BooleanCompliance Enabled - Whether the security and compliance feature is enabled.
- service
Desk StringAddress - The Service Desk email address for the project.
- service
Desk BooleanEnabled - Whether Service Desk is enabled for the project.
- Boolean
- Whether shared runners are enabled for the project.
- List<Property Map>
- Describes groups which have access shared to this project.
- snippets
Access StringLevel - Set the snippets access level. Valid values are
disabled,private,enabled. - snippets
Enabled Boolean - Whether snippets are enabled for the project.
- squash
Commit StringTemplate - Template used to create squash commit message in merge requests.
- squash
Option String - The project's squash option for merge requests (
never,always,defaultOn,defaultOff). - ssh
Url StringTo Repo - The SSH clone URL of the project.
- star
Count Number - The number of stars on the project.
- statistics Map<Number>
- Statistics for the project.
- suggestion
Commit StringMessage - The commit message used to apply merge request suggestions.
- tag
Lists List<String> - The list of project topics (formerly project tags).
- topics List<String>
- The list of topics for the project.
- updated
At String - The time the project was last updated.
- visibility String
- The visibility of the project (
private,internal,public). - visibility
Level String - The visibility of the project. Alias for
visibility. - web
Url String - URL that can be used to find the project in a browser.
- wiki
Access StringLevel - Set the wiki access level. Valid values are
disabled,private,enabled. - wiki
Enabled Boolean - Whether wiki is enabled for the project.
Supporting Types
GetProjectContainerExpirationPolicy
- Cadence string
- The cadence of the policy. Valid values are:
1d,7d,14d,1month,3month. - Enabled bool
- If true, the policy is enabled.
- Keep
N int - The number of images to keep.
- Name
Regex stringDelete - The regular expression to match image names to delete.
- Name
Regex stringKeep - The regular expression to match image names to keep.
- Next
Run stringAt - The next time the policy will run.
- Older
Than string - The number of days to keep images.
- Cadence string
- The cadence of the policy. Valid values are:
1d,7d,14d,1month,3month. - Enabled bool
- If true, the policy is enabled.
- Keep
N int - The number of images to keep.
- Name
Regex stringDelete - The regular expression to match image names to delete.
- Name
Regex stringKeep - The regular expression to match image names to keep.
- Next
Run stringAt - The next time the policy will run.
- Older
Than string - The number of days to keep images.
- cadence string
- The cadence of the policy. Valid values are:
1d,7d,14d,1month,3month. - enabled bool
- If true, the policy is enabled.
- keep_
n number - The number of images to keep.
- name_
regex_ stringdelete - The regular expression to match image names to delete.
- name_
regex_ stringkeep - The regular expression to match image names to keep.
- next_
run_ stringat - The next time the policy will run.
- older_
than string - The number of days to keep images.
- cadence String
- The cadence of the policy. Valid values are:
1d,7d,14d,1month,3month. - enabled Boolean
- If true, the policy is enabled.
- keep
N Integer - The number of images to keep.
- name
Regex StringDelete - The regular expression to match image names to delete.
- name
Regex StringKeep - The regular expression to match image names to keep.
- next
Run StringAt - The next time the policy will run.
- older
Than String - The number of days to keep images.
- cadence string
- The cadence of the policy. Valid values are:
1d,7d,14d,1month,3month. - enabled boolean
- If true, the policy is enabled.
- keep
N number - The number of images to keep.
- name
Regex stringDelete - The regular expression to match image names to delete.
- name
Regex stringKeep - The regular expression to match image names to keep.
- next
Run stringAt - The next time the policy will run.
- older
Than string - The number of days to keep images.
- cadence str
- The cadence of the policy. Valid values are:
1d,7d,14d,1month,3month. - enabled bool
- If true, the policy is enabled.
- keep_
n int - The number of images to keep.
- name_
regex_ strdelete - The regular expression to match image names to delete.
- name_
regex_ strkeep - The regular expression to match image names to keep.
- next_
run_ strat - The next time the policy will run.
- older_
than str - The number of days to keep images.
- cadence String
- The cadence of the policy. Valid values are:
1d,7d,14d,1month,3month. - enabled Boolean
- If true, the policy is enabled.
- keep
N Number - The number of images to keep.
- name
Regex StringDelete - The regular expression to match image names to delete.
- name
Regex StringKeep - The regular expression to match image names to keep.
- next
Run StringAt - The next time the policy will run.
- older
Than String - The number of days to keep images.
GetProjectForkedFromProject
- Http
Url stringTo Repo - The HTTP clone URL of the upstream project.
- Id int
- The ID of the upstream project.
- Name string
- The name of the upstream project.
- Name
With stringNamespace - In
group / subgroup / projectoruser / projectformat. - Path string
- The path of the upstream project.
- Path
With stringNamespace - In
group/subgroup/projectoruser/projectformat. - Web
Url string - The web URL of the upstream project.
- Http
Url stringTo Repo - The HTTP clone URL of the upstream project.
- Id int
- The ID of the upstream project.
- Name string
- The name of the upstream project.
- Name
With stringNamespace - In
group / subgroup / projectoruser / projectformat. - Path string
- The path of the upstream project.
- Path
With stringNamespace - In
group/subgroup/projectoruser/projectformat. - Web
Url string - The web URL of the upstream project.
- http_
url_ stringto_ repo - The HTTP clone URL of the upstream project.
- id number
- The ID of the upstream project.
- name string
- The name of the upstream project.
- name_
with_ stringnamespace - In
group / subgroup / projectoruser / projectformat. - path string
- The path of the upstream project.
- path_
with_ stringnamespace - In
group/subgroup/projectoruser/projectformat. - web_
url string - The web URL of the upstream project.
- http
Url StringTo Repo - The HTTP clone URL of the upstream project.
- id Integer
- The ID of the upstream project.
- name String
- The name of the upstream project.
- name
With StringNamespace - In
group / subgroup / projectoruser / projectformat. - path String
- The path of the upstream project.
- path
With StringNamespace - In
group/subgroup/projectoruser/projectformat. - web
Url String - The web URL of the upstream project.
- http
Url stringTo Repo - The HTTP clone URL of the upstream project.
- id number
- The ID of the upstream project.
- name string
- The name of the upstream project.
- name
With stringNamespace - In
group / subgroup / projectoruser / projectformat. - path string
- The path of the upstream project.
- path
With stringNamespace - In
group/subgroup/projectoruser/projectformat. - web
Url string - The web URL of the upstream project.
- http_
url_ strto_ repo - The HTTP clone URL of the upstream project.
- id int
- The ID of the upstream project.
- name str
- The name of the upstream project.
- name_
with_ strnamespace - In
group / subgroup / projectoruser / projectformat. - path str
- The path of the upstream project.
- path_
with_ strnamespace - In
group/subgroup/projectoruser/projectformat. - web_
url str - The web URL of the upstream project.
- http
Url StringTo Repo - The HTTP clone URL of the upstream project.
- id Number
- The ID of the upstream project.
- name String
- The name of the upstream project.
- name
With StringNamespace - In
group / subgroup / projectoruser / projectformat. - path String
- The path of the upstream project.
- path
With StringNamespace - In
group/subgroup/projectoruser/projectformat. - web
Url String - The web URL of the upstream project.
GetProjectLicense
- html_
url string - URL to the license's human-readable description.
- key string
- The license key (e.g.
mit). - name string
- The license name (e.g.
MIT License). - nickname string
- The license nickname.
- source_
url string - URL to the license source text.
- html_
url str - URL to the license's human-readable description.
- key str
- The license key (e.g.
mit). - name str
- The license name (e.g.
MIT License). - nickname str
- The license nickname.
- source_
url str - URL to the license source text.
GetProjectNamespace
GetProjectOwner
- avatar_
url string - The avatar URL of the owner.
- id number
- The ID of the owner.
- name string
- The name of the owner.
- state string
- The state of the owner.
- username string
- The username of the owner.
- website_
url string - The website URL of the owner.
- avatar_
url str - The avatar URL of the owner.
- id int
- The ID of the owner.
- name str
- The name of the owner.
- state str
- The state of the owner.
- username str
- The username of the owner.
- website_
url str - The website URL of the owner.
GetProjectPermission
- Group
Access Dictionary<string, int> - Group access level.
- Project
Access Dictionary<string, int> - Project access level.
- Group
Access map[string]int - Group access level.
- Project
Access map[string]int - Project access level.
- group_
access map(number) - Group access level.
- project_
access map(number) - Project access level.
- group
Access Map<String,Integer> - Group access level.
- project
Access Map<String,Integer> - Project access level.
- group
Access {[key: string]: number} - Group access level.
- project
Access {[key: string]: number} - Project access level.
- group_
access Mapping[str, int] - Group access level.
- project_
access Mapping[str, int] - Project access level.
- group
Access Map<Number> - Group access level.
- project
Access Map<Number> - Project access level.
GetProjectPushRule
- string
- All commit author emails must match this regex, e.g.
@my-company.com$. - Branch
Name stringRegex - All branch names must match this regex, e.g.
(feature|hotfix)\/*. - Commit
Committer boolCheck - Users can only push commits to this repository that were committed with one of their own verified emails.
- Commit
Committer boolName Check - Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
- Commit
Message stringNegative Regex - No commit message is allowed to match this regex, for example
ssh\:\/\/. - Commit
Message stringRegex - All commit messages must match this regex, e.g.
Fixed \d+\..*. - Deny
Delete boolTag - Deny deleting a tag.
- File
Name stringRegex - All committed filenames must not match this regex, e.g.
(jar|exe)$. - Max
File intSize - Maximum file size (MB).
- Member
Check bool - Restrict commits by author (email) to existing GitLab users.
- Prevent
Secrets bool - GitLab will reject any files that are likely to contain secrets.
- Reject
Non boolDco Commits - Reject commit when it's not DCO certified.
- Reject
Unsigned boolCommits - Reject commit when it's not signed through GPG.
- string
- All commit author emails must match this regex, e.g.
@my-company.com$. - Branch
Name stringRegex - All branch names must match this regex, e.g.
(feature|hotfix)\/*. - Commit
Committer boolCheck - Users can only push commits to this repository that were committed with one of their own verified emails.
- Commit
Committer boolName Check - Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
- Commit
Message stringNegative Regex - No commit message is allowed to match this regex, for example
ssh\:\/\/. - Commit
Message stringRegex - All commit messages must match this regex, e.g.
Fixed \d+\..*. - Deny
Delete boolTag - Deny deleting a tag.
- File
Name stringRegex - All committed filenames must not match this regex, e.g.
(jar|exe)$. - Max
File intSize - Maximum file size (MB).
- Member
Check bool - Restrict commits by author (email) to existing GitLab users.
- Prevent
Secrets bool - GitLab will reject any files that are likely to contain secrets.
- Reject
Non boolDco Commits - Reject commit when it's not DCO certified.
- Reject
Unsigned boolCommits - Reject commit when it's not signed through GPG.
- string
- All commit author emails must match this regex, e.g.
@my-company.com$. - branch_
name_ stringregex - All branch names must match this regex, e.g.
(feature|hotfix)\/*. - commit_
committer_ boolcheck - Users can only push commits to this repository that were committed with one of their own verified emails.
- commit_
committer_ boolname_ check - Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
- commit_
message_ stringnegative_ regex - No commit message is allowed to match this regex, for example
ssh\:\/\/. - commit_
message_ stringregex - All commit messages must match this regex, e.g.
Fixed \d+\..*. - deny_
delete_ booltag - Deny deleting a tag.
- file_
name_ stringregex - All committed filenames must not match this regex, e.g.
(jar|exe)$. - max_
file_ numbersize - Maximum file size (MB).
- member_
check bool - Restrict commits by author (email) to existing GitLab users.
- prevent_
secrets bool - GitLab will reject any files that are likely to contain secrets.
- reject_
non_ booldco_ commits - Reject commit when it's not DCO certified.
- reject_
unsigned_ boolcommits - Reject commit when it's not signed through GPG.
- String
- All commit author emails must match this regex, e.g.
@my-company.com$. - branch
Name StringRegex - All branch names must match this regex, e.g.
(feature|hotfix)\/*. - commit
Committer BooleanCheck - Users can only push commits to this repository that were committed with one of their own verified emails.
- commit
Committer BooleanName Check - Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
- commit
Message StringNegative Regex - No commit message is allowed to match this regex, for example
ssh\:\/\/. - commit
Message StringRegex - All commit messages must match this regex, e.g.
Fixed \d+\..*. - deny
Delete BooleanTag - Deny deleting a tag.
- file
Name StringRegex - All committed filenames must not match this regex, e.g.
(jar|exe)$. - max
File IntegerSize - Maximum file size (MB).
- member
Check Boolean - Restrict commits by author (email) to existing GitLab users.
- prevent
Secrets Boolean - GitLab will reject any files that are likely to contain secrets.
- reject
Non BooleanDco Commits - Reject commit when it's not DCO certified.
- reject
Unsigned BooleanCommits - Reject commit when it's not signed through GPG.
- string
- All commit author emails must match this regex, e.g.
@my-company.com$. - branch
Name stringRegex - All branch names must match this regex, e.g.
(feature|hotfix)\/*. - commit
Committer booleanCheck - Users can only push commits to this repository that were committed with one of their own verified emails.
- commit
Committer booleanName Check - Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
- commit
Message stringNegative Regex - No commit message is allowed to match this regex, for example
ssh\:\/\/. - commit
Message stringRegex - All commit messages must match this regex, e.g.
Fixed \d+\..*. - deny
Delete booleanTag - Deny deleting a tag.
- file
Name stringRegex - All committed filenames must not match this regex, e.g.
(jar|exe)$. - max
File numberSize - Maximum file size (MB).
- member
Check boolean - Restrict commits by author (email) to existing GitLab users.
- prevent
Secrets boolean - GitLab will reject any files that are likely to contain secrets.
- reject
Non booleanDco Commits - Reject commit when it's not DCO certified.
- reject
Unsigned booleanCommits - Reject commit when it's not signed through GPG.
- str
- All commit author emails must match this regex, e.g.
@my-company.com$. - branch_
name_ strregex - All branch names must match this regex, e.g.
(feature|hotfix)\/*. - commit_
committer_ boolcheck - Users can only push commits to this repository that were committed with one of their own verified emails.
- commit_
committer_ boolname_ check - Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
- commit_
message_ strnegative_ regex - No commit message is allowed to match this regex, for example
ssh\:\/\/. - commit_
message_ strregex - All commit messages must match this regex, e.g.
Fixed \d+\..*. - deny_
delete_ booltag - Deny deleting a tag.
- file_
name_ strregex - All committed filenames must not match this regex, e.g.
(jar|exe)$. - max_
file_ intsize - Maximum file size (MB).
- member_
check bool - Restrict commits by author (email) to existing GitLab users.
- prevent_
secrets bool - GitLab will reject any files that are likely to contain secrets.
- reject_
non_ booldco_ commits - Reject commit when it's not DCO certified.
- reject_
unsigned_ boolcommits - Reject commit when it's not signed through GPG.
- String
- All commit author emails must match this regex, e.g.
@my-company.com$. - branch
Name StringRegex - All branch names must match this regex, e.g.
(feature|hotfix)\/*. - commit
Committer BooleanCheck - Users can only push commits to this repository that were committed with one of their own verified emails.
- commit
Committer BooleanName Check - Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
- commit
Message StringNegative Regex - No commit message is allowed to match this regex, for example
ssh\:\/\/. - commit
Message StringRegex - All commit messages must match this regex, e.g.
Fixed \d+\..*. - deny
Delete BooleanTag - Deny deleting a tag.
- file
Name StringRegex - All committed filenames must not match this regex, e.g.
(jar|exe)$. - max
File NumberSize - Maximum file size (MB).
- member
Check Boolean - Restrict commits by author (email) to existing GitLab users.
- prevent
Secrets Boolean - GitLab will reject any files that are likely to contain secrets.
- reject
Non BooleanDco Commits - Reject commit when it's not DCO certified.
- reject
Unsigned BooleanCommits - Reject commit when it's not signed through GPG.
GetProjectSharedWithGroup
- Group
Access intLevel - The access level (integer) of the shared group. Matches the upstream GitLab API. See
groupAccessLevelNamefor the human-readable string form. - Group
Access stringLevel Name - The human-readable access level name of the shared group (e.g.
developer,maintainer). Computed fromgroupAccessLevel. - Group
Full stringPath - The full path of the group shared with.
- Group
Id int - The ID of the group shared with.
- Group
Name string - The name of the group shared with.
- Group
Access intLevel - The access level (integer) of the shared group. Matches the upstream GitLab API. See
groupAccessLevelNamefor the human-readable string form. - Group
Access stringLevel Name - The human-readable access level name of the shared group (e.g.
developer,maintainer). Computed fromgroupAccessLevel. - Group
Full stringPath - The full path of the group shared with.
- Group
Id int - The ID of the group shared with.
- Group
Name string - The name of the group shared with.
- group_
access_ numberlevel - The access level (integer) of the shared group. Matches the upstream GitLab API. See
groupAccessLevelNamefor the human-readable string form. - group_
access_ stringlevel_ name - The human-readable access level name of the shared group (e.g.
developer,maintainer). Computed fromgroupAccessLevel. - group_
full_ stringpath - The full path of the group shared with.
- group_
id number - The ID of the group shared with.
- group_
name string - The name of the group shared with.
- group
Access IntegerLevel - The access level (integer) of the shared group. Matches the upstream GitLab API. See
groupAccessLevelNamefor the human-readable string form. - group
Access StringLevel Name - The human-readable access level name of the shared group (e.g.
developer,maintainer). Computed fromgroupAccessLevel. - group
Full StringPath - The full path of the group shared with.
- group
Id Integer - The ID of the group shared with.
- group
Name String - The name of the group shared with.
- group
Access numberLevel - The access level (integer) of the shared group. Matches the upstream GitLab API. See
groupAccessLevelNamefor the human-readable string form. - group
Access stringLevel Name - The human-readable access level name of the shared group (e.g.
developer,maintainer). Computed fromgroupAccessLevel. - group
Full stringPath - The full path of the group shared with.
- group
Id number - The ID of the group shared with.
- group
Name string - The name of the group shared with.
- group_
access_ intlevel - The access level (integer) of the shared group. Matches the upstream GitLab API. See
groupAccessLevelNamefor the human-readable string form. - group_
access_ strlevel_ name - The human-readable access level name of the shared group (e.g.
developer,maintainer). Computed fromgroupAccessLevel. - group_
full_ strpath - The full path of the group shared with.
- group_
id int - The ID of the group shared with.
- group_
name str - The name of the group shared with.
- group
Access NumberLevel - The access level (integer) of the shared group. Matches the upstream GitLab API. See
groupAccessLevelNamefor the human-readable string form. - group
Access StringLevel Name - The human-readable access level name of the shared group (e.g.
developer,maintainer). Computed fromgroupAccessLevel. - group
Full StringPath - The full path of the group shared with.
- group
Id Number - The ID of the group shared with.
- group
Name String - The name of the group shared with.
Package Details
- Repository
- GitLab pulumi/pulumi-gitlab
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
gitlabTerraform Provider.
Viewing docs for GitLab v10.0.0
published on Friday, Jun 26, 2026 by Pulumi
published on Friday, Jun 26, 2026 by Pulumi