gitlab.getProjects
Explore with Pulumi AI
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/v8/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.applyValue(getGroupResult -> getGroupResult.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 dictionary
The 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_language
orstatistics
. - 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
asc
ordesc
order. 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_language
orstatistics
. - 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
asc
ordesc
order. 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_language
orstatistics
. - 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
asc
ordesc
order. 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_language
orstatistics
. - 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
asc
ordesc
order. 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_language
orstatistics
. - 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
asc
ordesc
order. 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_language
orstatistics
. - 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
asc
ordesc
order. 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_language
orstatistics
. - 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
asc
ordesc
order. 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_language
orstatistics
. - 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
asc
ordesc
order. 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_language
orstatistics
. - 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
asc
ordesc
order. 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_language
orstatistics
. - 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
asc
ordesc
order. 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_language
orstatistics
. - 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
asc
ordesc
order. 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_language
orstatistics
. - 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
asc
ordesc
order. 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 On Skipped Pipeline This property is required. bool - Whether allow_merge_on_skipped_pipeline is enabled for the project.
- Allow
Pipeline Trigger Approve Deployment This property is required. bool - Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only.
- Analytics
Access Level This property is required. string - Set the analytics access level. Valid values are
disabled
,private
,enabled
. - Approvals
Before Merge This property is required. int - The numbers of approvals needed in a merge requests.
- Archived
This property is required. bool - Whether the project is archived.
- Auto
Cancel Pending Pipelines This property is required. string - Auto-cancel pending pipelines. This isn’t a boolean, but enabled/disabled.
- Auto
Devops Deploy Strategy This property is required. string - Auto Deploy strategy. Valid values are
continuous
,manual
,timed_incremental
. - Auto
Devops Enabled This property is required. bool - Enable Auto DevOps for this project.
- Autoclose
Referenced Issues This property is required. bool - Set whether auto-closing referenced issues on default branch.
- Avatar
Url This property is required. string - The avatar url of the project.
- Build
Coverage Regex This property is required. string - Build coverage regex for the project.
- Build
Git Strategy This property is required. string - The Git strategy. Defaults to fetch.
- Build
Timeout This property is required. int - The maximum amount of time, in seconds, that a job can run.
- Builds
Access Level This property is required. string - Set the builds access level. Valid values are
disabled
,private
,enabled
. - Ci
Config Path This property is required. string - CI config file path for the project.
- Ci
Default Git Depth This property is required. int - Default number of revisions for shallow cloning.
- Ci
Forward Deployment Enabled This property is required. bool - When a new deployment job starts, skip older deployment jobs that are still pending.
- Ci
Pipeline Variables Minimum Override Role This property is required. string - 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 Pipeline Cancellation Role This property is required. string - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer
,maintainer
,no one
- Container
Expiration Policies This property is required. List<Pulumi.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_attributes
in the GitLab Upstream API. - Container
Registry Access Level This property is required. string - Set visibility of container registry, for this project. Valid values are
disabled
,private
,enabled
. - Container
Registry Enabled This property is required. bool - Whether the container registry is enabled for the project.
- Created
At This property is required. string - Creation time for the project.
- Creator
Id This property is required. int - Creator ID for the project.
- Custom
Attributes This property is required. List<ImmutableDictionary<string, string>> - Custom attributes for the project.
- Default
Branch This property is required. string - The default branch name of the project.
- Description
This property is required. string - The description of the project.
- Emails
Enabled This property is required. bool - Enable email notifications.
- Empty
Repo This property is required. bool - Whether the project is empty.
- Environments
Access Level This property is required. string - Set the environments access level. Valid values are
disabled
,private
,enabled
. This property is required. string- The classification label for the project.
- Feature
Flags Access Level This property is required. string - Set the feature flags access level. Valid values are
disabled
,private
,enabled
. - Forked
From Projects This property is required. List<Pulumi.Git Lab. Inputs. Get Projects Project Forked From Project> - Present if the project is a fork. Contains information about the upstream project.
- Forking
Access Level This property is required. string - Set the forking access level. Valid values are
disabled
,private
,enabled
. - Forks
Count This property is required. int - The number of forks of the project.
- Group
Runners Enabled This property is required. bool - Whether group runners are enabled for the project.
- Http
Url To Repo This property is required. string - The HTTP clone URL of the project.
- Id
This property is required. int - The ID of the project.
- Import
Error This property is required. string - The import error, if it exists, for the project.
- Import
Status This property is required. string - The import status of the project.
- Import
Url This property is required. string - URL the project was imported from.
- Infrastructure
Access Level This property is required. string - Set the infrastructure access level. Valid values are
disabled
,private
,enabled
. - Issues
Access Level This property is required. string - Set the issues access level. Valid values are
disabled
,private
,enabled
. - Issues
Enabled This property is required. bool - Whether issues are enabled for the project.
- Jobs
Enabled This property is required. bool - Whether pipelines are enabled for the project.
- Keep
Latest Artifact This property is required. bool - Disable or enable the ability to keep the latest artifact for this project.
- Last
Activity At This property is required. string - Last activirty time for the project.
- Lfs
Enabled This property is required. bool - Whether LFS (large file storage) is enabled for the project.
- Merge
Commit Template This property is required. string - Template used to create merge commit message in merge requests.
- Merge
Method This property is required. string - Merge method for the project.
- Merge
Pipelines Enabled This property is required. bool - Enable or disable merge pipelines.
- Merge
Requests Access Level This property is required. string - Set the merge requests access level. Valid values are
disabled
,private
,enabled
. - Merge
Requests Enabled This property is required. bool - Whether merge requests are enabled for the project.
- Merge
Trains Enabled This property is required. bool - Enable or disable merge trains.
- Mirror
This property is required. bool - Whether the pull mirroring is enabled for the project.
- Mirror
Overwrites Diverged Branches This property is required. bool - Whether mirror_overwrites_diverged_branches is enabled for the project.
- Mirror
Trigger Builds This property is required. bool - Whether pull mirroring triggers builds for the project.
- Mirror
User Id This property is required. int - The mirror user ID for the project.
- Model
Experiments Access Level This property is required. string - The visibility of machine learning model experiments.
- Model
Registry Access Level This property is required. string - The visibility of machine learning model registry.
- Monitor
Access Level This property is required. string - Set the monitor access level. Valid values are
disabled
,private
,enabled
. - Name
This property is required. string - The name of the project.
- Name
With Namespace This property is required. string - In
group / subgroup / project
oruser / project
format. - Namespaces
This property is required. List<Pulumi.Git Lab. Inputs. Get Projects Project Namespace> - Namespace of the project (parent group/s).
- Only
Allow Merge If All Discussions Are Resolved This property is required. bool - Whether only_allow_merge_if_all_discussions_are_resolved is enabled for the project.
- Only
Allow Merge If Pipeline Succeeds This property is required. bool - Whether only_allow_merge_if_pipeline_succeeds is enabled for the project.
- Only
Mirror Protected Branches This property is required. bool - Whether only_mirror_protected_branches is enabled for the project.
- Open
Issues Count This property is required. int - The number of open issies for the project.
- Owners
This property is required. List<Pulumi.Git Lab. Inputs. Get Projects Project Owner> - Packages
Enabled This property is required. bool - Whether packages are enabled for the project.
- Path
This property is required. string - The path of the project.
- Path
With Namespace This property is required. string - In
group/subgroup/project
oruser/project
format. - Permissions
This property is required. List<Pulumi.Git Lab. Inputs. Get Projects Project Permission> - Permissions for the project.
- Prevent
Merge Without Jira Issue This property is required. bool - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- Public
Builds This property is required. bool - Whether public builds are enabled for the project.
- Readme
Url This property is required. string - The remote url of the project.
- Releases
Access Level This property is required. string - Set the releases access level. Valid values are
disabled
,private
,enabled
. - Repository
Access Level This property is required. string - Set the repository access level. Valid values are
disabled
,private
,enabled
. - Repository
Storage This property is required. string - Which storage shard the repository is on. (administrator only)
- Request
Access Enabled This property is required. bool - Whether requesting access is enabled for the project.
- Requirements
Access Level This property is required. string - Set the requirements access level. Valid values are
disabled
,private
,enabled
. - Resolve
Outdated Diff Discussions This property is required. bool - Whether resolve_outdated_diff_discussions is enabled for the project
- Restrict
User Defined Variables This property is required. bool - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- Runners
Token This property is required. string - The runners token for the project.
- Security
And Compliance Access Level This property is required. string - Set the security and compliance access level. Valid values are
disabled
,private
,enabled
. This property is required. bool- Whether shared runners are enabled for the project.
This property is required. List<Pulumi.Git Lab. Inputs. Get Projects Project Shared With Group> - Groups the the project is shared with.
- Snippets
Access Level This property is required. string - Set the snippets access level. Valid values are
disabled
,private
,enabled
. - Snippets
Enabled This property is required. bool - Whether snippets are enabled for the project.
- Squash
Commit Template This property is required. string - Template used to create squash commit message in merge requests.
- Ssh
Url To Repo This property is required. string - The SSH clone URL of the project.
- Star
Count This property is required. int - The number of stars on the project.
- Statistics
This property is required. Dictionary<string, int> - Statistics for the project.
- Suggestion
Commit Message This property is required. string - The commit message used to apply merge request suggestions.
- Tag
Lists This property is required. List<string> - A set of the project topics (formerly called "project tags").
- Topics
This property is required. List<string> - The list of topics for the project.
- Visibility
This property is required. string - The visibility of the project.
- Web
Url This property is required. string - The web url of the project.
- Wiki
Access Level This property is required. string - Set the wiki access level. Valid values are
disabled
,private
,enabled
. - Wiki
Enabled This property is required. bool - Whether wiki is enabled for the project.
- _
links This property is required. Dictionary<string, string> - Links for the project.
- Allow
Merge On Skipped Pipeline This property is required. bool - Whether allow_merge_on_skipped_pipeline is enabled for the project.
- Allow
Pipeline Trigger Approve Deployment This property is required. bool - Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only.
- Analytics
Access Level This property is required. string - Set the analytics access level. Valid values are
disabled
,private
,enabled
. - Approvals
Before Merge This property is required. int - The numbers of approvals needed in a merge requests.
- Archived
This property is required. bool - Whether the project is archived.
- Auto
Cancel Pending Pipelines This property is required. string - Auto-cancel pending pipelines. This isn’t a boolean, but enabled/disabled.
- Auto
Devops Deploy Strategy This property is required. string - Auto Deploy strategy. Valid values are
continuous
,manual
,timed_incremental
. - Auto
Devops Enabled This property is required. bool - Enable Auto DevOps for this project.
- Autoclose
Referenced Issues This property is required. bool - Set whether auto-closing referenced issues on default branch.
- Avatar
Url This property is required. string - The avatar url of the project.
- Build
Coverage Regex This property is required. string - Build coverage regex for the project.
- Build
Git Strategy This property is required. string - The Git strategy. Defaults to fetch.
- Build
Timeout This property is required. int - The maximum amount of time, in seconds, that a job can run.
- Builds
Access Level This property is required. string - Set the builds access level. Valid values are
disabled
,private
,enabled
. - Ci
Config Path This property is required. string - CI config file path for the project.
- Ci
Default Git Depth This property is required. int - Default number of revisions for shallow cloning.
- Ci
Forward Deployment Enabled This property is required. bool - When a new deployment job starts, skip older deployment jobs that are still pending.
- Ci
Pipeline Variables Minimum Override Role This property is required. string - 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 Pipeline Cancellation Role This property is required. string - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer
,maintainer
,no one
- Container
Expiration Policies This property is required. []GetProjects Project Container Expiration Policy - Set the image cleanup policy for this project. Note: this field is sometimes named
container_expiration_policy_attributes
in the GitLab Upstream API. - Container
Registry Access Level This property is required. string - Set visibility of container registry, for this project. Valid values are
disabled
,private
,enabled
. - Container
Registry Enabled This property is required. bool - Whether the container registry is enabled for the project.
- Created
At This property is required. string - Creation time for the project.
- Creator
Id This property is required. int - Creator ID for the project.
- Custom
Attributes This property is required. []map[string]string - Custom attributes for the project.
- Default
Branch This property is required. string - The default branch name of the project.
- Description
This property is required. string - The description of the project.
- Emails
Enabled This property is required. bool - Enable email notifications.
- Empty
Repo This property is required. bool - Whether the project is empty.
- Environments
Access Level This property is required. string - Set the environments access level. Valid values are
disabled
,private
,enabled
. This property is required. string- The classification label for the project.
- Feature
Flags Access Level This property is required. string - Set the feature flags access level. Valid values are
disabled
,private
,enabled
. - Forked
From Projects This property is required. []GetProjects Project Forked From Project - Present if the project is a fork. Contains information about the upstream project.
- Forking
Access Level This property is required. string - Set the forking access level. Valid values are
disabled
,private
,enabled
. - Forks
Count This property is required. int - The number of forks of the project.
- Group
Runners Enabled This property is required. bool - Whether group runners are enabled for the project.
- Http
Url To Repo This property is required. string - The HTTP clone URL of the project.
- Id
This property is required. int - The ID of the project.
- Import
Error This property is required. string - The import error, if it exists, for the project.
- Import
Status This property is required. string - The import status of the project.
- Import
Url This property is required. string - URL the project was imported from.
- Infrastructure
Access Level This property is required. string - Set the infrastructure access level. Valid values are
disabled
,private
,enabled
. - Issues
Access Level This property is required. string - Set the issues access level. Valid values are
disabled
,private
,enabled
. - Issues
Enabled This property is required. bool - Whether issues are enabled for the project.
- Jobs
Enabled This property is required. bool - Whether pipelines are enabled for the project.
- Keep
Latest Artifact This property is required. bool - Disable or enable the ability to keep the latest artifact for this project.
- Last
Activity At This property is required. string - Last activirty time for the project.
- Lfs
Enabled This property is required. bool - Whether LFS (large file storage) is enabled for the project.
- Merge
Commit Template This property is required. string - Template used to create merge commit message in merge requests.
- Merge
Method This property is required. string - Merge method for the project.
- Merge
Pipelines Enabled This property is required. bool - Enable or disable merge pipelines.
- Merge
Requests Access Level This property is required. string - Set the merge requests access level. Valid values are
disabled
,private
,enabled
. - Merge
Requests Enabled This property is required. bool - Whether merge requests are enabled for the project.
- Merge
Trains Enabled This property is required. bool - Enable or disable merge trains.
- Mirror
This property is required. bool - Whether the pull mirroring is enabled for the project.
- Mirror
Overwrites Diverged Branches This property is required. bool - Whether mirror_overwrites_diverged_branches is enabled for the project.
- Mirror
Trigger Builds This property is required. bool - Whether pull mirroring triggers builds for the project.
- Mirror
User Id This property is required. int - The mirror user ID for the project.
- Model
Experiments Access Level This property is required. string - The visibility of machine learning model experiments.
- Model
Registry Access Level This property is required. string - The visibility of machine learning model registry.
- Monitor
Access Level This property is required. string - Set the monitor access level. Valid values are
disabled
,private
,enabled
. - Name
This property is required. string - The name of the project.
- Name
With Namespace This property is required. string - In
group / subgroup / project
oruser / project
format. - Namespaces
This property is required. []GetProjects Project Namespace - Namespace of the project (parent group/s).
- Only
Allow Merge If All Discussions Are Resolved This property is required. bool - Whether only_allow_merge_if_all_discussions_are_resolved is enabled for the project.
- Only
Allow Merge If Pipeline Succeeds This property is required. bool - Whether only_allow_merge_if_pipeline_succeeds is enabled for the project.
- Only
Mirror Protected Branches This property is required. bool - Whether only_mirror_protected_branches is enabled for the project.
- Open
Issues Count This property is required. int - The number of open issies for the project.
- Owners
This property is required. []GetProjects Project Owner - Packages
Enabled This property is required. bool - Whether packages are enabled for the project.
- Path
This property is required. string - The path of the project.
- Path
With Namespace This property is required. string - In
group/subgroup/project
oruser/project
format. - Permissions
This property is required. []GetProjects Project Permission - Permissions for the project.
- Prevent
Merge Without Jira Issue This property is required. bool - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- Public
Builds This property is required. bool - Whether public builds are enabled for the project.
- Readme
Url This property is required. string - The remote url of the project.
- Releases
Access Level This property is required. string - Set the releases access level. Valid values are
disabled
,private
,enabled
. - Repository
Access Level This property is required. string - Set the repository access level. Valid values are
disabled
,private
,enabled
. - Repository
Storage This property is required. string - Which storage shard the repository is on. (administrator only)
- Request
Access Enabled This property is required. bool - Whether requesting access is enabled for the project.
- Requirements
Access Level This property is required. string - Set the requirements access level. Valid values are
disabled
,private
,enabled
. - Resolve
Outdated Diff Discussions This property is required. bool - Whether resolve_outdated_diff_discussions is enabled for the project
- Restrict
User Defined Variables This property is required. bool - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- Runners
Token This property is required. string - The runners token for the project.
- Security
And Compliance Access Level This property is required. string - Set the security and compliance access level. Valid values are
disabled
,private
,enabled
. This property is required. bool- Whether shared runners are enabled for the project.
This property is required. []GetProjects Project Shared With Group - Groups the the project is shared with.
- Snippets
Access Level This property is required. string - Set the snippets access level. Valid values are
disabled
,private
,enabled
. - Snippets
Enabled This property is required. bool - Whether snippets are enabled for the project.
- Squash
Commit Template This property is required. string - Template used to create squash commit message in merge requests.
- Ssh
Url To Repo This property is required. string - The SSH clone URL of the project.
- Star
Count This property is required. int - The number of stars on the project.
- Statistics
This property is required. map[string]int - Statistics for the project.
- Suggestion
Commit Message This property is required. string - The commit message used to apply merge request suggestions.
- Tag
Lists This property is required. []string - A set of the project topics (formerly called "project tags").
- Topics
This property is required. []string - The list of topics for the project.
- Visibility
This property is required. string - The visibility of the project.
- Web
Url This property is required. string - The web url of the project.
- Wiki
Access Level This property is required. string - Set the wiki access level. Valid values are
disabled
,private
,enabled
. - Wiki
Enabled This property is required. bool - Whether wiki is enabled for the project.
- _
links This property is required. map[string]string - Links for the project.
- _
links This property is required. Map<String,String> - Links for the project.
- allow
Merge On Skipped Pipeline This property is required. Boolean - Whether allow_merge_on_skipped_pipeline is enabled for the project.
- allow
Pipeline Trigger Approve Deployment This property is required. Boolean - Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only.
- analytics
Access Level This property is required. String - Set the analytics access level. Valid values are
disabled
,private
,enabled
. - approvals
Before Merge This property is required. Integer - The numbers of approvals needed in a merge requests.
- archived
This property is required. Boolean - Whether the project is archived.
- auto
Cancel Pending Pipelines This property is required. String - Auto-cancel pending pipelines. This isn’t a boolean, but enabled/disabled.
- auto
Devops Deploy Strategy This property is required. String - Auto Deploy strategy. Valid values are
continuous
,manual
,timed_incremental
. - auto
Devops Enabled This property is required. Boolean - Enable Auto DevOps for this project.
- autoclose
Referenced Issues This property is required. Boolean - Set whether auto-closing referenced issues on default branch.
- avatar
Url This property is required. String - The avatar url of the project.
- build
Coverage Regex This property is required. String - Build coverage regex for the project.
- build
Git Strategy This property is required. String - The Git strategy. Defaults to fetch.
- build
Timeout This property is required. Integer - The maximum amount of time, in seconds, that a job can run.
- builds
Access Level This property is required. String - Set the builds access level. Valid values are
disabled
,private
,enabled
. - ci
Config Path This property is required. String - CI config file path for the project.
- ci
Default Git Depth This property is required. Integer - Default number of revisions for shallow cloning.
- ci
Forward Deployment Enabled This property is required. Boolean - When a new deployment job starts, skip older deployment jobs that are still pending.
- ci
Pipeline Variables Minimum Override Role This property is required. String - 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 Pipeline Cancellation Role This property is required. String - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer
,maintainer
,no one
- container
Expiration Policies This property is required. List<GetProjects Project Container Expiration Policy> - Set the image cleanup policy for this project. Note: this field is sometimes named
container_expiration_policy_attributes
in the GitLab Upstream API. - container
Registry Access Level This property is required. String - Set visibility of container registry, for this project. Valid values are
disabled
,private
,enabled
. - container
Registry Enabled This property is required. Boolean - Whether the container registry is enabled for the project.
- created
At This property is required. String - Creation time for the project.
- creator
Id This property is required. Integer - Creator ID for the project.
- custom
Attributes This property is required. List<Map<String,String>> - Custom attributes for the project.
- default
Branch This property is required. String - The default branch name of the project.
- description
This property is required. String - The description of the project.
- emails
Enabled This property is required. Boolean - Enable email notifications.
- empty
Repo This property is required. Boolean - Whether the project is empty.
- environments
Access Level This property is required. String - Set the environments access level. Valid values are
disabled
,private
,enabled
. This property is required. String- The classification label for the project.
- feature
Flags Access Level This property is required. String - Set the feature flags access level. Valid values are
disabled
,private
,enabled
. - forked
From Projects This property is required. List<GetProjects Project Forked From Project> - Present if the project is a fork. Contains information about the upstream project.
- forking
Access Level This property is required. String - Set the forking access level. Valid values are
disabled
,private
,enabled
. - forks
Count This property is required. Integer - The number of forks of the project.
- group
Runners Enabled This property is required. Boolean - Whether group runners are enabled for the project.
- http
Url To Repo This property is required. String - The HTTP clone URL of the project.
- id
This property is required. Integer - The ID of the project.
- import
Error This property is required. String - The import error, if it exists, for the project.
- import
Status This property is required. String - The import status of the project.
- import
Url This property is required. String - URL the project was imported from.
- infrastructure
Access Level This property is required. String - Set the infrastructure access level. Valid values are
disabled
,private
,enabled
. - issues
Access Level This property is required. String - Set the issues access level. Valid values are
disabled
,private
,enabled
. - issues
Enabled This property is required. Boolean - Whether issues are enabled for the project.
- jobs
Enabled This property is required. Boolean - Whether pipelines are enabled for the project.
- keep
Latest Artifact This property is required. Boolean - Disable or enable the ability to keep the latest artifact for this project.
- last
Activity At This property is required. String - Last activirty time for the project.
- lfs
Enabled This property is required. Boolean - Whether LFS (large file storage) is enabled for the project.
- merge
Commit Template This property is required. String - Template used to create merge commit message in merge requests.
- merge
Method This property is required. String - Merge method for the project.
- merge
Pipelines Enabled This property is required. Boolean - Enable or disable merge pipelines.
- merge
Requests Access Level This property is required. String - Set the merge requests access level. Valid values are
disabled
,private
,enabled
. - merge
Requests Enabled This property is required. Boolean - Whether merge requests are enabled for the project.
- merge
Trains Enabled This property is required. Boolean - Enable or disable merge trains.
- mirror
This property is required. Boolean - Whether the pull mirroring is enabled for the project.
- mirror
Overwrites Diverged Branches This property is required. Boolean - Whether mirror_overwrites_diverged_branches is enabled for the project.
- mirror
Trigger Builds This property is required. Boolean - Whether pull mirroring triggers builds for the project.
- mirror
User Id This property is required. Integer - The mirror user ID for the project.
- model
Experiments Access Level This property is required. String - The visibility of machine learning model experiments.
- model
Registry Access Level This property is required. String - The visibility of machine learning model registry.
- monitor
Access Level This property is required. String - Set the monitor access level. Valid values are
disabled
,private
,enabled
. - name
This property is required. String - The name of the project.
- name
With Namespace This property is required. String - In
group / subgroup / project
oruser / project
format. - namespaces
This property is required. List<GetProjects Project Namespace> - Namespace of the project (parent group/s).
- only
Allow Merge If All Discussions Are Resolved This property is required. Boolean - Whether only_allow_merge_if_all_discussions_are_resolved is enabled for the project.
- only
Allow Merge If Pipeline Succeeds This property is required. Boolean - Whether only_allow_merge_if_pipeline_succeeds is enabled for the project.
- only
Mirror Protected Branches This property is required. Boolean - Whether only_mirror_protected_branches is enabled for the project.
- open
Issues Count This property is required. Integer - The number of open issies for the project.
- owners
This property is required. List<GetProjects Project Owner> - packages
Enabled This property is required. Boolean - Whether packages are enabled for the project.
- path
This property is required. String - The path of the project.
- path
With Namespace This property is required. String - In
group/subgroup/project
oruser/project
format. - permissions
This property is required. List<GetProjects Project Permission> - Permissions for the project.
- prevent
Merge Without Jira Issue This property is required. Boolean - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- public
Builds This property is required. Boolean - Whether public builds are enabled for the project.
- readme
Url This property is required. String - The remote url of the project.
- releases
Access Level This property is required. String - Set the releases access level. Valid values are
disabled
,private
,enabled
. - repository
Access Level This property is required. String - Set the repository access level. Valid values are
disabled
,private
,enabled
. - repository
Storage This property is required. String - Which storage shard the repository is on. (administrator only)
- request
Access Enabled This property is required. Boolean - Whether requesting access is enabled for the project.
- requirements
Access Level This property is required. String - Set the requirements access level. Valid values are
disabled
,private
,enabled
. - resolve
Outdated Diff Discussions This property is required. Boolean - Whether resolve_outdated_diff_discussions is enabled for the project
- restrict
User Defined Variables This property is required. Boolean - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- runners
Token This property is required. String - The runners token for the project.
- security
And Compliance Access Level This property is required. String - Set the security and compliance access level. Valid values are
disabled
,private
,enabled
. This property is required. Boolean- Whether shared runners are enabled for the project.
This property is required. List<GetProjects Project Shared With Group> - Groups the the project is shared with.
- snippets
Access Level This property is required. String - Set the snippets access level. Valid values are
disabled
,private
,enabled
. - snippets
Enabled This property is required. Boolean - Whether snippets are enabled for the project.
- squash
Commit Template This property is required. String - Template used to create squash commit message in merge requests.
- ssh
Url To Repo This property is required. String - The SSH clone URL of the project.
- star
Count This property is required. Integer - The number of stars on the project.
- statistics
This property is required. Map<String,Integer> - Statistics for the project.
- suggestion
Commit Message This property is required. String - The commit message used to apply merge request suggestions.
- tag
Lists This property is required. List<String> - A set of the project topics (formerly called "project tags").
- topics
This property is required. List<String> - The list of topics for the project.
- visibility
This property is required. String - The visibility of the project.
- web
Url This property is required. String - The web url of the project.
- wiki
Access Level This property is required. String - Set the wiki access level. Valid values are
disabled
,private
,enabled
. - wiki
Enabled This property is required. Boolean - Whether wiki is enabled for the project.
- _
links This property is required. {[key: string]: string} - Links for the project.
- allow
Merge On Skipped Pipeline This property is required. boolean - Whether allow_merge_on_skipped_pipeline is enabled for the project.
- allow
Pipeline Trigger Approve Deployment This property is required. boolean - Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only.
- analytics
Access Level This property is required. string - Set the analytics access level. Valid values are
disabled
,private
,enabled
. - approvals
Before Merge This property is required. number - The numbers of approvals needed in a merge requests.
- archived
This property is required. boolean - Whether the project is archived.
- auto
Cancel Pending Pipelines This property is required. string - Auto-cancel pending pipelines. This isn’t a boolean, but enabled/disabled.
- auto
Devops Deploy Strategy This property is required. string - Auto Deploy strategy. Valid values are
continuous
,manual
,timed_incremental
. - auto
Devops Enabled This property is required. boolean - Enable Auto DevOps for this project.
- autoclose
Referenced Issues This property is required. boolean - Set whether auto-closing referenced issues on default branch.
- avatar
Url This property is required. string - The avatar url of the project.
- build
Coverage Regex This property is required. string - Build coverage regex for the project.
- build
Git Strategy This property is required. string - The Git strategy. Defaults to fetch.
- build
Timeout This property is required. number - The maximum amount of time, in seconds, that a job can run.
- builds
Access Level This property is required. string - Set the builds access level. Valid values are
disabled
,private
,enabled
. - ci
Config Path This property is required. string - CI config file path for the project.
- ci
Default Git Depth This property is required. number - Default number of revisions for shallow cloning.
- ci
Forward Deployment Enabled This property is required. boolean - When a new deployment job starts, skip older deployment jobs that are still pending.
- ci
Pipeline Variables Minimum Override Role This property is required. string - 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 Pipeline Cancellation Role This property is required. string - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer
,maintainer
,no one
- container
Expiration Policies This property is required. GetProjects Project Container Expiration Policy[] - Set the image cleanup policy for this project. Note: this field is sometimes named
container_expiration_policy_attributes
in the GitLab Upstream API. - container
Registry Access Level This property is required. string - Set visibility of container registry, for this project. Valid values are
disabled
,private
,enabled
. - container
Registry Enabled This property is required. boolean - Whether the container registry is enabled for the project.
- created
At This property is required. string - Creation time for the project.
- creator
Id This property is required. number - Creator ID for the project.
- custom
Attributes This property is required. {[key: string]: string}[] - Custom attributes for the project.
- default
Branch This property is required. string - The default branch name of the project.
- description
This property is required. string - The description of the project.
- emails
Enabled This property is required. boolean - Enable email notifications.
- empty
Repo This property is required. boolean - Whether the project is empty.
- environments
Access Level This property is required. string - Set the environments access level. Valid values are
disabled
,private
,enabled
. This property is required. string- The classification label for the project.
- feature
Flags Access Level This property is required. string - Set the feature flags access level. Valid values are
disabled
,private
,enabled
. - forked
From Projects This property is required. GetProjects Project Forked From Project[] - Present if the project is a fork. Contains information about the upstream project.
- forking
Access Level This property is required. string - Set the forking access level. Valid values are
disabled
,private
,enabled
. - forks
Count This property is required. number - The number of forks of the project.
- group
Runners Enabled This property is required. boolean - Whether group runners are enabled for the project.
- http
Url To Repo This property is required. string - The HTTP clone URL of the project.
- id
This property is required. number - The ID of the project.
- import
Error This property is required. string - The import error, if it exists, for the project.
- import
Status This property is required. string - The import status of the project.
- import
Url This property is required. string - URL the project was imported from.
- infrastructure
Access Level This property is required. string - Set the infrastructure access level. Valid values are
disabled
,private
,enabled
. - issues
Access Level This property is required. string - Set the issues access level. Valid values are
disabled
,private
,enabled
. - issues
Enabled This property is required. boolean - Whether issues are enabled for the project.
- jobs
Enabled This property is required. boolean - Whether pipelines are enabled for the project.
- keep
Latest Artifact This property is required. boolean - Disable or enable the ability to keep the latest artifact for this project.
- last
Activity At This property is required. string - Last activirty time for the project.
- lfs
Enabled This property is required. boolean - Whether LFS (large file storage) is enabled for the project.
- merge
Commit Template This property is required. string - Template used to create merge commit message in merge requests.
- merge
Method This property is required. string - Merge method for the project.
- merge
Pipelines Enabled This property is required. boolean - Enable or disable merge pipelines.
- merge
Requests Access Level This property is required. string - Set the merge requests access level. Valid values are
disabled
,private
,enabled
. - merge
Requests Enabled This property is required. boolean - Whether merge requests are enabled for the project.
- merge
Trains Enabled This property is required. boolean - Enable or disable merge trains.
- mirror
This property is required. boolean - Whether the pull mirroring is enabled for the project.
- mirror
Overwrites Diverged Branches This property is required. boolean - Whether mirror_overwrites_diverged_branches is enabled for the project.
- mirror
Trigger Builds This property is required. boolean - Whether pull mirroring triggers builds for the project.
- mirror
User Id This property is required. number - The mirror user ID for the project.
- model
Experiments Access Level This property is required. string - The visibility of machine learning model experiments.
- model
Registry Access Level This property is required. string - The visibility of machine learning model registry.
- monitor
Access Level This property is required. string - Set the monitor access level. Valid values are
disabled
,private
,enabled
. - name
This property is required. string - The name of the project.
- name
With Namespace This property is required. string - In
group / subgroup / project
oruser / project
format. - namespaces
This property is required. GetProjects Project Namespace[] - Namespace of the project (parent group/s).
- only
Allow Merge If All Discussions Are Resolved This property is required. boolean - Whether only_allow_merge_if_all_discussions_are_resolved is enabled for the project.
- only
Allow Merge If Pipeline Succeeds This property is required. boolean - Whether only_allow_merge_if_pipeline_succeeds is enabled for the project.
- only
Mirror Protected Branches This property is required. boolean - Whether only_mirror_protected_branches is enabled for the project.
- open
Issues Count This property is required. number - The number of open issies for the project.
- owners
This property is required. GetProjects Project Owner[] - packages
Enabled This property is required. boolean - Whether packages are enabled for the project.
- path
This property is required. string - The path of the project.
- path
With Namespace This property is required. string - In
group/subgroup/project
oruser/project
format. - permissions
This property is required. GetProjects Project Permission[] - Permissions for the project.
- prevent
Merge Without Jira Issue This property is required. boolean - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- public
Builds This property is required. boolean - Whether public builds are enabled for the project.
- readme
Url This property is required. string - The remote url of the project.
- releases
Access Level This property is required. string - Set the releases access level. Valid values are
disabled
,private
,enabled
. - repository
Access Level This property is required. string - Set the repository access level. Valid values are
disabled
,private
,enabled
. - repository
Storage This property is required. string - Which storage shard the repository is on. (administrator only)
- request
Access Enabled This property is required. boolean - Whether requesting access is enabled for the project.
- requirements
Access Level This property is required. string - Set the requirements access level. Valid values are
disabled
,private
,enabled
. - resolve
Outdated Diff Discussions This property is required. boolean - Whether resolve_outdated_diff_discussions is enabled for the project
- restrict
User Defined Variables This property is required. boolean - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- runners
Token This property is required. string - The runners token for the project.
- security
And Compliance Access Level This property is required. string - Set the security and compliance access level. Valid values are
disabled
,private
,enabled
. This property is required. boolean- Whether shared runners are enabled for the project.
This property is required. GetProjects Project Shared With Group[] - Groups the the project is shared with.
- snippets
Access Level This property is required. string - Set the snippets access level. Valid values are
disabled
,private
,enabled
. - snippets
Enabled This property is required. boolean - Whether snippets are enabled for the project.
- squash
Commit Template This property is required. string - Template used to create squash commit message in merge requests.
- ssh
Url To Repo This property is required. string - The SSH clone URL of the project.
- star
Count This property is required. number - The number of stars on the project.
- statistics
This property is required. {[key: string]: number} - Statistics for the project.
- suggestion
Commit Message This property is required. string - The commit message used to apply merge request suggestions.
- tag
Lists This property is required. string[] - A set of the project topics (formerly called "project tags").
- topics
This property is required. string[] - The list of topics for the project.
- visibility
This property is required. string - The visibility of the project.
- web
Url This property is required. string - The web url of the project.
- wiki
Access Level This property is required. string - Set the wiki access level. Valid values are
disabled
,private
,enabled
. - wiki
Enabled This property is required. boolean - Whether wiki is enabled for the project.
- _
links This property is required. Mapping[str, str] - Links for the project.
- allow_
merge_ on_ skipped_ pipeline This property is required. bool - Whether allow_merge_on_skipped_pipeline is enabled for the project.
- allow_
pipeline_ trigger_ approve_ deployment This property is required. bool - Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only.
- analytics_
access_ level This property is required. str - Set the analytics access level. Valid values are
disabled
,private
,enabled
. - approvals_
before_ merge This property is required. int - The numbers of approvals needed in a merge requests.
- archived
This property is required. bool - Whether the project is archived.
- auto_
cancel_ pending_ pipelines This property is required. str - Auto-cancel pending pipelines. This isn’t a boolean, but enabled/disabled.
- auto_
devops_ deploy_ strategy This property is required. str - Auto Deploy strategy. Valid values are
continuous
,manual
,timed_incremental
. - auto_
devops_ enabled This property is required. bool - Enable Auto DevOps for this project.
- autoclose_
referenced_ issues This property is required. bool - Set whether auto-closing referenced issues on default branch.
- avatar_
url This property is required. str - The avatar url of the project.
- build_
coverage_ regex This property is required. str - Build coverage regex for the project.
- build_
git_ strategy This property is required. str - The Git strategy. Defaults to fetch.
- build_
timeout This property is required. int - The maximum amount of time, in seconds, that a job can run.
- builds_
access_ level This property is required. str - Set the builds access level. Valid values are
disabled
,private
,enabled
. - ci_
config_ path This property is required. str - CI config file path for the project.
- ci_
default_ git_ depth This property is required. int - Default number of revisions for shallow cloning.
- ci_
forward_ deployment_ enabled This property is required. bool - When a new deployment job starts, skip older deployment jobs that are still pending.
- ci_
pipeline_ variables_ minimum_ override_ role This property is required. str - 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_ pipeline_ cancellation_ role This property is required. str - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer
,maintainer
,no one
- container_
expiration_ policies This property is required. Sequence[GetProjects Project Container Expiration Policy] - Set the image cleanup policy for this project. Note: this field is sometimes named
container_expiration_policy_attributes
in the GitLab Upstream API. - container_
registry_ access_ level This property is required. str - Set visibility of container registry, for this project. Valid values are
disabled
,private
,enabled
. - container_
registry_ enabled This property is required. bool - Whether the container registry is enabled for the project.
- created_
at This property is required. str - Creation time for the project.
- creator_
id This property is required. int - Creator ID for the project.
- custom_
attributes This property is required. Sequence[Mapping[str, str]] - Custom attributes for the project.
- default_
branch This property is required. str - The default branch name of the project.
- description
This property is required. str - The description of the project.
- emails_
enabled This property is required. bool - Enable email notifications.
- empty_
repo This property is required. bool - Whether the project is empty.
- environments_
access_ level This property is required. str - Set the environments access level. Valid values are
disabled
,private
,enabled
. This property is required. str- The classification label for the project.
- feature_
flags_ access_ level This property is required. str - Set the feature flags access level. Valid values are
disabled
,private
,enabled
. - forked_
from_ projects This property is required. Sequence[GetProjects Project Forked From Project] - Present if the project is a fork. Contains information about the upstream project.
- forking_
access_ level This property is required. str - Set the forking access level. Valid values are
disabled
,private
,enabled
. - forks_
count This property is required. int - The number of forks of the project.
- group_
runners_ enabled This property is required. bool - Whether group runners are enabled for the project.
- http_
url_ to_ repo This property is required. str - The HTTP clone URL of the project.
- id
This property is required. int - The ID of the project.
- import_
error This property is required. str - The import error, if it exists, for the project.
- import_
status This property is required. str - The import status of the project.
- import_
url This property is required. str - URL the project was imported from.
- infrastructure_
access_ level This property is required. str - Set the infrastructure access level. Valid values are
disabled
,private
,enabled
. - issues_
access_ level This property is required. str - Set the issues access level. Valid values are
disabled
,private
,enabled
. - issues_
enabled This property is required. bool - Whether issues are enabled for the project.
- jobs_
enabled This property is required. bool - Whether pipelines are enabled for the project.
- keep_
latest_ artifact This property is required. bool - Disable or enable the ability to keep the latest artifact for this project.
- last_
activity_ at This property is required. str - Last activirty time for the project.
- lfs_
enabled This property is required. bool - Whether LFS (large file storage) is enabled for the project.
- merge_
commit_ template This property is required. str - Template used to create merge commit message in merge requests.
- merge_
method This property is required. str - Merge method for the project.
- merge_
pipelines_ enabled This property is required. bool - Enable or disable merge pipelines.
- merge_
requests_ access_ level This property is required. str - Set the merge requests access level. Valid values are
disabled
,private
,enabled
. - merge_
requests_ enabled This property is required. bool - Whether merge requests are enabled for the project.
- merge_
trains_ enabled This property is required. bool - Enable or disable merge trains.
- mirror
This property is required. bool - Whether the pull mirroring is enabled for the project.
- mirror_
overwrites_ diverged_ branches This property is required. bool - Whether mirror_overwrites_diverged_branches is enabled for the project.
- mirror_
trigger_ builds This property is required. bool - Whether pull mirroring triggers builds for the project.
- mirror_
user_ id This property is required. int - The mirror user ID for the project.
- model_
experiments_ access_ level This property is required. str - The visibility of machine learning model experiments.
- model_
registry_ access_ level This property is required. str - The visibility of machine learning model registry.
- monitor_
access_ level This property is required. str - Set the monitor access level. Valid values are
disabled
,private
,enabled
. - name
This property is required. str - The name of the project.
- name_
with_ namespace This property is required. str - In
group / subgroup / project
oruser / project
format. - namespaces
This property is required. Sequence[GetProjects Project Namespace] - Namespace of the project (parent group/s).
- only_
allow_ merge_ if_ all_ discussions_ are_ resolved This property is required. bool - Whether only_allow_merge_if_all_discussions_are_resolved is enabled for the project.
- only_
allow_ merge_ if_ pipeline_ succeeds This property is required. bool - Whether only_allow_merge_if_pipeline_succeeds is enabled for the project.
- only_
mirror_ protected_ branches This property is required. bool - Whether only_mirror_protected_branches is enabled for the project.
- open_
issues_ count This property is required. int - The number of open issies for the project.
- owners
This property is required. Sequence[GetProjects Project Owner] - packages_
enabled This property is required. bool - Whether packages are enabled for the project.
- path
This property is required. str - The path of the project.
- path_
with_ namespace This property is required. str - In
group/subgroup/project
oruser/project
format. - permissions
This property is required. Sequence[GetProjects Project Permission] - Permissions for the project.
- prevent_
merge_ without_ jira_ issue This property is required. bool - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- public_
builds This property is required. bool - Whether public builds are enabled for the project.
- readme_
url This property is required. str - The remote url of the project.
- releases_
access_ level This property is required. str - Set the releases access level. Valid values are
disabled
,private
,enabled
. - repository_
access_ level This property is required. str - Set the repository access level. Valid values are
disabled
,private
,enabled
. - repository_
storage This property is required. str - Which storage shard the repository is on. (administrator only)
- request_
access_ enabled This property is required. bool - Whether requesting access is enabled for the project.
- requirements_
access_ level This property is required. str - Set the requirements access level. Valid values are
disabled
,private
,enabled
. - resolve_
outdated_ diff_ discussions This property is required. bool - Whether resolve_outdated_diff_discussions is enabled for the project
- restrict_
user_ defined_ variables This property is required. bool - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- runners_
token This property is required. str - The runners token for the project.
- security_
and_ compliance_ access_ level This property is required. str - Set the security and compliance access level. Valid values are
disabled
,private
,enabled
. This property is required. bool- Whether shared runners are enabled for the project.
This property is required. Sequence[GetProjects Project Shared With Group] - Groups the the project is shared with.
- snippets_
access_ level This property is required. str - Set the snippets access level. Valid values are
disabled
,private
,enabled
. - snippets_
enabled This property is required. bool - Whether snippets are enabled for the project.
- squash_
commit_ template This property is required. str - Template used to create squash commit message in merge requests.
- ssh_
url_ to_ repo This property is required. str - The SSH clone URL of the project.
- star_
count This property is required. int - The number of stars on the project.
- statistics
This property is required. Mapping[str, int] - Statistics for the project.
- suggestion_
commit_ message This property is required. str - The commit message used to apply merge request suggestions.
- tag_
lists This property is required. Sequence[str] - A set of the project topics (formerly called "project tags").
- topics
This property is required. Sequence[str] - The list of topics for the project.
- visibility
This property is required. str - The visibility of the project.
- web_
url This property is required. str - The web url of the project.
- wiki_
access_ level This property is required. str - Set the wiki access level. Valid values are
disabled
,private
,enabled
. - wiki_
enabled This property is required. bool - Whether wiki is enabled for the project.
- _
links This property is required. Map<String> - Links for the project.
- allow
Merge On Skipped Pipeline This property is required. Boolean - Whether allow_merge_on_skipped_pipeline is enabled for the project.
- allow
Pipeline Trigger Approve Deployment This property is required. Boolean - Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only.
- analytics
Access Level This property is required. String - Set the analytics access level. Valid values are
disabled
,private
,enabled
. - approvals
Before Merge This property is required. Number - The numbers of approvals needed in a merge requests.
- archived
This property is required. Boolean - Whether the project is archived.
- auto
Cancel Pending Pipelines This property is required. String - Auto-cancel pending pipelines. This isn’t a boolean, but enabled/disabled.
- auto
Devops Deploy Strategy This property is required. String - Auto Deploy strategy. Valid values are
continuous
,manual
,timed_incremental
. - auto
Devops Enabled This property is required. Boolean - Enable Auto DevOps for this project.
- autoclose
Referenced Issues This property is required. Boolean - Set whether auto-closing referenced issues on default branch.
- avatar
Url This property is required. String - The avatar url of the project.
- build
Coverage Regex This property is required. String - Build coverage regex for the project.
- build
Git Strategy This property is required. String - The Git strategy. Defaults to fetch.
- build
Timeout This property is required. Number - The maximum amount of time, in seconds, that a job can run.
- builds
Access Level This property is required. String - Set the builds access level. Valid values are
disabled
,private
,enabled
. - ci
Config Path This property is required. String - CI config file path for the project.
- ci
Default Git Depth This property is required. Number - Default number of revisions for shallow cloning.
- ci
Forward Deployment Enabled This property is required. Boolean - When a new deployment job starts, skip older deployment jobs that are still pending.
- ci
Pipeline Variables Minimum Override Role This property is required. String - 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 Pipeline Cancellation Role This property is required. String - The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are
developer
,maintainer
,no one
- container
Expiration Policies This property is required. List<Property Map> - Set the image cleanup policy for this project. Note: this field is sometimes named
container_expiration_policy_attributes
in the GitLab Upstream API. - container
Registry Access Level This property is required. String - Set visibility of container registry, for this project. Valid values are
disabled
,private
,enabled
. - container
Registry Enabled This property is required. Boolean - Whether the container registry is enabled for the project.
- created
At This property is required. String - Creation time for the project.
- creator
Id This property is required. Number - Creator ID for the project.
- custom
Attributes This property is required. List<Map<String>> - Custom attributes for the project.
- default
Branch This property is required. String - The default branch name of the project.
- description
This property is required. String - The description of the project.
- emails
Enabled This property is required. Boolean - Enable email notifications.
- empty
Repo This property is required. Boolean - Whether the project is empty.
- environments
Access Level This property is required. String - Set the environments access level. Valid values are
disabled
,private
,enabled
. This property is required. String- The classification label for the project.
- feature
Flags Access Level This property is required. String - Set the feature flags access level. Valid values are
disabled
,private
,enabled
. - forked
From Projects This property is required. List<Property Map> - Present if the project is a fork. Contains information about the upstream project.
- forking
Access Level This property is required. String - Set the forking access level. Valid values are
disabled
,private
,enabled
. - forks
Count This property is required. Number - The number of forks of the project.
- group
Runners Enabled This property is required. Boolean - Whether group runners are enabled for the project.
- http
Url To Repo This property is required. String - The HTTP clone URL of the project.
- id
This property is required. Number - The ID of the project.
- import
Error This property is required. String - The import error, if it exists, for the project.
- import
Status This property is required. String - The import status of the project.
- import
Url This property is required. String - URL the project was imported from.
- infrastructure
Access Level This property is required. String - Set the infrastructure access level. Valid values are
disabled
,private
,enabled
. - issues
Access Level This property is required. String - Set the issues access level. Valid values are
disabled
,private
,enabled
. - issues
Enabled This property is required. Boolean - Whether issues are enabled for the project.
- jobs
Enabled This property is required. Boolean - Whether pipelines are enabled for the project.
- keep
Latest Artifact This property is required. Boolean - Disable or enable the ability to keep the latest artifact for this project.
- last
Activity At This property is required. String - Last activirty time for the project.
- lfs
Enabled This property is required. Boolean - Whether LFS (large file storage) is enabled for the project.
- merge
Commit Template This property is required. String - Template used to create merge commit message in merge requests.
- merge
Method This property is required. String - Merge method for the project.
- merge
Pipelines Enabled This property is required. Boolean - Enable or disable merge pipelines.
- merge
Requests Access Level This property is required. String - Set the merge requests access level. Valid values are
disabled
,private
,enabled
. - merge
Requests Enabled This property is required. Boolean - Whether merge requests are enabled for the project.
- merge
Trains Enabled This property is required. Boolean - Enable or disable merge trains.
- mirror
This property is required. Boolean - Whether the pull mirroring is enabled for the project.
- mirror
Overwrites Diverged Branches This property is required. Boolean - Whether mirror_overwrites_diverged_branches is enabled for the project.
- mirror
Trigger Builds This property is required. Boolean - Whether pull mirroring triggers builds for the project.
- mirror
User Id This property is required. Number - The mirror user ID for the project.
- model
Experiments Access Level This property is required. String - The visibility of machine learning model experiments.
- model
Registry Access Level This property is required. String - The visibility of machine learning model registry.
- monitor
Access Level This property is required. String - Set the monitor access level. Valid values are
disabled
,private
,enabled
. - name
This property is required. String - The name of the project.
- name
With Namespace This property is required. String - In
group / subgroup / project
oruser / project
format. - namespaces
This property is required. List<Property Map> - Namespace of the project (parent group/s).
- only
Allow Merge If All Discussions Are Resolved This property is required. Boolean - Whether only_allow_merge_if_all_discussions_are_resolved is enabled for the project.
- only
Allow Merge If Pipeline Succeeds This property is required. Boolean - Whether only_allow_merge_if_pipeline_succeeds is enabled for the project.
- only
Mirror Protected Branches This property is required. Boolean - Whether only_mirror_protected_branches is enabled for the project.
- open
Issues Count This property is required. Number - The number of open issies for the project.
- owners
This property is required. List<Property Map> - packages
Enabled This property is required. Boolean - Whether packages are enabled for the project.
- path
This property is required. String - The path of the project.
- path
With Namespace This property is required. String - In
group/subgroup/project
oruser/project
format. - permissions
This property is required. List<Property Map> - Permissions for the project.
- prevent
Merge Without Jira Issue This property is required. Boolean - Whether merge requests require an associated issue from Jira. Premium and Ultimate only.
- public
Builds This property is required. Boolean - Whether public builds are enabled for the project.
- readme
Url This property is required. String - The remote url of the project.
- releases
Access Level This property is required. String - Set the releases access level. Valid values are
disabled
,private
,enabled
. - repository
Access Level This property is required. String - Set the repository access level. Valid values are
disabled
,private
,enabled
. - repository
Storage This property is required. String - Which storage shard the repository is on. (administrator only)
- request
Access Enabled This property is required. Boolean - Whether requesting access is enabled for the project.
- requirements
Access Level This property is required. String - Set the requirements access level. Valid values are
disabled
,private
,enabled
. - resolve
Outdated Diff Discussions This property is required. Boolean - Whether resolve_outdated_diff_discussions is enabled for the project
- restrict
User Defined Variables This property is required. Boolean - Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
- runners
Token This property is required. String - The runners token for the project.
- security
And Compliance Access Level This property is required. String - Set the security and compliance access level. Valid values are
disabled
,private
,enabled
. This property is required. Boolean- Whether shared runners are enabled for the project.
This property is required. List<Property Map>- Groups the the project is shared with.
- snippets
Access Level This property is required. String - Set the snippets access level. Valid values are
disabled
,private
,enabled
. - snippets
Enabled This property is required. Boolean - Whether snippets are enabled for the project.
- squash
Commit Template This property is required. String - Template used to create squash commit message in merge requests.
- ssh
Url To Repo This property is required. String - The SSH clone URL of the project.
- star
Count This property is required. Number - The number of stars on the project.
- statistics
This property is required. Map<Number> - Statistics for the project.
- suggestion
Commit Message This property is required. String - The commit message used to apply merge request suggestions.
- tag
Lists This property is required. List<String> - A set of the project topics (formerly called "project tags").
- topics
This property is required. List<String> - The list of topics for the project.
- visibility
This property is required. String - The visibility of the project.
- web
Url This property is required. String - The web url of the project.
- wiki
Access Level This property is required. String - Set the wiki access level. Valid values are
disabled
,private
,enabled
. - wiki
Enabled This property is required. Boolean - Whether wiki is enabled for the project.
GetProjectsProjectContainerExpirationPolicy
- Cadence
This property is required. string - The cadence of the policy. Valid values are:
1d
,7d
,14d
,1month
,3month
. - Enabled
This property is required. bool - If true, the policy is enabled.
- Keep
N This property is required. int - The number of images to keep.
- Name
Regex This property is required. string - The regular expression to match image names to delete.
- Name
Regex Delete This property is required. string - The regular expression to match image names to delete.
- Name
Regex Keep This property is required. string - The regular expression to match image names to keep.
- Next
Run At This property is required. string - The next time the policy will run.
- Older
Than This property is required. string - The number of days to keep images.
- Cadence
This property is required. string - The cadence of the policy. Valid values are:
1d
,7d
,14d
,1month
,3month
. - Enabled
This property is required. bool - If true, the policy is enabled.
- Keep
N This property is required. int - The number of images to keep.
- Name
Regex This property is required. string - The regular expression to match image names to delete.
- Name
Regex Delete This property is required. string - The regular expression to match image names to delete.
- Name
Regex Keep This property is required. string - The regular expression to match image names to keep.
- Next
Run At This property is required. string - The next time the policy will run.
- Older
Than This property is required. string - The number of days to keep images.
- cadence
This property is required. String - The cadence of the policy. Valid values are:
1d
,7d
,14d
,1month
,3month
. - enabled
This property is required. Boolean - If true, the policy is enabled.
- keep
N This property is required. Integer - The number of images to keep.
- name
Regex This property is required. String - The regular expression to match image names to delete.
- name
Regex Delete This property is required. String - The regular expression to match image names to delete.
- name
Regex Keep This property is required. String - The regular expression to match image names to keep.
- next
Run At This property is required. String - The next time the policy will run.
- older
Than This property is required. String - The number of days to keep images.
- cadence
This property is required. string - The cadence of the policy. Valid values are:
1d
,7d
,14d
,1month
,3month
. - enabled
This property is required. boolean - If true, the policy is enabled.
- keep
N This property is required. number - The number of images to keep.
- name
Regex This property is required. string - The regular expression to match image names to delete.
- name
Regex Delete This property is required. string - The regular expression to match image names to delete.
- name
Regex Keep This property is required. string - The regular expression to match image names to keep.
- next
Run At This property is required. string - The next time the policy will run.
- older
Than This property is required. string - The number of days to keep images.
- cadence
This property is required. str - The cadence of the policy. Valid values are:
1d
,7d
,14d
,1month
,3month
. - enabled
This property is required. bool - If true, the policy is enabled.
- keep_
n This property is required. int - The number of images to keep.
- name_
regex This property is required. str - The regular expression to match image names to delete.
- name_
regex_ delete This property is required. str - The regular expression to match image names to delete.
- name_
regex_ keep This property is required. str - The regular expression to match image names to keep.
- next_
run_ at This property is required. str - The next time the policy will run.
- older_
than This property is required. str - The number of days to keep images.
- cadence
This property is required. String - The cadence of the policy. Valid values are:
1d
,7d
,14d
,1month
,3month
. - enabled
This property is required. Boolean - If true, the policy is enabled.
- keep
N This property is required. Number - The number of images to keep.
- name
Regex This property is required. String - The regular expression to match image names to delete.
- name
Regex Delete This property is required. String - The regular expression to match image names to delete.
- name
Regex Keep This property is required. String - The regular expression to match image names to keep.
- next
Run At This property is required. String - The next time the policy will run.
- older
Than This property is required. String - The number of days to keep images.
GetProjectsProjectForkedFromProject
- Http
Url To Repo This property is required. string - The HTTP clone URL of the upstream project.
- Id
This property is required. int - The ID of the upstream project.
- Name
This property is required. string - The name of the upstream project.
- Name
With Namespace This property is required. string - In
group / subgroup / project
oruser / project
format. - Path
This property is required. string - The path of the upstream project.
- Path
With Namespace This property is required. string - In
group/subgroup/project
oruser/project
format. - Web
Url This property is required. string - The web url of the upstream project.
- Http
Url To Repo This property is required. string - The HTTP clone URL of the upstream project.
- Id
This property is required. int - The ID of the upstream project.
- Name
This property is required. string - The name of the upstream project.
- Name
With Namespace This property is required. string - In
group / subgroup / project
oruser / project
format. - Path
This property is required. string - The path of the upstream project.
- Path
With Namespace This property is required. string - In
group/subgroup/project
oruser/project
format. - Web
Url This property is required. string - The web url of the upstream project.
- http
Url To Repo This property is required. String - The HTTP clone URL of the upstream project.
- id
This property is required. Integer - The ID of the upstream project.
- name
This property is required. String - The name of the upstream project.
- name
With Namespace This property is required. String - In
group / subgroup / project
oruser / project
format. - path
This property is required. String - The path of the upstream project.
- path
With Namespace This property is required. String - In
group/subgroup/project
oruser/project
format. - web
Url This property is required. String - The web url of the upstream project.
- http
Url To Repo This property is required. string - The HTTP clone URL of the upstream project.
- id
This property is required. number - The ID of the upstream project.
- name
This property is required. string - The name of the upstream project.
- name
With Namespace This property is required. string - In
group / subgroup / project
oruser / project
format. - path
This property is required. string - The path of the upstream project.
- path
With Namespace This property is required. string - In
group/subgroup/project
oruser/project
format. - web
Url This property is required. string - The web url of the upstream project.
- http_
url_ to_ repo This property is required. str - The HTTP clone URL of the upstream project.
- id
This property is required. int - The ID of the upstream project.
- name
This property is required. str - The name of the upstream project.
- name_
with_ namespace This property is required. str - In
group / subgroup / project
oruser / project
format. - path
This property is required. str - The path of the upstream project.
- path_
with_ namespace This property is required. str - In
group/subgroup/project
oruser/project
format. - web_
url This property is required. str - The web url of the upstream project.
- http
Url To Repo This property is required. String - The HTTP clone URL of the upstream project.
- id
This property is required. Number - The ID of the upstream project.
- name
This property is required. String - The name of the upstream project.
- name
With Namespace This property is required. String - In
group / subgroup / project
oruser / project
format. - path
This property is required. String - The path of the upstream project.
- path
With Namespace This property is required. String - In
group/subgroup/project
oruser/project
format. - web
Url This property is required. String - The web url of the upstream project.
GetProjectsProjectNamespace
- Full
Path This property is required. string - The full path of the namespace.
- Id
This property is required. int - The ID of the namespace.
- Kind
This property is required. string - The kind of the namespace.
- Name
This property is required. string - The name of the namespace.
- Path
This property is required. string - The path of the namespace.
- Full
Path This property is required. string - The full path of the namespace.
- Id
This property is required. int - The ID of the namespace.
- Kind
This property is required. string - The kind of the namespace.
- Name
This property is required. string - The name of the namespace.
- Path
This property is required. string - The path of the namespace.
- full
Path This property is required. String - The full path of the namespace.
- id
This property is required. Integer - The ID of the namespace.
- kind
This property is required. String - The kind of the namespace.
- name
This property is required. String - The name of the namespace.
- path
This property is required. String - The path of the namespace.
- full
Path This property is required. string - The full path of the namespace.
- id
This property is required. number - The ID of the namespace.
- kind
This property is required. string - The kind of the namespace.
- name
This property is required. string - The name of the namespace.
- path
This property is required. string - The path of the namespace.
- full_
path This property is required. str - The full path of the namespace.
- id
This property is required. int - The ID of the namespace.
- kind
This property is required. str - The kind of the namespace.
- name
This property is required. str - The name of the namespace.
- path
This property is required. str - The path of the namespace.
- full
Path This property is required. String - The full path of the namespace.
- id
This property is required. Number - The ID of the namespace.
- kind
This property is required. String - The kind of the namespace.
- name
This property is required. String - The name of the namespace.
- path
This property is required. String - The path of the namespace.
GetProjectsProjectOwner
- Avatar
Url This property is required. string - The avatar url of the owner.
- Id
This property is required. int - The ID of the owner.
- Name
This property is required. string - The name of the owner.
- State
This property is required. string - The state of the owner.
- Username
This property is required. string - The username of the owner.
- Website
Url This property is required. string - The website url of the owner.
- Avatar
Url This property is required. string - The avatar url of the owner.
- Id
This property is required. int - The ID of the owner.
- Name
This property is required. string - The name of the owner.
- State
This property is required. string - The state of the owner.
- Username
This property is required. string - The username of the owner.
- Website
Url This property is required. string - The website url of the owner.
- avatar
Url This property is required. String - The avatar url of the owner.
- id
This property is required. Integer - The ID of the owner.
- name
This property is required. String - The name of the owner.
- state
This property is required. String - The state of the owner.
- username
This property is required. String - The username of the owner.
- website
Url This property is required. String - The website url of the owner.
- avatar
Url This property is required. string - The avatar url of the owner.
- id
This property is required. number - The ID of the owner.
- name
This property is required. string - The name of the owner.
- state
This property is required. string - The state of the owner.
- username
This property is required. string - The username of the owner.
- website
Url This property is required. string - The website url of the owner.
- avatar_
url This property is required. str - The avatar url of the owner.
- id
This property is required. int - The ID of the owner.
- name
This property is required. str - The name of the owner.
- state
This property is required. str - The state of the owner.
- username
This property is required. str - The username of the owner.
- website_
url This property is required. str - The website url of the owner.
- avatar
Url This property is required. String - The avatar url of the owner.
- id
This property is required. Number - The ID of the owner.
- name
This property is required. String - The name of the owner.
- state
This property is required. String - The state of the owner.
- username
This property is required. String - The username of the owner.
- website
Url This property is required. String - The website url of the owner.
GetProjectsProjectPermission
- Group
Access This property is required. Dictionary<string, int> - Group access level.
- Project
Access This property is required. Dictionary<string, int> - Project access level.
- Group
Access This property is required. map[string]int - Group access level.
- Project
Access This property is required. map[string]int - Project access level.
- group
Access This property is required. Map<String,Integer> - Group access level.
- project
Access This property is required. Map<String,Integer> - Project access level.
- group
Access This property is required. {[key: string]: number} - Group access level.
- project
Access This property is required. {[key: string]: number} - Project access level.
- group_
access This property is required. Mapping[str, int] - Group access level.
- project_
access This property is required. Mapping[str, int] - Project access level.
- group
Access This property is required. Map<Number> - Group access level.
- project
Access This property is required. Map<Number> - Project access level.
GetProjectsProjectSharedWithGroup
- Group
Access Level This property is required. string - The group access level.
- Group
Id This property is required. int - The group ID.
- Group
Name This property is required. string - The group name.
- Group
Access Level This property is required. string - The group access level.
- Group
Id This property is required. int - The group ID.
- Group
Name This property is required. string - The group name.
- group
Access Level This property is required. String - The group access level.
- group
Id This property is required. Integer - The group ID.
- group
Name This property is required. String - The group name.
- group
Access Level This property is required. string - The group access level.
- group
Id This property is required. number - The group ID.
- group
Name This property is required. string - The group name.
- group_
access_ level This property is required. str - The group access level.
- group_
id This property is required. int - The group ID.
- group_
name This property is required. str - The group name.
- group
Access Level This property is required. String - The group access level.
- group
Id This property is required. Number - The group ID.
- group
Name This property is required. String - The group name.
Package Details
- Repository
- GitLab pulumi/pulumi-gitlab
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
gitlab
Terraform Provider.