gitlab.getProjects
The gitlab.getProjects data source allows details of multiple projects to be retrieved. Optionally filtered by the set attributes.
This data source supports all available filters exposed by the client-go package, which might not expose all available filters exposed by the GitLab APIs.
The owner sub-attributes are only populated if the GitLab token used has an administrator scope.
Upstream API: GitLab REST API docs
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
// List projects within a group tree
const mygroup = gitlab.getGroup({
fullPath: "mygroup",
});
const groupProjects = mygroup.then(mygroup => gitlab.getProjects({
groupId: mygroup.id,
orderBy: "name",
includeSubgroups: true,
withShared: false,
}));
// List projects using the search syntax
const projects = gitlab.getProjects({
search: "postgresql",
visibility: "private",
});
import pulumi
import pulumi_gitlab as gitlab
# List projects within a group tree
mygroup = gitlab.get_group(full_path="mygroup")
group_projects = gitlab.get_projects(group_id=mygroup.id,
order_by="name",
include_subgroups=True,
with_shared=False)
# List projects using the search syntax
projects = gitlab.get_projects(search="postgresql",
visibility="private")
package main
import (
"github.com/pulumi/pulumi-gitlab/sdk/v9/go/gitlab"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// List projects within a group tree
mygroup, err := gitlab.LookupGroup(ctx, &gitlab.LookupGroupArgs{
FullPath: pulumi.StringRef("mygroup"),
}, nil)
if err != nil {
return err
}
_, err = gitlab.GetProjects(ctx, &gitlab.GetProjectsArgs{
GroupId: pulumi.IntRef(mygroup.Id),
OrderBy: pulumi.StringRef("name"),
IncludeSubgroups: pulumi.BoolRef(true),
WithShared: pulumi.BoolRef(false),
}, nil)
if err != nil {
return err
}
// List projects using the search syntax
_, err = gitlab.GetProjects(ctx, &gitlab.GetProjectsArgs{
Search: pulumi.StringRef("postgresql"),
Visibility: pulumi.StringRef("private"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() =>
{
// List projects within a group tree
var mygroup = GitLab.GetGroup.Invoke(new()
{
FullPath = "mygroup",
});
var groupProjects = GitLab.GetProjects.Invoke(new()
{
GroupId = mygroup.Apply(getGroupResult => getGroupResult.Id),
OrderBy = "name",
IncludeSubgroups = true,
WithShared = false,
});
// List projects using the search syntax
var projects = GitLab.GetProjects.Invoke(new()
{
Search = "postgresql",
Visibility = "private",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.GitlabFunctions;
import com.pulumi.gitlab.inputs.GetGroupArgs;
import com.pulumi.gitlab.inputs.GetProjectsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
// List projects within a group tree
final var mygroup = GitlabFunctions.getGroup(GetGroupArgs.builder()
.fullPath("mygroup")
.build());
final var groupProjects = GitlabFunctions.getProjects(GetProjectsArgs.builder()
.groupId(mygroup.id())
.orderBy("name")
.includeSubgroups(true)
.withShared(false)
.build());
// List projects using the search syntax
final var projects = GitlabFunctions.getProjects(GetProjectsArgs.builder()
.search("postgresql")
.visibility("private")
.build());
}
}
variables:
# List projects within a group tree
mygroup:
fn::invoke:
function: gitlab:getGroup
arguments:
fullPath: mygroup
groupProjects:
fn::invoke:
function: gitlab:getProjects
arguments:
groupId: ${mygroup.id}
orderBy: name
includeSubgroups: true
withShared: false
# List projects using the search syntax
projects:
fn::invoke:
function: gitlab:getProjects
arguments:
search: postgresql
visibility: private
Using getProjects
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 getProjects(args: GetProjectsArgs, opts?: InvokeOptions): Promise<GetProjectsResult>
function getProjectsOutput(args: GetProjectsOutputArgs, opts?: InvokeOptions): Output<GetProjectsResult>def get_projects(archived: Optional[bool] = None,
group_id: Optional[int] = None,
include_subgroups: Optional[bool] = None,
max_queryable_pages: Optional[int] = None,
membership: Optional[bool] = None,
min_access_level: Optional[int] = None,
order_by: Optional[str] = None,
owned: Optional[bool] = None,
page: Optional[int] = None,
per_page: Optional[int] = None,
search: Optional[str] = None,
simple: Optional[bool] = None,
sort: Optional[str] = None,
starred: Optional[bool] = None,
statistics: Optional[bool] = None,
topics: Optional[Sequence[str]] = None,
visibility: Optional[str] = None,
with_custom_attributes: Optional[bool] = None,
with_issues_enabled: Optional[bool] = None,
with_merge_requests_enabled: Optional[bool] = None,
with_programming_language: Optional[str] = None,
with_shared: Optional[bool] = None,
opts: Optional[InvokeOptions] = None) -> GetProjectsResult
def get_projects_output(archived: Optional[pulumi.Input[bool]] = None,
group_id: Optional[pulumi.Input[int]] = None,
include_subgroups: Optional[pulumi.Input[bool]] = None,
max_queryable_pages: Optional[pulumi.Input[int]] = None,
membership: Optional[pulumi.Input[bool]] = None,
min_access_level: Optional[pulumi.Input[int]] = None,
order_by: Optional[pulumi.Input[str]] = None,
owned: Optional[pulumi.Input[bool]] = None,
page: Optional[pulumi.Input[int]] = None,
per_page: Optional[pulumi.Input[int]] = None,
search: Optional[pulumi.Input[str]] = None,
simple: Optional[pulumi.Input[bool]] = None,
sort: Optional[pulumi.Input[str]] = None,
starred: Optional[pulumi.Input[bool]] = None,
statistics: Optional[pulumi.Input[bool]] = None,
topics: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
visibility: Optional[pulumi.Input[str]] = None,
with_custom_attributes: Optional[pulumi.Input[bool]] = None,
with_issues_enabled: Optional[pulumi.Input[bool]] = None,
with_merge_requests_enabled: Optional[pulumi.Input[bool]] = None,
with_programming_language: Optional[pulumi.Input[str]] = None,
with_shared: Optional[pulumi.Input[bool]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetProjectsResult]func GetProjects(ctx *Context, args *GetProjectsArgs, opts ...InvokeOption) (*GetProjectsResult, error)
func GetProjectsOutput(ctx *Context, args *GetProjectsOutputArgs, opts ...InvokeOption) GetProjectsResultOutput> Note: This function is named GetProjects in the Go SDK.
public static class GetProjects
{
public static Task<GetProjectsResult> InvokeAsync(GetProjectsArgs args, InvokeOptions? opts = null)
public static Output<GetProjectsResult> Invoke(GetProjectsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetProjectsResult> getProjects(GetProjectsArgs args, InvokeOptions options)
public static Output<GetProjectsResult> getProjects(GetProjectsArgs args, InvokeOptions options)
fn::invoke:
function: gitlab:index/getProjects:getProjects
arguments:
# arguments dictionaryThe following arguments are supported:
- Archived bool
- Limit by archived status.
- Group
Id int - The ID of the group owned by the authenticated user to look projects for within. Cannot be used with
min_access_level,with_programming_languageorstatistics. - Include
Subgroups bool - Include projects in subgroups of this group. Default is
false. Needsgroup_id. - Max
Queryable intPages - The maximum number of project results pages that may be queried. Prevents overloading your Gitlab instance in case of a misconfiguration.
- Membership bool
- Limit by projects that the current user is a member of.
- Min
Access intLevel - Limit to projects where current user has at least this access level, refer to the official documentation for values. Cannot be used with
group_id. - Order
By string - Return projects ordered ordered by:
id,name,path,created_at,updated_at,last_activity_at,similarity,repository_size,storage_size,packages_size,wiki_size. Some values or only available in certain circumstances. See upstream docs for details. - Owned bool
- Limit by projects owned by the current user.
- Page int
- The first page to begin the query on.
- Per
Page int - The number of results to return per page.
- Search string
- Return list of authorized projects matching the search criteria.
- Simple bool
- Return only the ID, URL, name, and path of each project.
- Sort string
- Return projects sorted in
ascordescorder. Default isdesc. - Starred bool
- Limit by projects starred by the current user.
- Statistics bool
- Include project statistics. Cannot be used with
group_id. - Topics List<string>
- Limit by projects that have all of the given topics.
- Visibility string
- Limit by visibility
public,internal, orprivate. - With
Custom boolAttributes - Include custom attributes in response (admins only).
- With
Issues boolEnabled - Limit by projects with issues feature enabled. Default is
false. - With
Merge boolRequests Enabled - Limit by projects with merge requests feature enabled. Default is
false. - With
Programming stringLanguage - Limit by projects which use the given programming language. Cannot be used with
group_id. - bool
- Include projects shared to this group. Default is
true. Needsgroup_id.
- Archived bool
- Limit by archived status.
- Group
Id int - The ID of the group owned by the authenticated user to look projects for within. Cannot be used with
min_access_level,with_programming_languageorstatistics. - Include
Subgroups bool - Include projects in subgroups of this group. Default is
false. Needsgroup_id. - Max
Queryable intPages - The maximum number of project results pages that may be queried. Prevents overloading your Gitlab instance in case of a misconfiguration.
- Membership bool
- Limit by projects that the current user is a member of.
- Min
Access intLevel - Limit to projects where current user has at least this access level, refer to the official documentation for values. Cannot be used with
group_id. - Order
By string - Return projects ordered ordered by:
id,name,path,created_at,updated_at,last_activity_at,similarity,repository_size,storage_size,packages_size,wiki_size. Some values or only available in certain circumstances. See upstream docs for details. - Owned bool
- Limit by projects owned by the current user.
- Page int
- The first page to begin the query on.
- Per
Page int - The number of results to return per page.
- Search string
- Return list of authorized projects matching the search criteria.
- Simple bool
- Return only the ID, URL, name, and path of each project.
- Sort string
- Return projects sorted in
ascordescorder. Default isdesc. - Starred bool
- Limit by projects starred by the current user.
- Statistics bool
- Include project statistics. Cannot be used with
group_id. - Topics []string
- Limit by projects that have all of the given topics.
- Visibility string
- Limit by visibility
public,internal, orprivate. - With
Custom boolAttributes - Include custom attributes in response (admins only).
- With
Issues boolEnabled - Limit by projects with issues feature enabled. Default is
false. - With
Merge boolRequests Enabled - Limit by projects with merge requests feature enabled. Default is
false. - With
Programming stringLanguage - Limit by projects which use the given programming language. Cannot be used with
group_id. - bool
- Include projects shared to this group. Default is
true. Needsgroup_id.
- archived Boolean
- Limit by archived status.
- group
Id Integer - The ID of the group owned by the authenticated user to look projects for within. Cannot be used with
min_access_level,with_programming_languageorstatistics. - include
Subgroups Boolean - Include projects in subgroups of this group. Default is
false. Needsgroup_id. - max
Queryable IntegerPages - The maximum number of project results pages that may be queried. Prevents overloading your Gitlab instance in case of a misconfiguration.
- membership Boolean
- Limit by projects that the current user is a member of.
- min
Access IntegerLevel - Limit to projects where current user has at least this access level, refer to the official documentation for values. Cannot be used with
group_id. - order
By String - Return projects ordered ordered by:
id,name,path,created_at,updated_at,last_activity_at,similarity,repository_size,storage_size,packages_size,wiki_size. Some values or only available in certain circumstances. See upstream docs for details. - owned Boolean
- Limit by projects owned by the current user.
- page Integer
- The first page to begin the query on.
- per
Page Integer - The number of results to return per page.
- search String
- Return list of authorized projects matching the search criteria.
- simple Boolean
- Return only the ID, URL, name, and path of each project.
- sort String
- Return projects sorted in
ascordescorder. Default isdesc. - starred Boolean
- Limit by projects starred by the current user.
- statistics Boolean
- Include project statistics. Cannot be used with
group_id. - topics List<String>
- Limit by projects that have all of the given topics.
- visibility String
- Limit by visibility
public,internal, orprivate. - with
Custom BooleanAttributes - Include custom attributes in response (admins only).
- with
Issues BooleanEnabled - Limit by projects with issues feature enabled. Default is
false. - with
Merge BooleanRequests Enabled - Limit by projects with merge requests feature enabled. Default is
false. - with
Programming StringLanguage - Limit by projects which use the given programming language. Cannot be used with
group_id. - Boolean
- Include projects shared to this group. Default is
true. Needsgroup_id.
- archived boolean
- Limit by archived status.
- group
Id number - The ID of the group owned by the authenticated user to look projects for within. Cannot be used with
min_access_level,with_programming_languageorstatistics. - include
Subgroups boolean - Include projects in subgroups of this group. Default is
false. Needsgroup_id. - max
Queryable numberPages - The maximum number of project results pages that may be queried. Prevents overloading your Gitlab instance in case of a misconfiguration.
- membership boolean
- Limit by projects that the current user is a member of.
- min
Access numberLevel - Limit to projects where current user has at least this access level, refer to the official documentation for values. Cannot be used with
group_id. - order
By string - Return projects ordered ordered by:
id,name,path,created_at,updated_at,last_activity_at,similarity,repository_size,storage_size,packages_size,wiki_size. Some values or only available in certain circumstances. See upstream docs for details. - owned boolean
- Limit by projects owned by the current user.
- page number
- The first page to begin the query on.
- per
Page number - The number of results to return per page.
- search string
- Return list of authorized projects matching the search criteria.
- simple boolean
- Return only the ID, URL, name, and path of each project.
- sort string
- Return projects sorted in
ascordescorder. Default isdesc. - starred boolean
- Limit by projects starred by the current user.
- statistics boolean
- Include project statistics. Cannot be used with
group_id. - topics string[]
- Limit by projects that have all of the given topics.
- visibility string
- Limit by visibility
public,internal, orprivate. - with
Custom booleanAttributes - Include custom attributes in response (admins only).
- with
Issues booleanEnabled - Limit by projects with issues feature enabled. Default is
false. - with
Merge booleanRequests Enabled - Limit by projects with merge requests feature enabled. Default is
false. - with
Programming stringLanguage - Limit by projects which use the given programming language. Cannot be used with
group_id. - boolean
- Include projects shared to this group. Default is
true. Needsgroup_id.
- archived bool
- Limit by archived status.
- group_
id int - The ID of the group owned by the authenticated user to look projects for within. Cannot be used with
min_access_level,with_programming_languageorstatistics. - include_
subgroups bool - Include projects in subgroups of this group. Default is
false. Needsgroup_id. - max_
queryable_ intpages - The maximum number of project results pages that may be queried. Prevents overloading your Gitlab instance in case of a misconfiguration.
- membership bool
- Limit by projects that the current user is a member of.
- min_
access_ intlevel - Limit to projects where current user has at least this access level, refer to the official documentation for values. Cannot be used with
group_id. - order_
by str - Return projects ordered ordered by:
id,name,path,created_at,updated_at,last_activity_at,similarity,repository_size,storage_size,packages_size,wiki_size. Some values or only available in certain circumstances. See upstream docs for details. - owned bool
- Limit by projects owned by the current user.
- page int
- The first page to begin the query on.
- per_
page int - The number of results to return per page.
- search str
- Return list of authorized projects matching the search criteria.
- simple bool
- Return only the ID, URL, name, and path of each project.
- sort str
- Return projects sorted in
ascordescorder. Default isdesc. - starred bool
- Limit by projects starred by the current user.
- statistics bool
- Include project statistics. Cannot be used with
group_id. - topics Sequence[str]
- Limit by projects that have all of the given topics.
- visibility str
- Limit by visibility
public,internal, orprivate. - with_
custom_ boolattributes - Include custom attributes in response (admins only).
- with_
issues_ boolenabled - Limit by projects with issues feature enabled. Default is
false. - with_
merge_ boolrequests_ enabled - Limit by projects with merge requests feature enabled. Default is
false. - with_
programming_ strlanguage - Limit by projects which use the given programming language. Cannot be used with
group_id. - bool
- Include projects shared to this group. Default is
true. Needsgroup_id.
- archived Boolean
- Limit by archived status.
- group
Id Number - The ID of the group owned by the authenticated user to look projects for within. Cannot be used with
min_access_level,with_programming_languageorstatistics. - include
Subgroups Boolean - Include projects in subgroups of this group. Default is
false. Needsgroup_id. - max
Queryable NumberPages - The maximum number of project results pages that may be queried. Prevents overloading your Gitlab instance in case of a misconfiguration.
- membership Boolean
- Limit by projects that the current user is a member of.
- min
Access NumberLevel - Limit to projects where current user has at least this access level, refer to the official documentation for values. Cannot be used with
group_id. - order
By String - Return projects ordered ordered by:
id,name,path,created_at,updated_at,last_activity_at,similarity,repository_size,storage_size,packages_size,wiki_size. Some values or only available in certain circumstances. See upstream docs for details. - owned Boolean
- Limit by projects owned by the current user.
- page Number
- The first page to begin the query on.
- per
Page Number - The number of results to return per page.
- search String
- Return list of authorized projects matching the search criteria.
- simple Boolean
- Return only the ID, URL, name, and path of each project.
- sort String
- Return projects sorted in
ascordescorder. Default isdesc. - starred Boolean
- Limit by projects starred by the current user.
- statistics Boolean
- Include project statistics. Cannot be used with
group_id. - topics List<String>
- Limit by projects that have all of the given topics.
- visibility String
- Limit by visibility
public,internal, orprivate. - with
Custom BooleanAttributes - Include custom attributes in response (admins only).
- with
Issues BooleanEnabled - Limit by projects with issues feature enabled. Default is
false. - with
Merge BooleanRequests Enabled - Limit by projects with merge requests feature enabled. Default is
false. - with
Programming StringLanguage - Limit by projects which use the given programming language. Cannot be used with
group_id. - Boolean
- Include projects shared to this group. Default is
true. Needsgroup_id.
getProjects Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Projects
List<Pulumi.
Git Lab. Outputs. Get Projects Project> - A list containing the projects matching the supplied arguments
- Archived bool
- Limit by archived status.
- Group
Id int - The ID of the group owned by the authenticated user to look projects for within. Cannot be used with
min_access_level,with_programming_languageorstatistics. - Include
Subgroups bool - Include projects in subgroups of this group. Default is
false. Needsgroup_id. - Max
Queryable intPages - The maximum number of project results pages that may be queried. Prevents overloading your Gitlab instance in case of a misconfiguration.
- Membership bool
- Limit by projects that the current user is a member of.
- Min
Access intLevel - Limit to projects where current user has at least this access level, refer to the official documentation for values. Cannot be used with
group_id. - Order
By string - Return projects ordered ordered by:
id,name,path,created_at,updated_at,last_activity_at,similarity,repository_size,storage_size,packages_size,wiki_size. Some values or only available in certain circumstances. See upstream docs for details. - Owned bool
- Limit by projects owned by the current user.
- Page int
- The first page to begin the query on.
- Per
Page int - The number of results to return per page.
- Search string
- Return list of authorized projects matching the search criteria.
- Simple bool
- Return only the ID, URL, name, and path of each project.
- Sort string
- Return projects sorted in
ascordescorder. Default isdesc. - Starred bool
- Limit by projects starred by the current user.
- Statistics bool
- Include project statistics. Cannot be used with
group_id. - Topics List<string>
- Limit by projects that have all of the given topics.
- Visibility string
- Limit by visibility
public,internal, orprivate. - With
Custom boolAttributes - Include custom attributes in response (admins only).
- With
Issues boolEnabled - Limit by projects with issues feature enabled. Default is
false. - With
Merge boolRequests Enabled - Limit by projects with merge requests feature enabled. Default is
false. - With
Programming stringLanguage - Limit by projects which use the given programming language. Cannot be used with
group_id. - bool
- Include projects shared to this group. Default is
true. Needsgroup_id.
- Id string
- The provider-assigned unique ID for this managed resource.
- Projects
[]Get
Projects Project - A list containing the projects matching the supplied arguments
- Archived bool
- Limit by archived status.
- Group
Id int - The ID of the group owned by the authenticated user to look projects for within. Cannot be used with
min_access_level,with_programming_languageorstatistics. - Include
Subgroups bool - Include projects in subgroups of this group. Default is
false. Needsgroup_id. - Max
Queryable intPages - The maximum number of project results pages that may be queried. Prevents overloading your Gitlab instance in case of a misconfiguration.
- Membership bool
- Limit by projects that the current user is a member of.
- Min
Access intLevel - Limit to projects where current user has at least this access level, refer to the official documentation for values. Cannot be used with
group_id. - Order
By string - Return projects ordered ordered by:
id,name,path,created_at,updated_at,last_activity_at,similarity,repository_size,storage_size,packages_size,wiki_size. Some values or only available in certain circumstances. See upstream docs for details. - Owned bool
- Limit by projects owned by the current user.
- Page int
- The first page to begin the query on.
- Per
Page int - The number of results to return per page.
- Search string
- Return list of authorized projects matching the search criteria.
- Simple bool
- Return only the ID, URL, name, and path of each project.
- Sort string
- Return projects sorted in
ascordescorder. Default isdesc. - Starred bool
- Limit by projects starred by the current user.
- Statistics bool
- Include project statistics. Cannot be used with
group_id. - Topics []string
- Limit by projects that have all of the given topics.
- Visibility string
- Limit by visibility
public,internal, orprivate. - With
Custom boolAttributes - Include custom attributes in response (admins only).
- With
Issues boolEnabled - Limit by projects with issues feature enabled. Default is
false. - With
Merge boolRequests Enabled - Limit by projects with merge requests feature enabled. Default is
false. - With
Programming stringLanguage - Limit by projects which use the given programming language. Cannot be used with
group_id. - bool
- Include projects shared to this group. Default is
true. Needsgroup_id.
- id String
- The provider-assigned unique ID for this managed resource.
- projects
List<Get
Projects Project> - A list containing the projects matching the supplied arguments
- archived Boolean
- Limit by archived status.
- group
Id Integer - The ID of the group owned by the authenticated user to look projects for within. Cannot be used with
min_access_level,with_programming_languageorstatistics. - include
Subgroups Boolean - Include projects in subgroups of this group. Default is
false. Needsgroup_id. - max
Queryable IntegerPages - The maximum number of project results pages that may be queried. Prevents overloading your Gitlab instance in case of a misconfiguration.
- membership Boolean
- Limit by projects that the current user is a member of.
- min
Access IntegerLevel - Limit to projects where current user has at least this access level, refer to the official documentation for values. Cannot be used with
group_id. - order
By String - Return projects ordered ordered by:
id,name,path,created_at,updated_at,last_activity_at,similarity,repository_size,storage_size,packages_size,wiki_size. Some values or only available in certain circumstances. See upstream docs for details. - owned Boolean
- Limit by projects owned by the current user.
- page Integer
- The first page to begin the query on.
- per
Page Integer - The number of results to return per page.
- search String
- Return list of authorized projects matching the search criteria.
- simple Boolean
- Return only the ID, URL, name, and path of each project.
- sort String
- Return projects sorted in
ascordescorder. Default isdesc. - starred Boolean
- Limit by projects starred by the current user.
- statistics Boolean
- Include project statistics. Cannot be used with
group_id. - topics List<String>
- Limit by projects that have all of the given topics.
- visibility String
- Limit by visibility
public,internal, orprivate. - with
Custom BooleanAttributes - Include custom attributes in response (admins only).
- with
Issues BooleanEnabled - Limit by projects with issues feature enabled. Default is
false. - with
Merge BooleanRequests Enabled - Limit by projects with merge requests feature enabled. Default is
false. - with
Programming StringLanguage - Limit by projects which use the given programming language. Cannot be used with
group_id. - Boolean
- Include projects shared to this group. Default is
true. Needsgroup_id.
- id string
- The provider-assigned unique ID for this managed resource.
- projects
Get
Projects Project[] - A list containing the projects matching the supplied arguments
- archived boolean
- Limit by archived status.
- group
Id number - The ID of the group owned by the authenticated user to look projects for within. Cannot be used with
min_access_level,with_programming_languageorstatistics. - include
Subgroups boolean - Include projects in subgroups of this group. Default is
false. Needsgroup_id. - max
Queryable numberPages - The maximum number of project results pages that may be queried. Prevents overloading your Gitlab instance in case of a misconfiguration.
- membership boolean
- Limit by projects that the current user is a member of.
- min
Access numberLevel - Limit to projects where current user has at least this access level, refer to the official documentation for values. Cannot be used with
group_id. - order
By string - Return projects ordered ordered by:
id,name,path,created_at,updated_at,last_activity_at,similarity,repository_size,storage_size,packages_size,wiki_size. Some values or only available in certain circumstances. See upstream docs for details. - owned boolean
- Limit by projects owned by the current user.
- page number
- The first page to begin the query on.
- per
Page number - The number of results to return per page.
- search string
- Return list of authorized projects matching the search criteria.
- simple boolean
- Return only the ID, URL, name, and path of each project.
- sort string
- Return projects sorted in
ascordescorder. Default isdesc. - starred boolean
- Limit by projects starred by the current user.
- statistics boolean
- Include project statistics. Cannot be used with
group_id. - topics string[]
- Limit by projects that have all of the given topics.
- visibility string
- Limit by visibility
public,internal, orprivate. - with
Custom booleanAttributes - Include custom attributes in response (admins only).
- with
Issues booleanEnabled - Limit by projects with issues feature enabled. Default is
false. - with
Merge booleanRequests Enabled - Limit by projects with merge requests feature enabled. Default is
false. - with
Programming stringLanguage - Limit by projects which use the given programming language. Cannot be used with
group_id. - boolean
- Include projects shared to this group. Default is
true. Needsgroup_id.
- id str
- The provider-assigned unique ID for this managed resource.
- projects
Sequence[Get
Projects Project] - A list containing the projects matching the supplied arguments
- archived bool
- Limit by archived status.
- group_
id int - The ID of the group owned by the authenticated user to look projects for within. Cannot be used with
min_access_level,with_programming_languageorstatistics. - include_
subgroups bool - Include projects in subgroups of this group. Default is
false. Needsgroup_id. - max_
queryable_ intpages - The maximum number of project results pages that may be queried. Prevents overloading your Gitlab instance in case of a misconfiguration.
- membership bool
- Limit by projects that the current user is a member of.
- min_
access_ intlevel - Limit to projects where current user has at least this access level, refer to the official documentation for values. Cannot be used with
group_id. - order_
by str - Return projects ordered ordered by:
id,name,path,created_at,updated_at,last_activity_at,similarity,repository_size,storage_size,packages_size,wiki_size. Some values or only available in certain circumstances. See upstream docs for details. - owned bool
- Limit by projects owned by the current user.
- page int
- The first page to begin the query on.
- per_
page int - The number of results to return per page.
- search str
- Return list of authorized projects matching the search criteria.
- simple bool
- Return only the ID, URL, name, and path of each project.
- sort str
- Return projects sorted in
ascordescorder. Default isdesc. - starred bool
- Limit by projects starred by the current user.
- statistics bool
- Include project statistics. Cannot be used with
group_id. - topics Sequence[str]
- Limit by projects that have all of the given topics.
- visibility str
- Limit by visibility
public,internal, orprivate. - with_
custom_ boolattributes - Include custom attributes in response (admins only).
- with_
issues_ boolenabled - Limit by projects with issues feature enabled. Default is
false. - with_
merge_ boolrequests_ enabled - Limit by projects with merge requests feature enabled. Default is
false. - with_
programming_ strlanguage - Limit by projects which use the given programming language. Cannot be used with
group_id. - bool
- Include projects shared to this group. Default is
true. Needsgroup_id.
- id String
- The provider-assigned unique ID for this managed resource.
- projects List<Property Map>
- A list containing the projects matching the supplied arguments
- archived Boolean
- Limit by archived status.
- group
Id Number - The ID of the group owned by the authenticated user to look projects for within. Cannot be used with
min_access_level,with_programming_languageorstatistics. - include
Subgroups Boolean - Include projects in subgroups of this group. Default is
false. Needsgroup_id. - max
Queryable NumberPages - The maximum number of project results pages that may be queried. Prevents overloading your Gitlab instance in case of a misconfiguration.
- membership Boolean
- Limit by projects that the current user is a member of.
- min
Access NumberLevel - Limit to projects where current user has at least this access level, refer to the official documentation for values. Cannot be used with
group_id. - order
By String - Return projects ordered ordered by:
id,name,path,created_at,updated_at,last_activity_at,similarity,repository_size,storage_size,packages_size,wiki_size. Some values or only available in certain circumstances. See upstream docs for details. - owned Boolean
- Limit by projects owned by the current user.
- page Number
- The first page to begin the query on.
- per
Page Number - The number of results to return per page.
- search String
- Return list of authorized projects matching the search criteria.
- simple Boolean
- Return only the ID, URL, name, and path of each project.
- sort String
- Return projects sorted in
ascordescorder. Default isdesc. - starred Boolean
- Limit by projects starred by the current user.
- statistics Boolean
- Include project statistics. Cannot be used with
group_id. - topics List<String>
- Limit by projects that have all of the given topics.
- visibility String
- Limit by visibility
public,internal, orprivate. - with
Custom BooleanAttributes - Include custom attributes in response (admins only).
- with
Issues BooleanEnabled - Limit by projects with issues feature enabled. Default is
false. - with
Merge BooleanRequests Enabled - Limit by projects with merge requests feature enabled. Default is
false. - with
Programming StringLanguage - Limit by projects which use the given programming language. Cannot be used with
group_id. - Boolean
- Include projects shared to this group. Default is
true. Needsgroup_id.
Supporting Types
GetProjectsProject
- Allow
Merge boolOn Skipped Pipeline - Whether allow_merge_on_skipped_pipeline is 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 numbers of approvals needed in a merge requests.
- Archived bool
- Whether the project is 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,timed_incremental. - Auto
Devops boolEnabled - Enable Auto DevOps for this 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. - 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
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 project_path. The array might also include ref_type and ref. Defaults to ["project_path", "ref_type", "ref"]. Introduced in GitLab 17.10.
- 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,no_one_allowed - Ci
Restrict stringPipeline Cancellation Role - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer,maintainer,no one - Container
Expiration List<Pulumi.Policies Git Lab. Inputs. Get Projects Project Container Expiration Policy> - Set the image cleanup policy for this project. Note: this field is sometimes named
container_expiration_policy_attributesin the GitLab Upstream API. - 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.
- 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
- The description of the project.
- Emails
Enabled bool - Enable email notifications.
- Empty
Repo bool - Whether the project is empty.
- 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. Inputs. Get Projects 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 int
- The ID of the project.
- Import
Error string - The import error, if it exists, for the project.
- Import
Status string - The import status of the project.
- Import
Url string - URL the project was imported from.
- Infrastructure
Access stringLevel - Set the infrastructure access level. Valid values are
disabled,private,enabled. - Issues
Access stringLevel - Set the issues access level. Valid values are
disabled,private,enabled. - Issues
Enabled bool - Whether issues are enabled for the project.
- Jobs
Enabled bool - Whether pipelines 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 activirty time for the project.
- Lfs
Enabled bool - Whether LFS (large file storage) is enabled for the project.
- 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
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
Trains boolEnabled - Enable or disable merge trains.
- Mirror bool
- Whether the pull mirroring is enabled for the project.
- Mirror
Overwrites boolDiverged Branches - Whether mirror_overwrites_diverged_branches is 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. - Name string
- The name of the project.
- Name
With stringNamespace - In
group / subgroup / projectoruser / projectformat. - Namespaces
List<Pulumi.
Git Lab. Inputs. Get Projects Project Namespace> - Namespace of the project (parent group/s).
- Only
Allow boolMerge If All Discussions Are Resolved - Whether only_allow_merge_if_all_discussions_are_resolved is enabled for the project.
- Only
Allow boolMerge If Pipeline Succeeds - Whether only_allow_merge_if_pipeline_succeeds is enabled for the project.
- Only
Mirror boolProtected Branches - Whether only_mirror_protected_branches is enabled for the project.
- Open
Issues intCount - The number of open issies for the project.
- Owners
List<Pulumi.
Git Lab. Inputs. Get Projects Project Owner> - Packages
Enabled bool - Whether packages are enabled for the project.
- Path string
- The path of the project.
- Path
With stringNamespace - In
group/subgroup/projectoruser/projectformat. - Permissions
List<Pulumi.
Git Lab. Inputs. Get Projects Project Permission> - Permissions for the project.
- Prevent
Merge boolWithout Jira Issue - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- Public
Builds bool - Whether public builds are enabled for the project.
- Readme
Url string - The remote url of the project.
- Releases
Access stringLevel - Set the releases access level. Valid values are
disabled,private,enabled. - 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. - Resolve
Outdated boolDiff Discussions - Whether resolve_outdated_diff_discussions is enabled for the project
- Restrict
User boolDefined Variables - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- Runners
Token string - The runners token for the project.
- Security
And stringCompliance Access Level - Set the security and compliance access level. Valid values are
disabled,private,enabled. - bool
- Whether shared runners are enabled for the project.
-
List<Pulumi.
Git Lab. Inputs. Get Projects Project Shared With Group> - Groups the the project is shared with.
- 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.
- 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> - A set of the project topics (formerly called "project tags").
- Topics List<string>
- The list of topics for the project.
- Visibility string
- The visibility of the project.
- Web
Url string - The web url of the project.
- Wiki
Access stringLevel - Set the wiki access level. Valid values are
disabled,private,enabled. - Wiki
Enabled bool - Whether wiki is enabled for the project.
- _
links Dictionary<string, string> - Links for the project.
- Allow
Merge boolOn Skipped Pipeline - Whether allow_merge_on_skipped_pipeline is 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 numbers of approvals needed in a merge requests.
- Archived bool
- Whether the project is 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,timed_incremental. - Auto
Devops boolEnabled - Enable Auto DevOps for this 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. - 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
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 project_path. The array might also include ref_type and ref. Defaults to ["project_path", "ref_type", "ref"]. Introduced in GitLab 17.10.
- 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,no_one_allowed - Ci
Restrict stringPipeline Cancellation Role - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer,maintainer,no one - Container
Expiration []GetPolicies Projects Project Container Expiration Policy - Set the image cleanup policy for this project. Note: this field is sometimes named
container_expiration_policy_attributesin the GitLab Upstream API. - 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.
- 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
- The description of the project.
- Emails
Enabled bool - Enable email notifications.
- Empty
Repo bool - Whether the project is empty.
- 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 Projects 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 int
- The ID of the project.
- Import
Error string - The import error, if it exists, for the project.
- Import
Status string - The import status of the project.
- Import
Url string - URL the project was imported from.
- Infrastructure
Access stringLevel - Set the infrastructure access level. Valid values are
disabled,private,enabled. - Issues
Access stringLevel - Set the issues access level. Valid values are
disabled,private,enabled. - Issues
Enabled bool - Whether issues are enabled for the project.
- Jobs
Enabled bool - Whether pipelines 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 activirty time for the project.
- Lfs
Enabled bool - Whether LFS (large file storage) is enabled for the project.
- 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
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
Trains boolEnabled - Enable or disable merge trains.
- Mirror bool
- Whether the pull mirroring is enabled for the project.
- Mirror
Overwrites boolDiverged Branches - Whether mirror_overwrites_diverged_branches is 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. - Name string
- The name of the project.
- Name
With stringNamespace - In
group / subgroup / projectoruser / projectformat. - Namespaces
[]Get
Projects Project Namespace - Namespace of the project (parent group/s).
- Only
Allow boolMerge If All Discussions Are Resolved - Whether only_allow_merge_if_all_discussions_are_resolved is enabled for the project.
- Only
Allow boolMerge If Pipeline Succeeds - Whether only_allow_merge_if_pipeline_succeeds is enabled for the project.
- Only
Mirror boolProtected Branches - Whether only_mirror_protected_branches is enabled for the project.
- Open
Issues intCount - The number of open issies for the project.
- Owners
[]Get
Projects Project Owner - Packages
Enabled bool - Whether packages are enabled for the project.
- Path string
- The path of the project.
- Path
With stringNamespace - In
group/subgroup/projectoruser/projectformat. - Permissions
[]Get
Projects Project Permission - Permissions for the project.
- Prevent
Merge boolWithout Jira Issue - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- Public
Builds bool - Whether public builds are enabled for the project.
- Readme
Url string - The remote url of the project.
- Releases
Access stringLevel - Set the releases access level. Valid values are
disabled,private,enabled. - 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. - Resolve
Outdated boolDiff Discussions - Whether resolve_outdated_diff_discussions is enabled for the project
- Restrict
User boolDefined Variables - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- Runners
Token string - The runners token for the project.
- Security
And stringCompliance Access Level - Set the security and compliance access level. Valid values are
disabled,private,enabled. - bool
- Whether shared runners are enabled for the project.
-
[]Get
Projects Project Shared With Group - Groups the the project is shared with.
- 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.
- 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 - A set of the project topics (formerly called "project tags").
- Topics []string
- The list of topics for the project.
- Visibility string
- The visibility of the project.
- Web
Url string - The web url of the project.
- Wiki
Access stringLevel - Set the wiki access level. Valid values are
disabled,private,enabled. - Wiki
Enabled bool - Whether wiki is enabled for the project.
- _
links map[string]string - Links for the project.
- _
links Map<String,String> - Links for the project.
- allow
Merge BooleanOn Skipped Pipeline - Whether allow_merge_on_skipped_pipeline is 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 numbers of approvals needed in a merge requests.
- archived Boolean
- Whether the project is 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,timed_incremental. - auto
Devops BooleanEnabled - Enable Auto DevOps for this 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. - 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
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 project_path. The array might also include ref_type and ref. Defaults to ["project_path", "ref_type", "ref"]. Introduced in GitLab 17.10.
- 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,no_one_allowed - ci
Restrict StringPipeline Cancellation Role - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer,maintainer,no one - container
Expiration List<GetPolicies Projects Project Container Expiration Policy> - Set the image cleanup policy for this project. Note: this field is sometimes named
container_expiration_policy_attributesin the GitLab Upstream API. - 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.
- 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
- The description of the project.
- emails
Enabled Boolean - Enable email notifications.
- empty
Repo Boolean - Whether the project is empty.
- 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 Projects 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 Integer
- The ID of the project.
- import
Error String - The import error, if it exists, for the project.
- import
Status String - The import status of the project.
- import
Url String - URL the project was imported from.
- infrastructure
Access StringLevel - Set the infrastructure access level. Valid values are
disabled,private,enabled. - issues
Access StringLevel - Set the issues access level. Valid values are
disabled,private,enabled. - issues
Enabled Boolean - Whether issues are enabled for the project.
- jobs
Enabled Boolean - Whether pipelines 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 activirty time for the project.
- lfs
Enabled Boolean - Whether LFS (large file storage) is enabled for the project.
- 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
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
Trains BooleanEnabled - Enable or disable merge trains.
- mirror Boolean
- Whether the pull mirroring is enabled for the project.
- mirror
Overwrites BooleanDiverged Branches - Whether mirror_overwrites_diverged_branches is 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. - name String
- The name of the project.
- name
With StringNamespace - In
group / subgroup / projectoruser / projectformat. - namespaces
List<Get
Projects Project Namespace> - Namespace of the project (parent group/s).
- only
Allow BooleanMerge If All Discussions Are Resolved - Whether only_allow_merge_if_all_discussions_are_resolved is enabled for the project.
- only
Allow BooleanMerge If Pipeline Succeeds - Whether only_allow_merge_if_pipeline_succeeds is enabled for the project.
- only
Mirror BooleanProtected Branches - Whether only_mirror_protected_branches is enabled for the project.
- open
Issues IntegerCount - The number of open issies for the project.
- owners
List<Get
Projects Project Owner> - packages
Enabled Boolean - Whether packages are enabled for the project.
- path String
- The path of the project.
- path
With StringNamespace - In
group/subgroup/projectoruser/projectformat. - permissions
List<Get
Projects Project Permission> - Permissions for the project.
- prevent
Merge BooleanWithout Jira Issue - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- public
Builds Boolean - Whether public builds are enabled for the project.
- readme
Url String - The remote url of the project.
- releases
Access StringLevel - Set the releases access level. Valid values are
disabled,private,enabled. - 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. - resolve
Outdated BooleanDiff Discussions - Whether resolve_outdated_diff_discussions is enabled for the project
- restrict
User BooleanDefined Variables - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- runners
Token String - The runners token for the project.
- security
And StringCompliance Access Level - Set the security and compliance access level. Valid values are
disabled,private,enabled. - Boolean
- Whether shared runners are enabled for the project.
-
List<Get
Projects Project Shared With Group> - Groups the the project is shared with.
- 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.
- 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> - A set of the project topics (formerly called "project tags").
- topics List<String>
- The list of topics for the project.
- visibility String
- The visibility of the project.
- web
Url String - The web url of the project.
- wiki
Access StringLevel - Set the wiki access level. Valid values are
disabled,private,enabled. - wiki
Enabled Boolean - Whether wiki is enabled for the project.
- _
links {[key: string]: string} - Links for the project.
- allow
Merge booleanOn Skipped Pipeline - Whether allow_merge_on_skipped_pipeline is 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 numbers of approvals needed in a merge requests.
- archived boolean
- Whether the project is 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,timed_incremental. - auto
Devops booleanEnabled - Enable Auto DevOps for this 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. - 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
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 project_path. The array might also include ref_type and ref. Defaults to ["project_path", "ref_type", "ref"]. Introduced in GitLab 17.10.
- 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,no_one_allowed - ci
Restrict stringPipeline Cancellation Role - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer,maintainer,no one - container
Expiration GetPolicies Projects Project Container Expiration Policy[] - Set the image cleanup policy for this project. Note: this field is sometimes named
container_expiration_policy_attributesin the GitLab Upstream API. - 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.
- 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
- The description of the project.
- emails
Enabled boolean - Enable email notifications.
- empty
Repo boolean - Whether the project is empty.
- 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 Projects 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 number
- The ID of the project.
- import
Error string - The import error, if it exists, for the project.
- import
Status string - The import status of the project.
- import
Url string - URL the project was imported from.
- infrastructure
Access stringLevel - Set the infrastructure access level. Valid values are
disabled,private,enabled. - issues
Access stringLevel - Set the issues access level. Valid values are
disabled,private,enabled. - issues
Enabled boolean - Whether issues are enabled for the project.
- jobs
Enabled boolean - Whether pipelines 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 activirty time for the project.
- lfs
Enabled boolean - Whether LFS (large file storage) is enabled for the project.
- 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
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
Trains booleanEnabled - Enable or disable merge trains.
- mirror boolean
- Whether the pull mirroring is enabled for the project.
- mirror
Overwrites booleanDiverged Branches - Whether mirror_overwrites_diverged_branches is 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. - name string
- The name of the project.
- name
With stringNamespace - In
group / subgroup / projectoruser / projectformat. - namespaces
Get
Projects Project Namespace[] - Namespace of the project (parent group/s).
- only
Allow booleanMerge If All Discussions Are Resolved - Whether only_allow_merge_if_all_discussions_are_resolved is enabled for the project.
- only
Allow booleanMerge If Pipeline Succeeds - Whether only_allow_merge_if_pipeline_succeeds is enabled for the project.
- only
Mirror booleanProtected Branches - Whether only_mirror_protected_branches is enabled for the project.
- open
Issues numberCount - The number of open issies for the project.
- owners
Get
Projects Project Owner[] - packages
Enabled boolean - Whether packages are enabled for the project.
- path string
- The path of the project.
- path
With stringNamespace - In
group/subgroup/projectoruser/projectformat. - permissions
Get
Projects Project Permission[] - Permissions for the project.
- prevent
Merge booleanWithout Jira Issue - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- public
Builds boolean - Whether public builds are enabled for the project.
- readme
Url string - The remote url of the project.
- releases
Access stringLevel - Set the releases access level. Valid values are
disabled,private,enabled. - 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. - resolve
Outdated booleanDiff Discussions - Whether resolve_outdated_diff_discussions is enabled for the project
- restrict
User booleanDefined Variables - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- runners
Token string - The runners token for the project.
- security
And stringCompliance Access Level - Set the security and compliance access level. Valid values are
disabled,private,enabled. - boolean
- Whether shared runners are enabled for the project.
-
Get
Projects Project Shared With Group[] - Groups the the project is shared with.
- 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.
- 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[] - A set of the project topics (formerly called "project tags").
- topics string[]
- The list of topics for the project.
- visibility string
- The visibility of the project.
- web
Url string - The web url of the project.
- wiki
Access stringLevel - Set the wiki access level. Valid values are
disabled,private,enabled. - wiki
Enabled boolean - Whether wiki is enabled for the project.
- _
links Mapping[str, str] - Links for the project.
- allow_
merge_ boolon_ skipped_ pipeline - Whether allow_merge_on_skipped_pipeline is 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 numbers of approvals needed in a merge requests.
- archived bool
- Whether the project is 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,timed_incremental. - auto_
devops_ boolenabled - Enable Auto DevOps for this 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. - 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_
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 project_path. The array might also include ref_type and ref. Defaults to ["project_path", "ref_type", "ref"]. Introduced in GitLab 17.10.
- 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,no_one_allowed - ci_
restrict_ strpipeline_ cancellation_ role - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer,maintainer,no one - container_
expiration_ Sequence[Getpolicies Projects Project Container Expiration Policy] - Set the image cleanup policy for this project. Note: this field is sometimes named
container_expiration_policy_attributesin the GitLab Upstream API. - 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.
- 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
- The description of the project.
- emails_
enabled bool - Enable email notifications.
- empty_
repo bool - Whether the project is empty.
- 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 Projects 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 int
- The ID of the project.
- import_
error str - The import error, if it exists, for the project.
- import_
status str - The import status of the project.
- import_
url str - URL the project was imported from.
- infrastructure_
access_ strlevel - Set the infrastructure access level. Valid values are
disabled,private,enabled. - issues_
access_ strlevel - Set the issues access level. Valid values are
disabled,private,enabled. - issues_
enabled bool - Whether issues are enabled for the project.
- jobs_
enabled bool - Whether pipelines 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 activirty time for the project.
- lfs_
enabled bool - Whether LFS (large file storage) is enabled for the project.
- 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_
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_
trains_ boolenabled - Enable or disable merge trains.
- mirror bool
- Whether the pull mirroring is enabled for the project.
- mirror_
overwrites_ booldiverged_ branches - Whether mirror_overwrites_diverged_branches is 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. - name str
- The name of the project.
- name_
with_ strnamespace - In
group / subgroup / projectoruser / projectformat. - namespaces
Sequence[Get
Projects Project Namespace] - Namespace of the project (parent group/s).
- only_
allow_ boolmerge_ if_ all_ discussions_ are_ resolved - Whether only_allow_merge_if_all_discussions_are_resolved is enabled for the project.
- only_
allow_ boolmerge_ if_ pipeline_ succeeds - Whether only_allow_merge_if_pipeline_succeeds is enabled for the project.
- only_
mirror_ boolprotected_ branches - Whether only_mirror_protected_branches is enabled for the project.
- open_
issues_ intcount - The number of open issies for the project.
- owners
Sequence[Get
Projects Project Owner] - packages_
enabled bool - Whether packages are enabled for the project.
- path str
- The path of the project.
- path_
with_ strnamespace - In
group/subgroup/projectoruser/projectformat. - permissions
Sequence[Get
Projects Project Permission] - Permissions for the project.
- prevent_
merge_ boolwithout_ jira_ issue - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- public_
builds bool - Whether public builds are enabled for the project.
- readme_
url str - The remote url of the project.
- releases_
access_ strlevel - Set the releases access level. Valid values are
disabled,private,enabled. - 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. - resolve_
outdated_ booldiff_ discussions - Whether resolve_outdated_diff_discussions is enabled for the project
- restrict_
user_ booldefined_ variables - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- runners_
token str - The runners token for the project.
- security_
and_ strcompliance_ access_ level - Set the security and compliance access level. Valid values are
disabled,private,enabled. - bool
- Whether shared runners are enabled for the project.
-
Sequence[Get
Projects Project Shared With Group] - Groups the the project is shared with.
- 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.
- 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] - A set of the project topics (formerly called "project tags").
- topics Sequence[str]
- The list of topics for the project.
- visibility str
- The visibility of the project.
- web_
url str - The web url of the project.
- wiki_
access_ strlevel - Set the wiki access level. Valid values are
disabled,private,enabled. - wiki_
enabled bool - Whether wiki is enabled for the project.
- _
links Map<String> - Links for the project.
- allow
Merge BooleanOn Skipped Pipeline - Whether allow_merge_on_skipped_pipeline is 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 numbers of approvals needed in a merge requests.
- archived Boolean
- Whether the project is 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,timed_incremental. - auto
Devops BooleanEnabled - Enable Auto DevOps for this 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. - 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
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 project_path. The array might also include ref_type and ref. Defaults to ["project_path", "ref_type", "ref"]. Introduced in GitLab 17.10.
- 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,no_one_allowed - ci
Restrict StringPipeline Cancellation Role - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer,maintainer,no one - container
Expiration List<Property Map>Policies - Set the image cleanup policy for this project. Note: this field is sometimes named
container_expiration_policy_attributesin the GitLab Upstream API. - 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.
- 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
- The description of the project.
- emails
Enabled Boolean - Enable email notifications.
- empty
Repo Boolean - Whether the project is empty.
- 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 Number
- The ID of the project.
- import
Error String - The import error, if it exists, for the project.
- import
Status String - The import status of the project.
- import
Url String - URL the project was imported from.
- infrastructure
Access StringLevel - Set the infrastructure access level. Valid values are
disabled,private,enabled. - issues
Access StringLevel - Set the issues access level. Valid values are
disabled,private,enabled. - issues
Enabled Boolean - Whether issues are enabled for the project.
- jobs
Enabled Boolean - Whether pipelines 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 activirty time for the project.
- lfs
Enabled Boolean - Whether LFS (large file storage) is enabled for the project.
- 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
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
Trains BooleanEnabled - Enable or disable merge trains.
- mirror Boolean
- Whether the pull mirroring is enabled for the project.
- mirror
Overwrites BooleanDiverged Branches - Whether mirror_overwrites_diverged_branches is 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. - name String
- The name of the project.
- name
With StringNamespace - In
group / subgroup / projectoruser / projectformat. - namespaces List<Property Map>
- Namespace of the project (parent group/s).
- only
Allow BooleanMerge If All Discussions Are Resolved - Whether only_allow_merge_if_all_discussions_are_resolved is enabled for the project.
- only
Allow BooleanMerge If Pipeline Succeeds - Whether only_allow_merge_if_pipeline_succeeds is enabled for the project.
- only
Mirror BooleanProtected Branches - Whether only_mirror_protected_branches is enabled for the project.
- open
Issues NumberCount - The number of open issies for the project.
- owners List<Property Map>
- packages
Enabled Boolean - Whether packages are enabled for the project.
- path String
- The path of the project.
- path
With StringNamespace - In
group/subgroup/projectoruser/projectformat. - permissions List<Property Map>
- Permissions for the project.
- prevent
Merge BooleanWithout Jira Issue - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- public
Builds Boolean - Whether public builds are enabled for the project.
- readme
Url String - The remote url of the project.
- releases
Access StringLevel - Set the releases access level. Valid values are
disabled,private,enabled. - 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. - resolve
Outdated BooleanDiff Discussions - Whether resolve_outdated_diff_discussions is enabled for the project
- restrict
User BooleanDefined Variables - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- runners
Token String - The runners token for the project.
- security
And StringCompliance Access Level - Set the security and compliance access level. Valid values are
disabled,private,enabled. - Boolean
- Whether shared runners are enabled for the project.
- List<Property Map>
- Groups the the project is shared with.
- 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.
- 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> - A set of the project topics (formerly called "project tags").
- topics List<String>
- The list of topics for the project.
- visibility String
- The visibility of the project.
- web
Url String - The web url of the project.
- wiki
Access StringLevel - Set the wiki access level. Valid values are
disabled,private,enabled. - wiki
Enabled Boolean - Whether wiki is enabled for the project.
GetProjectsProjectContainerExpirationPolicy
- 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 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.
GetProjectsProjectForkedFromProject
- 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 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.
GetProjectsProjectNamespace
GetProjectsProjectOwner
- 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.
GetProjectsProjectPermission
- 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<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.
GetProjectsProjectSharedWithGroup
- Group
Access stringLevel - The group access level.
- Group
Id int - The group ID.
- Group
Name string - The group name.
- Group
Access stringLevel - The group access level.
- Group
Id int - The group ID.
- Group
Name string - The group name.
- group
Access StringLevel - The group access level.
- group
Id Integer - The group ID.
- group
Name String - The group name.
- group
Access stringLevel - The group access level.
- group
Id number - The group ID.
- group
Name string - The group name.
- group_
access_ strlevel - The group access level.
- group_
id int - The group ID.
- group_
name str - The group name.
- group
Access StringLevel - The group access level.
- group
Id Number - The group ID.
- group
Name String - The group name.
Package Details
- Repository
- GitLab pulumi/pulumi-gitlab
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
gitlabTerraform Provider.
