Projects

Use this API to manage projects and the resources they contain, including:

Project settings, visibility, access permissions, and security settings.
Archiving, transferring, forking, and starring projects.
Project issues, issue statistics, and project statistics.
Markdown uploads referenced in issues, merge requests, snippets, or wiki pages.
Protection rules for container image tags, container repositories, and packages.

If a user is not a member of a private project, a GET request on that project results in a 404 status code.

List CODEOWNERS entries that match a file path

GET /api/v4/code-owners-for-file

Parameters

Name	Type	Description
`project_path` Query, required	String	—
`file_path` Query, required	String	—
`ref` Query	String	—

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—

List all projects

GET /api/v4/projects

Lists all projects. Unauthenticated requests return only public projects with a limited subset of attributes. You can filter responses by custom attributes.

Parameters

Name	Type	Description
`order_by` Query	String	Return projects ordered by field. storage_size, repository_size, wiki_size, packages_size are only available to admins. Similarity is available when searching and is limited to projects the user has access to Allowed values: `id`, `name`, `path`, `created_at`, `updated_at`, `last_activity_at`, `similarity`, `star_count`, `storage_size`, `repository_size`, `wiki_size`, `packages_size` Default: `created_at`
`sort` Query	String	Return projects sorted in ascending and descending order Allowed values: `asc`, `desc` Default: `desc`
`archived` Query	Boolean	Limit by archived status
`visibility` Query	String	Limit by visibility Allowed values: `private`, `internal`, `public`
`search` Query	String	Return list of projects matching the search criteria
`search_namespaces` Query	Boolean	Include ancestor namespaces when matching search criteria
`owned` Query	Boolean	Limit by owned by authenticated user Default: `false`
`starred` Query	Boolean	Limit by starred status Default: `false`
`imported` Query	Boolean	Limit by imported by authenticated user Default: `false`
`membership` Query	Boolean	Limit by projects that the current user is a member of Default: `false`
`with_issues_enabled` Query	Boolean	Limit by enabled issues feature Default: `false`
`with_merge_requests_enabled` Query	Boolean	Limit by enabled merge requests feature Default: `false`
`with_programming_language` Query	String	Limit to repositories which use the given programming language
`min_access_level` Query	Integer	Limit by minimum access level of authenticated user Allowed values: `10`, `15`, `20`, `25`, `30`, `40`, `50`
`id_after` Query	Integer	Limit results to projects with IDs greater than the specified ID
`id_before` Query	Integer	Limit results to projects with IDs less than the specified ID
`last_activity_after` Query	String (date-time)	Limit results to projects with last_activity after specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`last_activity_before` Query	String (date-time)	Limit results to projects with last_activity before specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`repository_storage` Query	String	Which storage shard the repository is on. Available only to admins
`topic` Query	Array of strings	Comma-separated list of topics. Limit results to projects having all topics
`topic_id` Query	Integer	Limit results to projects with the assigned topic given by the topic ID
`updated_before` Query	String (date-time)	Return projects updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`updated_after` Query	String (date-time)	Return projects updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`include_pending_delete` Query	Boolean	Include projects in pending delete state. Can only be set by admins
`marked_for_deletion_on` Query	String (date)	Date when the project was marked for deletion
`active` Query	Boolean	Limit by projects that are not archived and not marked for deletion
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`simple` Query	Boolean	Return only the ID, URL, name, and path of each project Default: `false`
`statistics` Query	Boolean	Include project statistics Default: `false`
`with_custom_attributes` Query	Boolean	Include custom attributes in the response Default: `false`
`custom_attributes` Query	Object	Filter with custom attributes

Responses

Code	Description	Schema
`200`	OK	APIEntitiesBasicProjectDetails
`400`	Bad request	—

Create a project

POST /api/v4/projects

Creates a project owned by the authenticated user. If your HTTP repository is not publicly accessible, add authentication information to the URL https://username:password@gitlab.company.com/group/project.git, where password is a public access key with the api scope.

Request body (multipart/form-data)

Property	Type	Description
`allow_merge_on_skipped_pipeline`	Boolean	Allow to merge if pipeline is skipped
`analytics_access_level`	String	Analytics access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`auto_cancel_pending_pipelines`	String	Auto-cancel pending pipelines Allowed values: `disabled`, `enabled`
`auto_devops_deploy_strategy`	String	Auto Deploy strategy Allowed values: `continuous`, `manual`, `timed_incremental`
`auto_devops_enabled`	Boolean	Flag indication if Auto DevOps is enabled
`autoclose_referenced_issues`	Boolean	Flag indication if referenced issues auto-closing is enabled
`avatar`	String (binary)	Avatar image for project
`build_git_strategy`	String	The Git strategy. Defaults to `fetch` Allowed values: `fetch`, `clone`
`build_timeout`	Integer	Build timeout
`builds_access_level`	String	Builds access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`ci_config_path`	String	The path to CI config file. Defaults to `.gitlab-ci.yml`
`cicd_catalog_enabled`	Boolean	Set whether the project is a CI/CD catalog project
`container_expiration_policy_attributes`	Object	Object that contains information on the container expiration policy
`container_expiration_policy_attributes.cadence`	String	Container expiration policy cadence for recurring job
`container_expiration_policy_attributes.enabled`	Boolean	Flag indication if container expiration policy is enabled
`container_expiration_policy_attributes.keep_n`	Integer	Container expiration policy number of images to keep
`container_expiration_policy_attributes.name_regex`	String	Container expiration policy regex for image removal
`container_expiration_policy_attributes.name_regex_keep`	String	Container expiration policy regex for image retention
`container_expiration_policy_attributes.older_than`	String	Container expiration policy remove images older than value
`container_registry_access_level`	String	Controls visibility of the container registry. One of `disabled`, `private` or `enabled`. `private` will make the container registry accessible only to project members (reporter role and above). `enabled` will make the container registry accessible to everyone who has access to the project. `disabled` will disable the container registry Allowed values: `disabled`, `private`, `enabled`
`container_registry_enabled`	Boolean	Deprecated: Use :container_registry_access_level instead. Flag indication if the container registry is enabled for that project
`default_branch`	String	The default branch of the project Example: `main`
`description`	String	The description of the project
`emails_disabled`	Boolean	Deprecated: Use emails_enabled instead
`emails_enabled`	Boolean	Enable email notifications
`enforce_auth_checks_on_uploads`	Boolean	Enforce auth check on uploads
`environments_access_level`	String	Environments access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`feature_flags_access_level`	String	Feature flags access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`forking_access_level`	String	Forks access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`group_runners_enabled`	Boolean	Flag indication if group runners are enabled for that project
`import_url`	String	URL from which the project is imported. Mutually exclusive with `template_name`, `template_project_id`
`infrastructure_access_level`	String	Infrastructure access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`initialize_with_readme`	Boolean	Initialize a project with a README.md
`issue_branch_template`	String	Template used to create a branch from an issue
`issues_access_level`	String	Issues access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`issues_enabled`	Boolean	Flag indication if the issue tracker is enabled
`jobs_enabled`	Boolean	Flag indication if jobs are enabled
`lfs_enabled`	Boolean	Flag indication if Git LFS is enabled for that project
`merge_commit_template`	String	Template used to create merge commit message
`merge_method`	String	The merge method used when merging merge requests Allowed values: `ff`, `rebase_merge`, `merge`
`merge_request_title_regex`	String	Regex pattern for validating merge request titles Maximum length: `255`
`merge_request_title_regex_description`	String	Example merge request title that matches merge_request_title_regex. Shown when a title does not match Maximum length: `255`
`merge_requests_access_level`	String	Merge requests access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`merge_requests_enabled`	Boolean	Flag indication if merge requests are enabled
`model_experiments_access_level`	String	Model experiments access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`model_registry_access_level`	String	Model registry access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`monitor_access_level`	String	Monitor access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`mr_default_target_self`	Boolean	Merge requests of this forked project targets itself by default
`mr_default_title_template`	String	Template used to generate the default merge request title. Maximum 100 characters Maximum length: `100`
`name`	String	The name of the project Example: `New Project`
`namespace_id`	Integer	Namespace ID for the new project. Default to the user namespace
`only_allow_merge_if_all_discussions_are_resolved`	Boolean	Only allow to merge if all threads are resolved
`only_allow_merge_if_pipeline_succeeds`	Boolean	Only allow to merge if builds succeed
`package_registry_access_level`	String	Controls visibility of the package registry. One of `disabled`, `private`, `enabled` or `public`. `private` will make the package registry accessible only to project members (reporter role and above). `enabled` will make the package registry accessible to everyone who has access to the project. `public` will make the package registry accessible to everyone. `disabled` will disable the package registry Allowed values: `disabled`, `private`, `enabled`, `public`
`packages_enabled`	Boolean	Deprecated: Use :package_registry_access_level instead. Enable project packages feature
`pages_access_level`	String	Pages access level. One of `disabled`, `private`, `enabled` or `public` Allowed values: `disabled`, `private`, `enabled`, `public`
`path`	String	The path of the repository Example: `new_project`
`printing_merge_request_link_enabled`	Boolean	Show link to create/view merge request when pushing from the command line
`public_builds`	Boolean	Deprecated: Use public_jobs instead
`public_jobs`	Boolean	Perform public builds
`releases_access_level`	String	Releases access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`remove_source_branch_after_merge`	Boolean	Remove the source branch by default after merge
`repository_access_level`	String	Repository access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`repository_object_format`	String	The object format of the project repository Allowed values: `sha1`, `sha256`
`repository_storage`	String	Which storage shard the repository is on. Available only to admins
`request_access_enabled`	Boolean	Allow users to request member access
`resolve_outdated_diff_discussions`	Boolean	Automatically resolve merge request diff threads on lines changed with a push
`resource_group_default_process_mode`	String	The process mode of the resource group Allowed values: `unordered`, `oldest_first`, `newest_first`, `newest_ready_first`
`security_and_compliance_access_level`	String	Security and compliance access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`service_desk_enabled`	Boolean	Disable or enable the service desk
`shared_runners_enabled`	Boolean	Flag indication if shared runners are enabled for that project
`show_default_award_emojis`	Boolean	Show default award emojis
`show_diff_preview_in_email`	Boolean	Include the code diff preview in merge request notification emails
`snippets_access_level`	String	Snippets access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`snippets_enabled`	Boolean	Flag indication if snippets are enabled
`squash_commit_template`	String	Template used to create squash commit message
`squash_option`	String	Squash default for project. One of `never`, `always`, `default_on`, or `default_off` Allowed values: `never`, `always`, `default_on`, `default_off`
`suggestion_commit_message`	String	The commit message used to apply merge request suggestions
`tag_list`	Array of strings	Deprecated: Use :topics instead
`template_name`	String	Name of template from which to create project. Mutually exclusive with `import_url`, `template_project_id`
`template_project_id`	Integer	Project ID of template from which to create project. Mutually exclusive with `import_url`, `template_name`
`topics`	Array of strings	The list of topics for a project
`visibility`	String	The visibility of the project Allowed values: `private`, `internal`, `public`
`warn_about_potentially_unwanted_characters`	Boolean	Warn about potentially unwanted characters
`wiki_access_level`	String	Wiki access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`wiki_enabled`	Boolean	Flag indication if the wiki is enabled

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProject
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

Create a project for a user

POST /api/v4/projects/user/{user_id}

Creates a project for a user. Administrators only.

Parameters

Name	Type	Description
`user_id` Path, required	Integer	The ID of a user Example: `1`

Request body (multipart/form-data)

Property	Type	Description
`allow_merge_on_skipped_pipeline`	Boolean	Allow to merge if pipeline is skipped
`analytics_access_level`	String	Analytics access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`auto_cancel_pending_pipelines`	String	Auto-cancel pending pipelines Allowed values: `disabled`, `enabled`
`auto_devops_deploy_strategy`	String	Auto Deploy strategy Allowed values: `continuous`, `manual`, `timed_incremental`
`auto_devops_enabled`	Boolean	Flag indication if Auto DevOps is enabled
`autoclose_referenced_issues`	Boolean	Flag indication if referenced issues auto-closing is enabled
`avatar`	String (binary)	Avatar image for project
`build_git_strategy`	String	The Git strategy. Defaults to `fetch` Allowed values: `fetch`, `clone`
`build_timeout`	Integer	Build timeout
`builds_access_level`	String	Builds access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`ci_config_path`	String	The path to CI config file. Defaults to `.gitlab-ci.yml`
`cicd_catalog_enabled`	Boolean	Set whether the project is a CI/CD catalog project
`container_expiration_policy_attributes`	Object	Object that contains information on the container expiration policy
`container_expiration_policy_attributes.cadence`	String	Container expiration policy cadence for recurring job
`container_expiration_policy_attributes.enabled`	Boolean	Flag indication if container expiration policy is enabled
`container_expiration_policy_attributes.keep_n`	Integer	Container expiration policy number of images to keep
`container_expiration_policy_attributes.name_regex`	String	Container expiration policy regex for image removal
`container_expiration_policy_attributes.name_regex_keep`	String	Container expiration policy regex for image retention
`container_expiration_policy_attributes.older_than`	String	Container expiration policy remove images older than value
`container_registry_access_level`	String	Controls visibility of the container registry. One of `disabled`, `private` or `enabled`. `private` will make the container registry accessible only to project members (reporter role and above). `enabled` will make the container registry accessible to everyone who has access to the project. `disabled` will disable the container registry Allowed values: `disabled`, `private`, `enabled`
`container_registry_enabled`	Boolean	Deprecated: Use :container_registry_access_level instead. Flag indication if the container registry is enabled for that project
`default_branch`	String	The default branch of the project Example: `main`
`description`	String	The description of the project
`emails_disabled`	Boolean	Deprecated: Use emails_enabled instead
`emails_enabled`	Boolean	Enable email notifications
`enforce_auth_checks_on_uploads`	Boolean	Enforce auth check on uploads
`environments_access_level`	String	Environments access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`feature_flags_access_level`	String	Feature flags access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`forking_access_level`	String	Forks access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`group_runners_enabled`	Boolean	Flag indication if group runners are enabled for that project
`import_url`	String	URL from which the project is imported. Mutually exclusive with `template_name`, `template_project_id`
`infrastructure_access_level`	String	Infrastructure access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`initialize_with_readme`	Boolean	Initialize a project with a README.md
`issue_branch_template`	String	Template used to create a branch from an issue
`issues_access_level`	String	Issues access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`issues_enabled`	Boolean	Flag indication if the issue tracker is enabled
`jobs_enabled`	Boolean	Flag indication if jobs are enabled
`lfs_enabled`	Boolean	Flag indication if Git LFS is enabled for that project
`merge_commit_template`	String	Template used to create merge commit message
`merge_method`	String	The merge method used when merging merge requests Allowed values: `ff`, `rebase_merge`, `merge`
`merge_request_title_regex`	String	Regex pattern for validating merge request titles Maximum length: `255`
`merge_request_title_regex_description`	String	Example merge request title that matches merge_request_title_regex. Shown when a title does not match Maximum length: `255`
`merge_requests_access_level`	String	Merge requests access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`merge_requests_enabled`	Boolean	Flag indication if merge requests are enabled
`model_experiments_access_level`	String	Model experiments access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`model_registry_access_level`	String	Model registry access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`monitor_access_level`	String	Monitor access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`mr_default_target_self`	Boolean	Merge requests of this forked project targets itself by default
`mr_default_title_template`	String	Template used to generate the default merge request title. Maximum 100 characters Maximum length: `100`
`name` Required	String	The name of the project Example: `New Project`
`namespace_id`	Integer	Namespace ID for the new project. Default to the user namespace
`only_allow_merge_if_all_discussions_are_resolved`	Boolean	Only allow to merge if all threads are resolved
`only_allow_merge_if_pipeline_succeeds`	Boolean	Only allow to merge if builds succeed
`package_registry_access_level`	String	Controls visibility of the package registry. One of `disabled`, `private`, `enabled` or `public`. `private` will make the package registry accessible only to project members (reporter role and above). `enabled` will make the package registry accessible to everyone who has access to the project. `public` will make the package registry accessible to everyone. `disabled` will disable the package registry Allowed values: `disabled`, `private`, `enabled`, `public`
`packages_enabled`	Boolean	Deprecated: Use :package_registry_access_level instead. Enable project packages feature
`pages_access_level`	String	Pages access level. One of `disabled`, `private`, `enabled` or `public` Allowed values: `disabled`, `private`, `enabled`, `public`
`path`	String	The path of the repository Example: `new_project`
`printing_merge_request_link_enabled`	Boolean	Show link to create/view merge request when pushing from the command line
`public_builds`	Boolean	Deprecated: Use public_jobs instead
`public_jobs`	Boolean	Perform public builds
`releases_access_level`	String	Releases access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`remove_source_branch_after_merge`	Boolean	Remove the source branch by default after merge
`repository_access_level`	String	Repository access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`repository_object_format`	String	The object format of the project repository Allowed values: `sha1`, `sha256`
`repository_storage`	String	Which storage shard the repository is on. Available only to admins
`request_access_enabled`	Boolean	Allow users to request member access
`resolve_outdated_diff_discussions`	Boolean	Automatically resolve merge request diff threads on lines changed with a push
`resource_group_default_process_mode`	String	The process mode of the resource group Allowed values: `unordered`, `oldest_first`, `newest_first`, `newest_ready_first`
`security_and_compliance_access_level`	String	Security and compliance access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`service_desk_enabled`	Boolean	Disable or enable the service desk
`shared_runners_enabled`	Boolean	Flag indication if shared runners are enabled for that project
`show_default_award_emojis`	Boolean	Show default award emojis
`show_diff_preview_in_email`	Boolean	Include the code diff preview in merge request notification emails
`snippets_access_level`	String	Snippets access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`snippets_enabled`	Boolean	Flag indication if snippets are enabled
`squash_commit_template`	String	Template used to create squash commit message
`squash_option`	String	Squash default for project. One of `never`, `always`, `default_on`, or `default_off` Allowed values: `never`, `always`, `default_on`, `default_off`
`suggestion_commit_message`	String	The commit message used to apply merge request suggestions
`tag_list`	Array of strings	Deprecated: Use :topics instead
`template_name`	String	Name of template from which to create project. Mutually exclusive with `import_url`, `template_project_id`
`template_project_id`	Integer	Project ID of template from which to create project. Mutually exclusive with `import_url`, `template_name`
`topics`	Array of strings	The list of topics for a project
`visibility`	String	The visibility of the project Allowed values: `private`, `internal`, `public`
`warn_about_potentially_unwanted_characters`	Boolean	Warn about potentially unwanted characters
`wiki_access_level`	String	Wiki access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`wiki_enabled`	Boolean	Flag indication if the wiki is enabled

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProject
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

Retrieve a project

GET /api/v4/projects/{id}

Retrieves details on a specified project. This endpoint can be accessed without authentication if the project is publicly accessible.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`statistics` Query	Boolean	Include project statistics Default: `false`
`with_custom_attributes` Query	Boolean	Include custom attributes in the response Default: `false`
`custom_attributes` Query	Object	Filter with custom attributes
`license` Query	Boolean	Include project license data Default: `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProjectsWithAccessAndCatalogSetting
`400`	Bad Request	—
`404`	Not Found	—

Update a project

PUT /api/v4/projects/{id}

Updates an existing project. If your HTTP repository is not publicly accessible, add authentication information to the URL https://username:password@gitlab.company.com/group/project.git, where password is a public access key with the api scope.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (multipart/form-data)

Property	Type	Description
`allow_merge_on_skipped_pipeline`	Boolean	Allow to merge if pipeline is skipped
`allow_pipeline_trigger_approve_deployment`	Boolean	Allow the pipeline triggerer to approve deployments
`analytics_access_level`	String	Analytics access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`auto_cancel_pending_pipelines`	String	Auto-cancel pending pipelines Allowed values: `disabled`, `enabled`
`auto_devops_deploy_strategy`	String	Auto Deploy strategy Allowed values: `continuous`, `manual`, `timed_incremental`
`auto_devops_enabled`	Boolean	Flag indication if Auto DevOps is enabled
`autoclose_referenced_issues`	Boolean	Flag indication if referenced issues auto-closing is enabled
`automatic_rebase_enabled`	Boolean	Enable automatic rebase of the source branch before merge
`avatar`	String (binary)	Avatar image for project
`build_git_strategy`	String	The Git strategy. Defaults to `fetch` Allowed values: `fetch`, `clone`
`build_timeout`	Integer	Build timeout
`builds_access_level`	String	Builds access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`ci_allow_fork_pipelines_to_run_in_parent_project`	Boolean	Allow fork merge request pipelines to run in parent project
`ci_config_path`	String	The path to CI config file. Defaults to `.gitlab-ci.yml`
`ci_default_git_depth`	Integer	Default number of revisions for shallow cloning
`ci_delete_pipelines_in_seconds`	Integer	Pipelines older than the configured time are deleted
`ci_display_pipeline_variables`	Boolean	Display all manually-defined variables in the pipeline details page after running a pipeline manually
`ci_forward_deployment_enabled`	Boolean	Prevent older deployment jobs that are still pending
`ci_forward_deployment_rollback_allowed`	Boolean	Allow job retries for rollback deployments
`ci_id_token_sub_claim_components`	Array of strings	Claims that will be used to build the sub claim in id tokens
`ci_pipeline_variables_minimum_override_role`	String	Limit ability to override CI/CD variables when triggering a pipeline to only users with at least the set minimum role Allowed values: `no_one_allowed`, `developer`, `maintainer`, `owner`
`ci_push_repository_for_job_token_allowed`	Boolean	Allow pushing to this project’s repository by authenticating with a CI/CD job token generated in this project
`ci_separated_caches`	Boolean	Enable or disable separated caches based on branch protection
`ci_skip_branch_pipelines_for_mrs`	Boolean	Skip the branch pipeline when a branch has an open merge request, and run only the merge request pipeline
`cicd_catalog_enabled`	Boolean	Set whether the project is a CI/CD catalog project
`container_expiration_policy_attributes`	Object	Object that contains information on the container expiration policy
`container_expiration_policy_attributes.cadence`	String	Container expiration policy cadence for recurring job
`container_expiration_policy_attributes.enabled`	Boolean	Flag indication if container expiration policy is enabled
`container_expiration_policy_attributes.keep_n`	Integer	Container expiration policy number of images to keep
`container_expiration_policy_attributes.name_regex`	String	Container expiration policy regex for image removal
`container_expiration_policy_attributes.name_regex_keep`	String	Container expiration policy regex for image retention
`container_expiration_policy_attributes.older_than`	String	Container expiration policy remove images older than value
`container_registry_access_level`	String	Controls visibility of the container registry. One of `disabled`, `private` or `enabled`. `private` will make the container registry accessible only to project members (reporter role and above). `enabled` will make the container registry accessible to everyone who has access to the project. `disabled` will disable the container registry Allowed values: `disabled`, `private`, `enabled`
`container_registry_enabled`	Boolean	Deprecated: Use :container_registry_access_level instead. Flag indication if the container registry is enabled for that project
`default_branch`	String	The default branch of the project Example: `main`
`description`	String	The description of the project
`emails_disabled`	Boolean	Deprecated: Use emails_enabled instead
`emails_enabled`	Boolean	Enable email notifications
`enforce_auth_checks_on_uploads`	Boolean	Enforce auth check on uploads
`environments_access_level`	String	Environments access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`fe_project_setting_attributes`	Object	FE project settings attributes
`fe_project_setting_attributes.opensearch_indexed_branches_regex`	String	Regex for indexing additional branches in OpenSearch (default branch is always indexed)
`feature_flags_access_level`	String	Feature flags access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`feature_flags_minimum_role`	String	Limit the ability to create, update, toggle, and delete feature flags to only users with at least the set minimum role Allowed values: `no_one_allowed`, `developer`, `maintainer`, `owner`
`forking_access_level`	String	Forks access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`group_runners_enabled`	Boolean	Flag indication if group runners are enabled for that project
`infrastructure_access_level`	String	Infrastructure access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`issue_branch_template`	String	Template used to create a branch from an issue
`issues_access_level`	String	Issues access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`issues_enabled`	Boolean	Flag indication if the issue tracker is enabled
`jobs_enabled`	Boolean	Flag indication if jobs are enabled
`keep_latest_artifact`	Boolean	Indicates if the latest artifact should be kept for this project
`lfs_enabled`	Boolean	Flag indication if Git LFS is enabled for that project
`max_artifacts_size`	Integer	Set the maximum file size for each job’s artifacts
`max_pipelines_per_merge_train`	Integer	Set the maximum number of parallel pipelines for a merge train
`merge_commit_template`	String	Template used to create merge commit message
`merge_method`	String	The merge method used when merging merge requests Allowed values: `ff`, `rebase_merge`, `merge`
`merge_pipelines_enabled`	Boolean	Enable or disable merged results pipelines
`merge_request_title_regex`	String	Regex pattern for validating merge request titles Maximum length: `255`
`merge_request_title_regex_description`	String	Example merge request title that matches merge_request_title_regex. Shown when a title does not match Maximum length: `255`
`merge_requests_access_level`	String	Merge requests access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`merge_requests_enabled`	Boolean	Flag indication if merge requests are enabled
`merge_requests_template`	String	—
`merge_train_enforced`	Boolean	Require merge requests to merge through a merge train
`merge_trains_enabled`	Boolean	Enable or disable merge trains
`merge_trains_skip_train_allowed`	Boolean	Allow merge requests to merge immediately without restarting the merge train
`model_experiments_access_level`	String	Model experiments access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`model_registry_access_level`	String	Model registry access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`monitor_access_level`	String	Monitor access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`mr_default_target_self`	Boolean	Merge requests of this forked project targets itself by default
`mr_default_title_template`	String	Template used to generate the default merge request title. Maximum 100 characters Maximum length: `100`
`name`	String	The name of the project Example: `project`
`only_allow_merge_if_all_discussions_are_resolved`	Boolean	Only allow to merge if all threads are resolved
`only_allow_merge_if_pipeline_succeeds`	Boolean	Only allow to merge if builds succeed
`package_registry_access_level`	String	Controls visibility of the package registry. One of `disabled`, `private`, `enabled` or `public`. `private` will make the package registry accessible only to project members (reporter role and above). `enabled` will make the package registry accessible to everyone who has access to the project. `public` will make the package registry accessible to everyone. `disabled` will disable the package registry Allowed values: `disabled`, `private`, `enabled`, `public`
`packages_enabled`	Boolean	Deprecated: Use :package_registry_access_level instead. Enable project packages feature
`pages_access_level`	String	Pages access level. One of `disabled`, `private`, `enabled` or `public` Allowed values: `disabled`, `private`, `enabled`, `public`
`path`	String	The path of the repository Example: `group/project`
`printing_merge_request_link_enabled`	Boolean	Show link to create/view merge request when pushing from the command line
`protect_merge_request_pipelines`	Boolean	Make protected CI/CD variables and runners available in merge request pipelines
`public_builds`	Boolean	Deprecated: Use public_jobs instead
`public_jobs`	Boolean	Perform public builds
`releases_access_level`	String	Releases access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`remove_source_branch_after_merge`	Boolean	Remove the source branch by default after merge
`repository_access_level`	String	Repository access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`repository_storage`	String	Which storage shard the repository is on. Available only to admins
`request_access_enabled`	Boolean	Allow users to request member access
`resolve_outdated_diff_discussions`	Boolean	Automatically resolve merge request diff threads on lines changed with a push
`resource_group_default_process_mode`	String	The process mode of the resource group Allowed values: `unordered`, `oldest_first`, `newest_first`, `newest_ready_first`
`restrict_user_defined_variables`	Boolean	Restrict use of user-defined variables when triggering a pipeline
`security_and_compliance_access_level`	String	Security and compliance access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`service_desk_enabled`	Boolean	Disable or enable the service desk
`shared_runners_enabled`	Boolean	Flag indication if shared runners are enabled for that project
`show_default_award_emojis`	Boolean	Show default award emojis
`show_diff_preview_in_email`	Boolean	Include the code diff preview in merge request notification emails
`snippets_access_level`	String	Snippets access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`snippets_enabled`	Boolean	Flag indication if snippets are enabled
`squash_commit_template`	String	Template used to create squash commit message
`squash_option`	String	Squash default for project. One of `never`, `always`, `default_on`, or `default_off` Allowed values: `never`, `always`, `default_on`, `default_off`
`suggestion_commit_message`	String	The commit message used to apply merge request suggestions
`tag_list`	Array of strings	Deprecated: Use :topics instead
`topics`	Array of strings	The list of topics for a project
`visibility`	String	The visibility of the project Allowed values: `private`, `internal`, `public`
`warn_about_potentially_unwanted_characters`	Boolean	Warn about potentially unwanted characters
`wiki_access_level`	String	Wiki access level. One of `disabled`, `private` or `enabled` Allowed values: `disabled`, `private`, `enabled`
`wiki_enabled`	Boolean	Flag indication if the wiki is enabled

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProjectsWithCatalogSetting
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not Found	—

Delete a project

DELETE /api/v4/projects/{id}

Deletes a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`202`	Accepted	—
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not found	—

Search a project

GET /api/v4/projects/{id}/(-/)search

Searches for content in a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`search` Query, required	String	The expression it should be searched for
`scope` Query, required	String	The scope of the search Allowed values: `issues`, `work_items`, `merge_requests`, `milestones`, `notes`, `wiki_blobs`, `commits`, `blobs`, `users` Minimum length: `1`
`ref` Query	String	The name of a repository branch or tag. If not given, the default branch is used
`state` Query	String	Filter results by state Allowed values: `all`, `opened`, `closed`, `merged`
`confidential` Query	Boolean	Filter results by confidentiality
`type` Query	Array of strings	Filter work items by type. Only applies to work_items scope. Available types: issue, task, incident, ticket
`fields` Query	Array of strings	Array of fields to search. Only “title” is supported (work_items / issues scope)
`language` Query	Array of strings	Array of languages to filter blobs by language
`label_name` Query	Array of strings	Array of labels to filter work_items / issues / merge_requests by label
`source_branch` Query	String	Filter merge requests by source branch Maximum length: `255`
`target_branch` Query	String	Filter merge requests by target branch Maximum length: `255`
`not_source_branch` Query	String	Exclude merge requests by source branch Maximum length: `255`
`not_target_branch` Query	String	Exclude merge requests by target branch Maximum length: `255`
`author_username` Query	String	Filter merge requests by author username Maximum length: `255`
`not_author_username` Query	String	Exclude merge requests by author username Maximum length: `255`
`num_context_lines` Query	Integer	Number of context lines around each match. Only supported for blobs scope Maximum: `20` Minimum: `0`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not Found	—

Archive a project

POST /api/v4/projects/{id}/archive

Archives a specified project. You must be an administrator or be assigned the Owner role on the project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProject
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not Found	—

Create a fork of a project

POST /api/v4/projects/{id}/fork

Creates a fork of a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (application/json)

Property	Type	Description
`branches`	String	Branches to fork
`description`	String	The description that will be assigned to the fork Example: `Description`
`mr_default_target_self`	Boolean	Merge requests of this forked project targets itself by default
`name`	String	The name that will be assigned to the fork Example: `Fork`
`namespace`	String	(deprecated) The ID or name of the namespace that the project will be forked into Example: `gitlab`
`namespace_id`	Integer	The ID of the namespace that the project will be forked into Example: `1`
`namespace_path`	String	The path of the namespace that the project will be forked into Example: `new_path/gitlab`
`path`	String	The path that will be assigned to the fork Example: `fork`
`visibility`	String	The visibility of the fork Allowed values: `private`, `internal`, `public`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProject
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not found	—
`409`	Conflict	—

Delete a fork relationship

DELETE /api/v4/projects/{id}/fork

Deletes a fork relationship between projects.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`204`	No Content	—
`304`	Not modified	—
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not found	—

Create a fork relationship

POST /api/v4/projects/{id}/fork/{forked_from_id}

Creates a fork relationship between a project and an upstream project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`forked_from_id` Path, required	String	The ID of the project it was forked from Example: `gitlab`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProject
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Unauthenticated	—
`404`	Not found	—

List all forks of a project

GET /api/v4/projects/{id}/forks

Lists all forks of a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`order_by` Query	String	Return projects ordered by field. storage_size, repository_size, wiki_size, packages_size are only available to admins. Similarity is available when searching and is limited to projects the user has access to Allowed values: `id`, `name`, `path`, `created_at`, `updated_at`, `last_activity_at`, `similarity`, `star_count`, `storage_size`, `repository_size`, `wiki_size`, `packages_size` Default: `created_at`
`sort` Query	String	Return projects sorted in ascending and descending order Allowed values: `asc`, `desc` Default: `desc`
`archived` Query	Boolean	Limit by archived status
`visibility` Query	String	Limit by visibility Allowed values: `private`, `internal`, `public`
`search` Query	String	Return list of projects matching the search criteria
`search_namespaces` Query	Boolean	Include ancestor namespaces when matching search criteria
`owned` Query	Boolean	Limit by owned by authenticated user Default: `false`
`starred` Query	Boolean	Limit by starred status Default: `false`
`imported` Query	Boolean	Limit by imported by authenticated user Default: `false`
`membership` Query	Boolean	Limit by projects that the current user is a member of Default: `false`
`with_issues_enabled` Query	Boolean	Limit by enabled issues feature Default: `false`
`with_merge_requests_enabled` Query	Boolean	Limit by enabled merge requests feature Default: `false`
`with_programming_language` Query	String	Limit to repositories which use the given programming language
`min_access_level` Query	Integer	Limit by minimum access level of authenticated user Allowed values: `10`, `15`, `20`, `25`, `30`, `40`, `50`
`id_after` Query	Integer	Limit results to projects with IDs greater than the specified ID
`id_before` Query	Integer	Limit results to projects with IDs less than the specified ID
`last_activity_after` Query	String (date-time)	Limit results to projects with last_activity after specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`last_activity_before` Query	String (date-time)	Limit results to projects with last_activity before specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`repository_storage` Query	String	Which storage shard the repository is on. Available only to admins
`topic` Query	Array of strings	Comma-separated list of topics. Limit results to projects having all topics
`topic_id` Query	Integer	Limit results to projects with the assigned topic given by the topic ID
`updated_before` Query	String (date-time)	Return projects updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`updated_after` Query	String (date-time)	Return projects updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`include_pending_delete` Query	Boolean	Include projects in pending delete state. Can only be set by admins
`marked_for_deletion_on` Query	String (date)	Date when the project was marked for deletion
`active` Query	Boolean	Limit by projects that are not archived and not marked for deletion
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`simple` Query	Boolean	Return only the ID, URL, name, and path of each project Default: `false`
`with_custom_attributes` Query	Boolean	Include custom attributes in the response Default: `false`
`custom_attributes` Query	Object	Filter with custom attributes

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProject
`400`	Bad Request	—
`404`	Not Found	—

List all ancestor groups

GET /api/v4/projects/{id}/groups

Lists all ancestor groups for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`search` Query	String	Return list of groups matching the search criteria Example: `group`
`skip_groups` Query	Array of integers	Array of group ids to exclude from list
`with_shared` Query	Boolean	Include shared groups Default: `false`
`shared_visible_only` Query	Boolean	Limit to shared groups user has access to Default: `false`
`shared_min_access_level` Query	Integer	Limit returned shared groups by minimum access level to the project Allowed values: `10`, `15`, `20`, `25`, `30`, `40`, `50`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesPublicGroupDetails
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not found	—

Start the housekeeping task for a project

POST /api/v4/projects/{id}/housekeeping

Starts the housekeeping task for a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (application/json)

Property	Type	Description
`task`	String	`prune` to trigger manual prune of unreachable objects or `eager` to trigger eager housekeeping Allowed values: `:eager`, `:prune` Default: `:eager`

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Unauthenticated	—
`404`	Not Found	—
`409`	Conflict	—

Import members

POST /api/v4/projects/{id}/import_project_members/{project_id}

Imports members from another project. If the role of the importing member for the target project is a Maintainer, then members with the Owner role for the source project are imported with the Maintainer role. If the importing member is an Owner, then members with the Owner role for the source project are imported with the Owner role.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`project_id` Path, required	Integer	The ID of the source project to import the members from

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`403`	Forbidden - Project	—
`404`	Project Not Found	—
`422`	Import failed	—

List all invited groups in a project

GET /api/v4/projects/{id}/invited_groups

Lists all invited groups in a project. Unauthenticated requests return only public invited groups. Limited to 60 requests a minute per user account for authenticated requires and per IP address for unauthenticated requests. Supports offset-based pagination (up to 50,000 projects) and keyset-based pagination (greater than 50,000 projects).

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`relation` Query	Array of strings	Filter by group relation
`search` Query	String	Search for a specific group
`min_access_level` Query	Integer	Limit by minimum access level of authenticated user Allowed values: `10`, `15`, `20`, `25`, `30`, `40`, `50`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`with_custom_attributes` Query	Boolean	Include custom attributes in the response Default: `false`
`custom_attributes` Query	Object	Filter with custom attributes

Responses

Code	Description	Schema
`200`	OK	APIEntitiesGroup
`400`	Bad Request	—
`404`	Not Found	—

List all project issues

GET /api/v4/projects/{id}/issues

Lists all issues for a specified project. If the project is private, you need to provide credentials to authorize. In most cases, you should authenticate with a personal access token.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`with_labels_details` Query	Boolean	Return titles of labels and other details Default: `false`
`state` Query	String	Return opened, closed, or all issues Allowed values: `opened`, `closed`, `all` Default: `all`
`closed_by_id` Query	Integer	Return issues which were closed by the user with the given ID
`order_by` Query	String	Return issues ordered by `created_at`, `due_date`, `label_priority`, `milestone_due`, `popularity`, `priority`, `relative_position`, `title`, or `updated_at` fields Allowed values: `created_at`, `due_date`, `label_priority`, `milestone_due`, `popularity`, `priority`, `relative_position`, `title`, `updated_at` Default: `created_at`
`sort` Query	String	Return issues sorted in `asc` or `desc` order Allowed values: `asc`, `desc` Default: `desc`
`due_date` Query	String	Return issues that have no due date (`0`), or whose due date is this week, this month, between two weeks ago and next month, or which are overdue. Accepts: `overdue`, `week`, `month`, `next_month_and_previous_two_weeks`, `0` Allowed values: `0`, `any`, `today`, `tomorrow`, `overdue`, `week`, `month`, `next_month_and_previous_two_weeks`, ``
`issue_type` Query	String	The type of the issue. Accepts: issue, incident, test_case, requirement, task, ticket Allowed values: `issue`, `incident`, `test_case`, `requirement`, `task`, `ticket`
`labels` Query	Array of strings	Comma-separated list of label names
`milestone` Query	String	Milestone title. Mutually exclusive with `milestone_id`
`milestone_id` Query	String	Return issues assigned to milestones with the specified timebox value (“Any”, “None”, “Upcoming” or “Started”). Mutually exclusive with `milestone` Allowed values: `Any`, `None`, `Upcoming`, `Started`
`iids` Query	Array of integers	The IID array of issues
`search` Query	String	Search issues for text present in the title, description, or any combination of these
`in` Query	String	`title`, `description`, or a string joining them with comma
`author_id` Query	Integer	Return issues which are authored by the user with the given ID. Mutually exclusive with `author_username`
`author_username` Query	String	Return issues which are authored by the user with the given username. Mutually exclusive with `author_id`
`assignee_id` Query	Integer or string	Return issues which are assigned to the user with the given ID. Mutually exclusive with `assignee_username`
`assignee_username` Query	Array of strings	Return issues which are assigned to the user with the given username. Mutually exclusive with `assignee_id`
`created_after` Query	String (date-time)	Return issues created after the specified time
`created_before` Query	String (date-time)	Return issues created before the specified time
`updated_after` Query	String (date-time)	Return issues updated after the specified time
`updated_before` Query	String (date-time)	Return issues updated before the specified time
`not` Query	Object	Filters by the specified parameters
`not[labels]` Query	Array of strings	Comma-separated list of label names
`not[milestone]` Query	String	Milestone title. Mutually exclusive with `not[milestone_id]`
`not[milestone_id]` Query	String	Return issues assigned to milestones without the specified timebox value (“Any”, “None”, “Upcoming” or “Started”). Mutually exclusive with `not[milestone]` Allowed values: `Any`, `None`, `Upcoming`, `Started`
`not[iids]` Query	Array of integers	The IID array of issues
`not[author_id]` Query	Integer	Return issues which are not authored by the user with the given ID. Mutually exclusive with `not[author_username]`
`not[author_username]` Query	String	Return issues which are not authored by the user with the given username. Mutually exclusive with `not[author_id]`
`not[assignee_id]` Query	Integer	Return issues which are not assigned to the user with the given ID. Mutually exclusive with `not[assignee_username]`
`not[assignee_username]` Query	Array of strings	Return issues which are not assigned to the user with the given username. Mutually exclusive with `not[assignee_id]`
`scope` Query	String	Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all` Allowed values: `created-by-me`, `assigned-to-me`, `created_by_me`, `assigned_to_me`, `all`
`my_reaction_emoji` Query	String	Return issues reacted by the authenticated user by the given emoji
`confidential` Query	Boolean	Filter confidential or public issues
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`cursor` Query	String	Cursor for obtaining the next set of records

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIssue
`400`	Bad Request	—
`404`	Not Found	—

Create an issue

POST /api/v4/projects/{id}/issues

Creates an issue for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (application/json)

Property	Type	Description
`add_labels`	Array of strings	Comma-separated list of label names
`assignee_id`	Integer	[Deprecated] The ID of a user to assign issue
`assignee_ids`	Array of integers	The array of user IDs to assign issue
`confidential`	Boolean	Boolean parameter if the issue should be confidential
`created_at`	String (date-time)	Date time when the issue was created. Available only for admins and project owners
`description`	String	The description of an issue
`discussion_locked`	Boolean	Boolean parameter indicating if the issue’s discussion is locked
`discussion_to_resolve`	String	The ID of a discussion to resolve, also pass `merge_request_to_resolve_discussions_of`
`due_date`	String	Date string in the format YEAR-MONTH-DAY
`iid`	Integer	The internal ID of a project issue. Available only for admins and project owners
`issue_type`	String	The type of the issue. Accepts: issue, incident, test_case, requirement, task, ticket Allowed values: `issue`, `incident`, `test_case`, `requirement`, `task`, `ticket`
`labels`	Array of strings	Comma-separated list of label names
`merge_request_to_resolve_discussions_of`	Integer	The IID of a merge request for which to resolve discussions
`milestone`	String	The title of a project or ancestor-group milestone to assign the issue to. Mutually exclusive with `milestone_id` Maximum length: `255`
`milestone_id`	Integer	The ID of a milestone to assign issue. Mutually exclusive with `milestone`
`remove_labels`	Array of strings	Comma-separated list of label names
`severity`	String	The severity of the issue. Only applies to incidents. Accepts: unknown, low, medium, high, critical Allowed values: `unknown`, `low`, `medium`, `high`, `critical`
`start_date`	String	Date string in the format YEAR-MONTH-DAY
`title` Required	String	The title of an issue

Responses

Code	Description	Schema
`201`	Created	APIEntitiesIssue
`400`	Bad Request	—
`404`	Not Found	—

Retrieve a project issue

GET /api/v4/projects/{id}/issues/{issue_iid}

Retrieves a specified issue for a project. If the project is private or the issue is confidential, you need to provide credentials to authorize. In most cases, you should authenticate with a personal access token.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`issue_iid` Path, required	Integer	The internal ID of a project issue

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIssue
`400`	Bad Request	—
`404`	Not Found	—

Update an issue

PUT /api/v4/projects/{id}/issues/{issue_iid}

Updates a specified issue for a project. This request is also used to close or reopen an issue using the state_event parameter. At least one of the following parameters is required for the request to be successful: assignee_id, assignee_ids, confidential, created_at, description, discussion_locked, due_date, issue_type, labels, milestone_id, state_event, title.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`issue_iid` Path, required	Integer	The internal ID of a project issue

Request body (application/json)

Property	Type	Description
`add_labels`	Array of strings	Comma-separated list of label names
`assignee_id`	Integer	[Deprecated] The ID of a user to assign issue
`assignee_ids`	Array of integers	The array of user IDs to assign issue
`confidential`	Boolean	Boolean parameter if the issue should be confidential
`created_at`	String	—
`description`	String	The description of an issue
`discussion_locked`	Boolean	Boolean parameter indicating if the issue’s discussion is locked
`due_date`	String	Date string in the format YEAR-MONTH-DAY
`issue_type`	String	The type of the issue. Accepts: issue, incident, test_case, requirement, task, ticket Allowed values: `issue`, `incident`, `test_case`, `requirement`, `task`, `ticket`
`labels`	Array of strings	Comma-separated list of label names
`milestone`	String	The title of a project or ancestor-group milestone to assign the issue to. Mutually exclusive with `milestone_id` Maximum length: `255`
`milestone_id`	Integer	The ID of a milestone to assign issue. Mutually exclusive with `milestone`
`remove_labels`	Array of strings	Comma-separated list of label names
`severity`	String	The severity of the issue. Only applies to incidents. Accepts: unknown, low, medium, high, critical Allowed values: `unknown`, `low`, `medium`, `high`, `critical`
`start_date`	String	Date string in the format YEAR-MONTH-DAY
`state_event`	String	State of the issue Allowed values: `reopen`, `close`
`title`	String	The title of an issue
`updated_at`	String (date-time)	Date time when the issue was updated. Available only for admins and project owners

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIssue
`400`	Bad Request	—
`404`	Not Found	—

Delete an issue

DELETE /api/v4/projects/{id}/issues/{issue_iid}

Deletes a specified issue.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`issue_iid` Path, required	Integer	The internal ID of a project issue

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`404`	Not Found	—

Clone an issue

POST /api/v4/projects/{id}/issues/{issue_iid}/clone

Clones a specified issue to a project. Copies as much data as possible as long as the target project contains equivalent criteria, such as labels or milestones. If you have insufficient permissions, an error message with status code 400 is returned.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`issue_iid` Path, required	Integer	The internal ID of a project issue

Request body (application/json)

Property	Type	Description
`to_project_id` Required	Integer	The ID of the new project
`with_notes`	Boolean	Clone issue with notes Default: `false`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesIssue
`400`	Bad Request	—
`404`	Not Found	—

List all merge requests that close an issue on merge

GET /api/v4/projects/{id}/issues/{issue_iid}/closed_by

Lists all merge requests that close a specified issue when merged. If the project is private or the issue is confidential, you need to provide credentials to authorize. In most cases, you should authenticate with a personal access token.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`issue_iid` Path, required	Integer	The internal ID of a project issue

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMergeRequestBasic
`400`	Bad Request	—
`404`	Not Found	—

Move an issue

POST /api/v4/projects/{id}/issues/{issue_iid}/move

Moves a specified issue to a different project. If the target project is the source project or the user has insufficient permissions, an error message with status code 400 is returned. If a label or milestone with the same name also exists in the target project, it is then assigned to the issue being moved.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`issue_iid` Path, required	Integer	The internal ID of a project issue

Request body (application/json)

Property	Type	Description
`to_project_id` Required	Integer	The ID of the new project

Responses

Code	Description	Schema
`201`	Created	APIEntitiesIssue
`400`	Bad Request	—
`404`	Not Found	—

Update the order of an issue

PUT /api/v4/projects/{id}/issues/{issue_iid}/reorder

Updates the order of a specified issue in a project. You can see the results when sorting issues manually.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`issue_iid` Path, required	Integer	The internal ID of a project issue

Request body (application/json)

Property	Type	Description
`move_after_id`	Integer	The ID of the issue we want to be after
`move_before_id`	Integer	The ID of the issue we want to be before

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIssue
`400`	Bad Request	—
`404`	Not Found	—

Retrieve issues statistics for a project

GET /api/v4/projects/{id}/issues_statistics

Retrieves statistics for issues in a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`labels` Query	Array of strings	Comma-separated list of label names
`milestone` Query	String	Milestone title. Mutually exclusive with `milestone_id`
`milestone_id` Query	String	Return issues assigned to milestones with the specified timebox value (“Any”, “None”, “Upcoming” or “Started”). Mutually exclusive with `milestone` Allowed values: `Any`, `None`, `Upcoming`, `Started`
`iids` Query	Array of integers	The IID array of issues
`search` Query	String	Search issues for text present in the title, description, or any combination of these
`in` Query	String	`title`, `description`, or a string joining them with comma
`author_id` Query	Integer	Return issues which are authored by the user with the given ID. Mutually exclusive with `author_username`
`author_username` Query	String	Return issues which are authored by the user with the given username. Mutually exclusive with `author_id`
`assignee_id` Query	Integer or string	Return issues which are assigned to the user with the given ID. Mutually exclusive with `assignee_username`
`assignee_username` Query	Array of strings	Return issues which are assigned to the user with the given username. Mutually exclusive with `assignee_id`
`created_after` Query	String (date-time)	Return issues created after the specified time
`created_before` Query	String (date-time)	Return issues created before the specified time
`updated_after` Query	String (date-time)	Return issues updated after the specified time
`updated_before` Query	String (date-time)	Return issues updated before the specified time
`not` Query	Object	Filters by the specified parameters
`not[labels]` Query	Array of strings	Comma-separated list of label names
`not[milestone]` Query	String	Milestone title. Mutually exclusive with `not[milestone_id]`
`not[milestone_id]` Query	String	Return issues assigned to milestones without the specified timebox value (“Any”, “None”, “Upcoming” or “Started”). Mutually exclusive with `not[milestone]` Allowed values: `Any`, `None`, `Upcoming`, `Started`
`not[iids]` Query	Array of integers	The IID array of issues
`not[author_id]` Query	Integer	Return issues which are not authored by the user with the given ID. Mutually exclusive with `not[author_username]`
`not[author_username]` Query	String	Return issues which are not authored by the user with the given username. Mutually exclusive with `not[author_id]`
`not[assignee_id]` Query	Integer	Return issues which are not assigned to the user with the given ID. Mutually exclusive with `not[assignee_username]`
`not[assignee_username]` Query	Array of strings	Return issues which are not assigned to the user with the given username. Mutually exclusive with `not[assignee_id]`
`scope` Query	String	Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all` Allowed values: `created-by-me`, `assigned-to-me`, `created_by_me`, `assigned_to_me`, `all`
`my_reaction_emoji` Query	String	Return issues reacted by the authenticated user by the given emoji
`confidential` Query	Boolean	Filter confidential or public issues

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not Found	—

Retrieve programming language usage information

GET /api/v4/projects/{id}/languages

Retrieves information about all programming languages used in a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not found	—

List all package protection rules

GET /api/v4/projects/{id}/packages/protection/rules

Lists all package protection rules for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProjectsPackagesProtectionRule
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

Create a package protection rule

POST /api/v4/projects/{id}/packages/protection/rules

Creates a package protection rule for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (application/json)

Property	Type	Description
`minimum_access_level_for_delete`	String	Minimum GitLab access level required to delete a package. Valid values include `null`, `owner` or `admin`. If the value is `null`, the default minimum access level is `maintainer`. Must be provided when `minimum_access_level_for_push` is not set. Behind a feature flag named `packages_protected_packages_delete`. Disabled by default Allowed values: `owner`, `admin`
`minimum_access_level_for_push`	String	Minimum GitLab access level required to push a package. Valid values include `null`, `maintainer`, `owner` or `admin`. If the value is `null`, the default minimum access level is `developer`. Must be provided when `minimum_access_level_for_delete` is not set Allowed values: `maintainer`, `owner`, `admin`
`package_name_pattern` Required	String	Package name protected by the rule. For example @my-scope/my-package-. Wildcard character allowed
`package_type` Required	String	Package type protected by the rule. For example npm Allowed values: `cargo`, `conan`, `generic`, `helm`, `maven`, `npm`, `nuget`, `pypi`, `terraform_module` Minimum length: `1`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProjectsPackagesProtectionRule
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

Update a package protection rule

PATCH /api/v4/projects/{id}/packages/protection/rules/{package_protection_rule_id}

Updates a package protection rule for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`package_protection_rule_id` Path, required	Integer	The ID of the package protection rule

Request body (application/json)

Property	Type	Description
`minimum_access_level_for_delete`	String	Minimum GitLab access level required to delete a package. Valid values include `null`, `owner` or `admin`. If the value is `null`, the default minimum access level is `maintainer`. Must be provided when `minimum_access_level_for_push` is not set. Behind a feature flag named `packages_protected_packages_delete`. Disabled by default Allowed values: `owner`, `admin`
`minimum_access_level_for_push`	String	Minimum GitLab access level required to push a package. Valid values include `null`, `maintainer`, `owner` or `admin`. If the value is `null`, the default minimum access level is `developer`. Must be provided when `minimum_access_level_for_delete` is not set Allowed values: `maintainer`, `owner`, `admin`
`package_name_pattern`	String	Package name protected by the rule. For example @my-scope/my-package-. Wildcard character allowed
`package_type`	String	Package type protected by the rule. For example npm Allowed values: `cargo`, `conan`, `generic`, `helm`, `maven`, `npm`, `nuget`, `pypi`, `terraform_module`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProjectsPackagesProtectionRule
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

Delete a package protection rule

DELETE /api/v4/projects/{id}/packages/protection/rules/{package_protection_rule_id}

Deletes a package protection rule from a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`package_protection_rule_id` Path, required	Integer	The ID of the package protection rule

Responses

Code	Description	Schema
`204`	204 No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

Check pages access of this project

GET /api/v4/projects/{id}/pages_access

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not Found	—

List all container repository protection rules

GET /api/v4/projects/{id}/registry/protection/repository/rules

Lists all container repository protection rules for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProjectsContainerRegistryProtectionRule
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

Create a container repository protection rule

POST /api/v4/projects/{id}/registry/protection/repository/rules

Creates a container repository protection rule for a specified project to control who can push or delete container images.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (application/json)

Property	Type	Description
`minimum_access_level_for_delete`	String	Minimum GitLab access level to allow to delete container images in the container registry. For example maintainer, owner or admin Allowed values: `maintainer`, `owner`, `admin`
`minimum_access_level_for_push`	String	Minimum GitLab access level to allow to push container images to the container registry. For example maintainer, owner or admin Allowed values: `maintainer`, `owner`, `admin`
`repository_path_pattern` Required	String	Container repository path pattern protected by the protection rule. For example `flight/flight-`. Wildcard character `` allowed

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProjectsContainerRegistryProtectionRule
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

Update a container repository protection rule

PATCH /api/v4/projects/{id}/registry/protection/repository/rules/{protection_rule_id}

Updates a container repository protection rule for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`protection_rule_id` Path, required	Integer	The ID of the container protection rule

Request body (application/json)

Property	Type	Description
`minimum_access_level_for_delete`	String	Minimum GitLab access level to allow to delete container images in the container registry. For example maintainer, owner or admin. To unset the value, use an empty string `""` Allowed values: `maintainer`, `owner`, `admin`, ``
`minimum_access_level_for_push`	String	Minimum GitLab access level to allow to push container images to the container registry. For example maintainer, owner or admin. To unset the value, use an empty string `""` Allowed values: `maintainer`, `owner`, `admin`, ``
`repository_path_pattern`	String	Container repository path pattern protected by the protection rule. For example `flight/flight-`. Wildcard character `` allowed

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProjectsContainerRegistryProtectionRule
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

Delete a container repository protection rule

DELETE /api/v4/projects/{id}/registry/protection/repository/rules/{protection_rule_id}

Deletes a specified container repository protection rule.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`protection_rule_id` Path, required	Integer	The ID of the container protection rule

Responses

Code	Description	Schema
`204`	204 No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

List all container registry protection tag rules

GET /api/v4/projects/{id}/registry/protection/tag/rules

Lists all container registry protection tag rules for a project. This feature was introduced in GitLab 18.7.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProjectsContainerRegistryProtectionTagRule
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

Create a container registry protection tag rule

POST /api/v4/projects/{id}/registry/protection/tag/rules

Creates a container registry protection tag rule for a project to control who can push or delete container tags. This feature was introduced in GitLab 18.8.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (application/json)

Property	Type	Description
`minimum_access_level_for_delete` Required	String	Minimum GitLab access level required to delete container tags. For example, Maintainer, Owner, or Admin Allowed values: `maintainer`, `owner`, `admin` Minimum length: `1`
`minimum_access_level_for_push` Required	String	Minimum GitLab access level required to push container tags. For example, Maintainer, Owner, or Admin Allowed values: `maintainer`, `owner`, `admin` Minimum length: `1`
`tag_name_pattern` Required	String	Container tag name pattern protected by the protection rule. For example, `v-release`. Wildcard character `` allowed

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProjectsContainerRegistryProtectionTagRule
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

Update a container registry protection tag rule

PATCH /api/v4/projects/{id}/registry/protection/tag/rules/{protection_rule_id}

Updates a container registry protection tag rule for a project. This feature was introduced in GitLab 18.9.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`protection_rule_id` Path, required	Integer	The ID of the container protection tag rule

Request body (application/json)

Property	Type	Description
`minimum_access_level_for_delete`	String	Minimum GitLab access level required to delete container tags. For example, Maintainer, Owner, or Admin. To unset the value, use an empty string (`""`) Allowed values: `maintainer`, `owner`, `admin`, ``
`minimum_access_level_for_push`	String	Minimum GitLab access level required to push container tags. For example, Maintainer, Owner, or Admin. To unset the value, use an empty string (`""`) Allowed values: `maintainer`, `owner`, `admin`, ``
`tag_name_pattern`	String	Container tag name pattern protected by the protection rule. For example, `v-release`. Wildcard character `` allowed

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProjectsContainerRegistryProtectionTagRule
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

Delete a container registry protection tag rule

DELETE /api/v4/projects/{id}/registry/protection/tag/rules/{protection_rule_id}

Deletes a container registry protection tag rule from a project. This feature was introduced in GitLab 18.9.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`protection_rule_id` Path, required	Integer	The ID of the container protection tag rule

Responses

Code	Description	Schema
`204`	Delete a container protection tag rule	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

Start a task to recalculate repository size for a project

POST /api/v4/projects/{id}/repository_size

This feature was introduced in GitLab 15.0.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Unauthenticated	—
`404`	Not Found	—

Restore a project marked for deletion

POST /api/v4/projects/{id}/restore

Restores a specified project that was marked for deletion.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProject
`400`	Bad Request	—
`404`	Not Found	—

List all runners for a project

GET /api/v4/projects/{id}/runners

List all runners available in the project, including from ancestor groups and any allowed shared runners.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user
`scope` Query	String	Deprecated: Use `type` or `status` instead. The scope of runners to return Allowed values: `specific`, `shared`, `instance_type`, `group_type`, `project_type`, `active`, `paused`, `online`, `offline`, `never_contacted`, `stale`
`type` Query	String	The type of runners to return Allowed values: `instance_type`, `group_type`, `project_type`
`paused` Query	Boolean	Whether to include only runners that are accepting or ignoring new jobs
`status` Query	String	The status of runners to return Allowed values: `active`, `paused`, `online`, `offline`, `never_contacted`, `stale`
`tag_list` Query	Array of strings	A list of runner tags Example: `["macos","shell"]`
`version_prefix` Query	String	The version prefix of runners to return Pattern: `(?<=^\|\n(?!$))[\d+.]+` Example: `15.1.`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiRunner
`400`	Scope contains invalid value	—
`403`	No access granted	—
`404`	Not Found	—

Assign a runner to a project

POST /api/v4/projects/{id}/runners

Assigns an available project runner to a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user

Request body (application/json)

Property	Type	Description
`runner_id` Required	Integer	The ID of a runner

Responses

Code	Description	Schema
`201`	Created	APIEntitiesCiRunner
`400`	Bad Request	—
`403`	Runner is locked	—
`404`	Runner not found	—

Reset runner registration token

POST /api/v4/projects/{id}/runners/reset_registration_token

FE version

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a project

Responses

Code	Description	Schema
`201`	Created	APIEntitiesCiResetTokenResult
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Project Not Found	—

Unassign a runner from a project

DELETE /api/v4/projects/{id}/runners/{runner_id}

Unassigns a specified project runner from a project. You cannot unassign a runner from the owner project. Use the delete a runner operation instead.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user
`runner_id` Path, required	Integer	The ID of a runner

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiRunner
`400`	Bad Request	—
`403`	You cannot unassign a runner from the owner project. Delete the runner instead	—
`404`	Runner not found	—
`412`	Precondition Failed	—

POST /api/v4/projects/{id}/share

Shares a specified project with a group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (application/json)

Property	Type	Description
`expires_at`	String (date)	Share expiration date
`group_access` Required	Integer	The group access level Allowed values: `10`, `15`, `20`, `25`, `30`, `40`, `50`
`group_id` Required	Integer	The ID of a group Example: `1`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProjectGroupLink
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

Delete a shared project link in a group

DELETE /api/v4/projects/{id}/share/{group_id}

Deletes a shared project link in a group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`group_id` Path, required	Integer	The ID of the group

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad request	—
`404`	Not found	—

List all groups available to invite to a project

GET /api/v4/projects/{id}/share_locations

Lists all groups that can be invited to a project.

Parameters

Name	Type	Description
`id` Path, required	Integer	The id of the project
`search` Query	String	Return list of groups matching the search criteria

Responses

Code	Description	Schema
`200`	OK	APIEntitiesGroup
`400`	Bad Request	—
`404`	Not Found	—

Star a project

POST /api/v4/projects/{id}/star

Stars a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProject
`304`	Not modified	—
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not Found	—

List all users who starred a project

GET /api/v4/projects/{id}/starrers

Lists all users who starred a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`search` Query	String	Return list of users matching the search criteria Example: `user`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesUserBasic
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not found	—

Retrieve the statistics of the last 30 days

GET /api/v4/projects/{id}/statistics

Retrieves the clone and pull statistics for the last 30 days from a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProjectDailyStatistics
`400`	Bad Request	—
`401`	401 Unauthorized	—
`404`	404 Project Not Found	—

Retrieve the path to repository storage

GET /api/v4/projects/{id}/storage

Retrieves the path to repository storage for a specified project. If you are using Gitaly Cluster (Praefect), see Praefect-generated replica paths instead. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	String	ID of a project

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProjectRepositoryStorage
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not Found	—

List all Terraform state protection rules for a project

GET /api/v4/projects/{id}/terraform/state_protection_rules

Lists all Terraform state protection rules for a project. This feature was introduced in GitLab 18.11.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`200`	OK	APIEntitiesTerraformStateProtectionRule
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

Create a Terraform state protection rule for a project

POST /api/v4/projects/{id}/terraform/state_protection_rules

This feature was introduced in GitLab 19.1.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (application/json)

Property	Type	Description
`allowed_from`	String	Source restriction for write requests. Default: anywhere. Valid values: anywhere, ci_only, ci_on_protected_branch_only Allowed values: `anywhere`, `ci_only`, `ci_on_protected_branch_only`
`minimum_access_level_for_write` Required	String	Minimum GitLab access level required to write to the Terraform state. Valid values: developer, maintainer, owner, admin Allowed values: `developer`, `maintainer`, `owner`, `admin` Minimum length: `1`
`state_name` Required	String	Terraform state name to protect. Maximum 255 characters. Must be unique per project Maximum length: `255`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesTerraformStateProtectionRule
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

Update a Terraform state protection rule for a project

PATCH /api/v4/projects/{id}/terraform/state_protection_rules/{terraform_state_protection_rule_id}

This feature was introduced in GitLab 19.0.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`terraform_state_protection_rule_id` Path, required	Integer	The ID of the Terraform state protection rule

Request body (application/json)

Property	Type	Description
`allowed_from`	String	If defined, write requests must be made from the specific source Allowed values: `anywhere`, `ci_only`, `ci_on_protected_branch_only`
`minimum_access_level_for_write`	String	If defined, sets the minimum GitLab access level required to write to the Terraform state Allowed values: `developer`, `maintainer`, `owner`, `admin`
`state_name`	String	Terraform state name to protect

Responses

Code	Description	Schema
`200`	OK	APIEntitiesTerraformStateProtectionRule
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

Delete a Terraform state protection rule

DELETE /api/v4/projects/{id}/terraform/state_protection_rules/{terraform_state_protection_rule_id}

This feature was introduced in GitLab 19.0.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`terraform_state_protection_rule_id` Path, required	Integer	The ID of the Terraform state protection rule

Responses

Code	Description	Schema
`204`	204 No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

Transfer a project to another namespace

PUT /api/v4/projects/{id}/transfer

Transfers a project to another namespace.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (application/json)

Property	Type	Description
`namespace` Required	String	The ID or path of the new namespace Example: `gitlab`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProject
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

List all transferable namespaces for a project

GET /api/v4/projects/{id}/transfer_locations

Lists all namespaces where a specified project can be transferred.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`search` Query	String	Return list of namespaces matching the search criteria Example: `search`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesPublicGroupDetails
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not Found	—

Unarchive a project

POST /api/v4/projects/{id}/unarchive

Unarchives a specified project. You must be an administrator or have the Owner role on the project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProject
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not Found	—

Unstar a project

POST /api/v4/projects/{id}/unstar

Unstars a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProject
`304`	Not modified	—
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not Found	—

List all uploads

GET /api/v4/projects/{id}/uploads

Lists all uploads of a project sorted by created_at in descending order. You must have the Maintainer or Owner role for the project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMarkdownUploadAdmin
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not found	—

Create an upload

POST /api/v4/projects/{id}/uploads

Creates an upload.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (multipart/form-data)

Property	Type	Description
`file` Required	String (binary)	The attachment file to be uploaded

Responses

Code	Description	Schema
`201`	Created	APIEntitiesProjectUpload
`400`	Bad Request	—
`404`	Not found	—

Workhorse authorize the file upload

POST /api/v4/projects/{id}/uploads/authorize

This feature was introduced in GitLab 13.11

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not found	—

Download an uploaded file by secret and filename

GET /api/v4/projects/{id}/uploads/{secret}/{filename}

Downloads an uploaded file with a specified secret and filename. You must have the Guest, Planner, Reporter, Developer, Maintainer, or Owner role for the project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`secret` Path, required	String	The 32-character secret of a project upload
`filename` Path, required	String	The filename of a project upload

Responses

Code	Description	Schema
`200`	OK	String (binary) (`application/octet-stream`)
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not found	—

Delete an uploaded file by secret and filename

DELETE /api/v4/projects/{id}/uploads/{secret}/{filename}

Deletes an uploaded file with a specified secret and filename. You must have the Maintainer or Owner role for the project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`secret` Path, required	String	The 32-character secret of a project upload
`filename` Path, required	String	The filename of a project upload

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

Download an uploaded file by ID

GET /api/v4/projects/{id}/uploads/{upload_id}

Downloads an uploaded file with a specified ID. You must have the Maintainer or Owner role for the project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`upload_id` Path, required	Integer	The ID of a project upload

Responses

Code	Description	Schema
`200`	OK	String (binary) (`application/octet-stream`)
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not found	—

Delete an uploaded file by ID

DELETE /api/v4/projects/{id}/uploads/{upload_id}

Deletes an uploaded file with a specified ID. You must have the Maintainer or Owner role for the project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`upload_id` Path, required	Integer	The ID of a project upload

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

List all members of a project

GET /api/v4/projects/{id}/users

Lists all members with access to a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`search` Query	String	Return list of users matching the search criteria Example: `user`
`skip_users` Query	Array of integers	Filter out users with the specified IDs
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesUserBasic
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not found	—

Get projects associated with a runner

GET /api/v4/runners/{id}/projects

Get a paginated list of all projects associated with the specified runner. Access is restricted based on user permissions.

Parameters

Name	Type	Description
`id` Path, required	Integer	The ID of a runner
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesBasicProjectDetails
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	No access granted	—
`404`	Runner not found	—

List all projects contributions for a user

GET /api/v4/users/{user_id}/contributed_projects

Lists all contributions to visible projects for a specified user. Returns only contributions in the past year.

Parameters

Name	Type	Description
`user_id` Path, required	String	The ID or username of the user
`order_by` Query	String	Return projects ordered by field. storage_size, repository_size, wiki_size, packages_size are only available to admins. Similarity is available when searching and is limited to projects the user has access to Allowed values: `id`, `name`, `path`, `created_at`, `updated_at`, `last_activity_at`, `similarity`, `star_count`, `storage_size`, `repository_size`, `wiki_size`, `packages_size` Default: `created_at`
`sort` Query	String	Return projects sorted in ascending and descending order Allowed values: `asc`, `desc` Default: `desc`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`simple` Query	Boolean	Return only the ID, URL, name, and path of each project Default: `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesBasicProjectDetails
`400`	Bad Request	—
`404`	404 User Not Found	—

List all personal projects for a user

GET /api/v4/users/{user_id}/projects

Lists all personal projects for a specified user. Does not return group or subgroup projects. If the user profile is private, returns only an empty list.

Parameters

Name	Type	Description
`user_id` Path, required	String	The ID or username of the user
`order_by` Query	String	Return projects ordered by field. storage_size, repository_size, wiki_size, packages_size are only available to admins. Similarity is available when searching and is limited to projects the user has access to Allowed values: `id`, `name`, `path`, `created_at`, `updated_at`, `last_activity_at`, `similarity`, `star_count`, `storage_size`, `repository_size`, `wiki_size`, `packages_size` Default: `created_at`
`sort` Query	String	Return projects sorted in ascending and descending order Allowed values: `asc`, `desc` Default: `desc`
`archived` Query	Boolean	Limit by archived status
`visibility` Query	String	Limit by visibility Allowed values: `private`, `internal`, `public`
`search` Query	String	Return list of projects matching the search criteria
`search_namespaces` Query	Boolean	Include ancestor namespaces when matching search criteria
`owned` Query	Boolean	Limit by owned by authenticated user Default: `false`
`starred` Query	Boolean	Limit by starred status Default: `false`
`imported` Query	Boolean	Limit by imported by authenticated user Default: `false`
`membership` Query	Boolean	Limit by projects that the current user is a member of Default: `false`
`with_issues_enabled` Query	Boolean	Limit by enabled issues feature Default: `false`
`with_merge_requests_enabled` Query	Boolean	Limit by enabled merge requests feature Default: `false`
`with_programming_language` Query	String	Limit to repositories which use the given programming language
`min_access_level` Query	Integer	Limit by minimum access level of authenticated user Allowed values: `10`, `15`, `20`, `25`, `30`, `40`, `50`
`id_after` Query	Integer	Limit results to projects with IDs greater than the specified ID
`id_before` Query	Integer	Limit results to projects with IDs less than the specified ID
`last_activity_after` Query	String (date-time)	Limit results to projects with last_activity after specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`last_activity_before` Query	String (date-time)	Limit results to projects with last_activity before specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`repository_storage` Query	String	Which storage shard the repository is on. Available only to admins
`topic` Query	Array of strings	Comma-separated list of topics. Limit results to projects having all topics
`topic_id` Query	Integer	Limit results to projects with the assigned topic given by the topic ID
`updated_before` Query	String (date-time)	Return projects updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`updated_after` Query	String (date-time)	Return projects updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`include_pending_delete` Query	Boolean	Include projects in pending delete state. Can only be set by admins
`marked_for_deletion_on` Query	String (date)	Date when the project was marked for deletion
`active` Query	Boolean	Limit by projects that are not archived and not marked for deletion
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`simple` Query	Boolean	Return only the ID, URL, name, and path of each project Default: `false`
`statistics` Query	Boolean	Include project statistics Default: `false`
`with_custom_attributes` Query	Boolean	Include custom attributes in the response Default: `false`
`custom_attributes` Query	Object	Filter with custom attributes

Responses

Code	Description	Schema
`200`	OK	APIEntitiesBasicProjectDetails
`400`	Bad Request	—
`404`	404 User Not Found	—

List all projects starred by a user

GET /api/v4/users/{user_id}/starred_projects

Lists all visible projects starred by a specified user. Unauthenticated requests return only public projects.

Parameters

Name	Type	Description
`user_id` Path, required	String	The ID or username of the user
`order_by` Query	String	Return projects ordered by field. storage_size, repository_size, wiki_size, packages_size are only available to admins. Similarity is available when searching and is limited to projects the user has access to Allowed values: `id`, `name`, `path`, `created_at`, `updated_at`, `last_activity_at`, `similarity`, `star_count`, `storage_size`, `repository_size`, `wiki_size`, `packages_size` Default: `created_at`
`sort` Query	String	Return projects sorted in ascending and descending order Allowed values: `asc`, `desc` Default: `desc`
`archived` Query	Boolean	Limit by archived status
`visibility` Query	String	Limit by visibility Allowed values: `private`, `internal`, `public`
`search` Query	String	Return list of projects matching the search criteria
`search_namespaces` Query	Boolean	Include ancestor namespaces when matching search criteria
`owned` Query	Boolean	Limit by owned by authenticated user Default: `false`
`starred` Query	Boolean	Limit by starred status Default: `false`
`imported` Query	Boolean	Limit by imported by authenticated user Default: `false`
`membership` Query	Boolean	Limit by projects that the current user is a member of Default: `false`
`with_issues_enabled` Query	Boolean	Limit by enabled issues feature Default: `false`
`with_merge_requests_enabled` Query	Boolean	Limit by enabled merge requests feature Default: `false`
`with_programming_language` Query	String	Limit to repositories which use the given programming language
`min_access_level` Query	Integer	Limit by minimum access level of authenticated user Allowed values: `10`, `15`, `20`, `25`, `30`, `40`, `50`
`id_after` Query	Integer	Limit results to projects with IDs greater than the specified ID
`id_before` Query	Integer	Limit results to projects with IDs less than the specified ID
`last_activity_after` Query	String (date-time)	Limit results to projects with last_activity after specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`last_activity_before` Query	String (date-time)	Limit results to projects with last_activity before specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`repository_storage` Query	String	Which storage shard the repository is on. Available only to admins
`topic` Query	Array of strings	Comma-separated list of topics. Limit results to projects having all topics
`topic_id` Query	Integer	Limit results to projects with the assigned topic given by the topic ID
`updated_before` Query	String (date-time)	Return projects updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`updated_after` Query	String (date-time)	Return projects updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ
`include_pending_delete` Query	Boolean	Include projects in pending delete state. Can only be set by admins
`marked_for_deletion_on` Query	String (date)	Date when the project was marked for deletion
`active` Query	Boolean	Limit by projects that are not archived and not marked for deletion
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`simple` Query	Boolean	Return only the ID, URL, name, and path of each project Default: `false`
`statistics` Query	Boolean	Include project statistics Default: `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesBasicProjectDetails
`400`	Bad Request	—
`404`	404 User Not Found	—

Validate CODEOWNERS file by project full path

GET /api/v4/validate-code-owner-file

Parameters

Name	Type	Description
`project_path` Query, required	String	—
`ref` Query	String	—
`file_path` Query	String	—

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not found	—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesBasicProjectDetails

Property	Type	Description
`avatar_url`	String	Example: `http://example.com/uploads/project/avatar/3/uploads/avatar.png`
`created_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`custom_attributes`	APIEntitiesCustomAttribute	—
`default_branch`	String	Example: `main`
`description`	String	Example: `desc`
`forks_count`	Integer	Example: `1`
`http_url_to_repo`	String	Example: `https://gitlab.example.com/gitlab/gitlab.git`
`id`	Integer (int64)	Example: `1`
`last_activity_at`	String (date-time)	Example: `2013-09-30T13:46:02Z`
`license`	APIEntitiesLicenseBasic	—
`license_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab/blob/master/LICENCE`
`name`	String	Example: `project1`
`name_with_namespace`	String	Example: `John Doe / project1`
`namespace`	APIEntitiesNamespaceBasic	—
`path`	String	Example: `project1`
`path_with_namespace`	String	Example: `namespace1/project1`
`readme_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab/blob/master/README.md`
`repository_storage`	String	Example: `default`
`ssh_url_to_repo`	String	Example: `git@gitlab.example.com:gitlab/gitlab.git`
`star_count`	Integer	Example: `1`
`tag_list`	Array of strings	Example: `["tag"]`
`topics`	Array of strings	Example: `["topic"]`
`visibility`	String	Example: `public`
`web_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab`

APIEntitiesCiResetTokenResult

Property	Type	Description
`token`	String	—
`token_expires_at`	String	—

APIEntitiesCiRunner

Property	Type	Description
`active`	Boolean	Example: `true`
`created_at`	String (date-time)	Example: `2025-05-03T00:00:00.000Z`
`created_by`	APIEntitiesUserBasic	—
`description`	String	Example: `test-1-20150125`
`id`	Integer (int64)	Example: `8`
`ip_address`	String	Example: `127.0.0.1`
`is_shared`	Boolean	Example: `true`
`job_execution_status`	String	Allowed values: `active`, `idle` Example: `idle`
`name`	String	Example: `test`
`online`	Boolean	Example: `true`
`paused`	Boolean	Example: `false`
`runner_type`	String	Allowed values: `instance_type`, `group_type`, `project_type` Example: `instance_type`
`status`	String	Example: `online`

APIEntitiesContainerExpirationPolicy

Property	Type	Description
`cadence`	String	—
`enabled`	String	—
`keep_n`	String	—
`name_regex`	String	—
`name_regex_keep`	String	—
`next_run_at`	String	—
`older_than`	String	—

APIEntitiesCustomAttribute

Property	Type	Description
`key`	String	Example: `foo`
`value`	String	Example: `bar`

APIEntitiesGroup

Property	Type	Description
`archived`	Boolean	—
`auto_devops_enabled`	String	—
`avatar_url`	String	—
`created_at`	String	—
`crm_enabled`	Boolean	—
`custom_attributes`	APIEntitiesCustomAttribute	—
`default_branch`	String	—
`default_branch_protection`	Integer	—
`default_branch_protection_defaults`	String	—
`description`	String	—
`emails_disabled`	Boolean	—
`emails_enabled`	Boolean	—
`full_name`	String	—
`full_path`	String	—
`id`	Integer (int64)	—
`lfs_enabled`	Boolean	—
`lock_math_rendering_limits_enabled`	Boolean	—
`lock_resource_access_token_notify_inherited`	Boolean	—
`marked_for_deletion_on`	String	—
`math_rendering_limits_enabled`	Boolean	—
`max_artifacts_size`	Integer	—
`mentions_disabled`	String	—
`name`	String	Example: `Diaspora`
`organization_id`	Integer (int64)	—
`parent_id`	String	—
`path`	String	—
`project_creation_level`	String	—
`request_access_enabled`	Boolean	—
`require_two_factor_authentication`	Boolean	—
`resource_access_token_notify_inherited`	Boolean	—
`root_storage_statistics`	APIEntitiesNamespaceRootStorageStatistics	—
`share_with_group_lock`	Boolean	—
`shared_runners_setting`	String	—
`show_diff_preview_in_email`	Boolean	—
`statistics`	Object	—
`statistics.job_artifacts_size`	String	—
`statistics.lfs_objects_size`	String	—
`statistics.packages_size`	String	—
`statistics.pipeline_artifacts_size`	String	—
`statistics.repository_size`	String	—
`statistics.snippets_size`	String	—
`statistics.storage_size`	String	—
`statistics.uploads_size`	String	—
`statistics.wiki_size`	String	—
`subgroup_creation_level`	String	—
`two_factor_grace_period`	Integer	—
`visibility`	String	—
`web_url`	String	Example: `http://gitlab.example.com/groups/diaspora`

APIEntitiesGroupAccess

Property	Type	Description
`access_level`	String	—
`notification_level`	String	—

APIEntitiesIssuableReferences

Property	Type	Description
`full`	String	Example: `test&6`
`relative`	String	Example: `&6`
`short`	String	Example: `&6`

APIEntitiesIssuableTimeStats

Property	Type	Description
`human_time_estimate`	String	Example: `3h 30m`
`human_total_time_spent`	String	Example: `1h`
`time_estimate`	Integer	Example: `12600`
`total_time_spent`	Integer	Example: `3600`

APIEntitiesIssue

Property	Type	Description
`_links`	Object	—
`_links.award_emoji`	String	Example: `http://example.com/api/v4/projects/1/issues/2/award_emoji`
`_links.closed_as_duplicate_of`	String	Example: `http://example.com/api/v4/projects/1/issues/75`
`_links.notes`	String	Example: `http://example.com/api/v4/projects/1/issues/2/notes`
`_links.project`	String	Example: `http://example.com/api/v4/projects/1`
`_links.self`	String	Example: `http://example.com/api/v4/projects/1/issues/2`
`assignee`	APIEntitiesUserBasic	—
`assignees`	APIEntitiesUserBasic	—
`author`	APIEntitiesUserBasic	—
`closed_at`	String (date-time)	Example: `2022-11-15T08:30:55.232Z`
`closed_by`	APIEntitiesUserBasic	—
`confidential`	Boolean	—
`created_at`	String (date-time)	Example: `2022-08-17T12:46:35.053Z`
`description`	String	Example: `Repellendus impedit et vel velit dignissimos.`
`discussion_locked`	Boolean	—
`downvotes`	Integer	—
`due_date`	String (date)	Example: `2022-11-20`
`has_tasks`	Boolean	Example: `true`
`id`	Integer (int64)	Example: `84`
`iid`	Integer	Example: `14`
`imported`	Boolean	Example: `false`
`imported_from`	String	Example: `github`
`issue_type`	String	Example: `issue`
`labels`	Array of strings	Example: `["bug"]`
`merge_requests_count`	Integer	—
`milestone`	APIEntitiesMilestone	—
`moved_to_id`	Integer (int64)	Example: `1`
`project_id`	Integer (int64)	Example: `4`
`references`	APIEntitiesIssuableReferences	—
`service_desk_reply_to`	String	Example: `user@example.com`
`severity`	String	One of [“UNKNOWN”, “LOW”, “MEDIUM”, “HIGH”, “CRITICAL”]
`start_date`	String (date)	Example: `2022-11-18`
`state`	String	Example: `closed`
`subscribed`	Boolean	Example: `false`
`task_completion_status`	APIEntitiesTaskCompletionStatus	—
`task_status`	String	Example: `2 of 4 tasks completed`
`time_stats`	APIEntitiesIssuableTimeStats	—
`title`	String	Example: `Impedit et ut et dolores vero provident ullam est`
`type`	String	One of [“ISSUE”, “INCIDENT”, “TEST_CASE”, “REQUIREMENT”, “TASK”, “TICKET”] Example: `ISSUE`
`updated_at`	String (date-time)	Example: `2022-11-14T17:22:01.470Z`
`upvotes`	Integer	—
`user_notes_count`	Integer	—
`web_url`	String	Example: `http://example.com/example/example/issues/14`

APIEntitiesLicenseBasic

Property	Type	Description
`html_url`	String	Example: `http://choosealicense.com/licenses/gpl-3.0`
`key`	String	Example: `gpl-3.0`
`name`	String	Example: `GNU General Public License v3.0`
`nickname`	String	Example: `GNU GPLv3`
`source_url`	String	—

APIEntitiesMarkdownUploadAdmin

Property	Type	Description
`created_at`	String (date-time)	Example: `2012-06-28T10:52:04Z`
`filename`	String	Example: `image.png`
`id`	Integer (int64)	Example: `1`
`size`	Integer	Example: `1024`
`uploaded_by`	APIEntitiesUserSafe	—

APIEntitiesMergeRequestBasic

Property	Type	Description
`allow_collaboration`	Boolean	—
`allow_maintainer_to_push`	Boolean	—
`assignee`	APIEntitiesUserBasic	—
`assignees`	APIEntitiesUserBasic	—
`author`	APIEntitiesUserBasic	—
`blocking_discussions_resolved`	Boolean	—
`closed_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`closed_by`	APIEntitiesUserBasic	—
`created_at`	String (date-time)	Example: `2022-08-17T12:46:35.053Z`
`description`	String	Example: `Repellendus impedit et vel velit dignissimos.`
`description_html`	String	—
`detailed_merge_status`	String	Example: `mergeable`
`discussion_locked`	Boolean	—
`downvotes`	Integer	—
`draft`	Boolean	—
`force_remove_source_branch`	Boolean	—
`has_conflicts`	Boolean	—
`id`	Integer (int64)	Example: `84`
`iid`	Integer	Example: `14`
`imported`	Boolean	—
`imported_from`	String	Example: `bitbucket`
`labels`	Array of strings	—
`merge_after`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`merge_commit_sha`	String	Example: `1234abcd`
`merge_status`	String	Example: `unchecked`
`merge_user`	APIEntitiesUserBasic	—
`merge_when_pipeline_succeeds`	Boolean	—
`merged_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`merged_by`	APIEntitiesUserBasic	—
`milestone`	APIEntitiesMilestone	—
`prepared_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`project_id`	Integer (int64)	Example: `4`
`reference`	String	Example: `!1`
`references`	APIEntitiesIssuableReferences	—
`reviewers`	APIEntitiesUserBasic	—
`sha`	String	Example: `1234abcd`
`should_remove_source_branch`	Boolean	—
`source_branch`	String	—
`source_project_id`	Integer (int64)	—
`squash`	Boolean	—
`squash_commit_sha`	String	Example: `1234abcd`
`squash_on_merge`	Boolean	—
`state`	String	Example: `closed`
`target_branch`	String	—
`target_project_id`	Integer (int64)	—
`task_completion_status`	APIEntitiesTaskCompletionStatus	—
`time_stats`	APIEntitiesIssuableTimeStats	—
`title`	String	Example: `Impedit et ut et dolores vero provident ullam est`
`title_html`	String	—
`updated_at`	String (date-time)	Example: `2022-11-14T17:22:01.470Z`
`upvotes`	Integer	—
`user_notes_count`	Integer	—
`web_url`	String	Example: `https://gitlab.example.com/my-group/my-project/-/merge_requests/1`
`work_in_progress`	Boolean	—

APIEntitiesMilestone

Property	Type	Description
`created_at`	String	—
`description`	String	—
`due_date`	String	—
`expired`	Boolean	—
`group_id`	String	—
`id`	Integer (int64)	—
`iid`	Integer (int64)	—
`project_id`	Integer (int64)	—
`start_date`	String	—
`state`	String	—
`title`	String	—
`updated_at`	String	—
`web_url`	String	—

APIEntitiesNamespaceBasic

Property	Type	Description
`avatar_url`	String	Example: `https://example.com/avatar/12345`
`full_path`	String	Example: `group/my_project`
`id`	Integer (int64)	Example: `2`
`kind`	String	Example: `project`
`name`	String	Example: `project`
`parent_id`	Integer (int64)	Example: `1`
`path`	String	Example: `my_project`
`web_url`	String	Example: `https://example.com/group/my_project`

APIEntitiesNamespaceRootStorageStatistics

Property	Type	Description
`build_artifacts_size`	Integer	CI artifacts size in bytes
`container_registry_size`	Integer	container registry size in bytes
`container_registry_size_is_estimated`	Boolean	Indicates whether the deduplicated container registry size for the namespace is an estimated value or not
`dependency_proxy_size`	Integer	Dependency Proxy sizes in bytes
`lfs_objects_size`	Integer	LFS objects size in bytes
`packages_size`	Integer	Packages size in bytes
`pipeline_artifacts_size`	Integer	CI pipeline artifacts size in bytes
`repository_size`	Integer	Git repository size in bytes
`snippets_size`	Integer	Snippets size in bytes
`storage_size`	Integer	Total storage in bytes
`uploads_size`	Integer	Uploads size in bytes
`wiki_size`	Integer	Wiki size in bytes

APIEntitiesProject

Property	Type	Description
`_links`	Object	—
`_links.cluster_agents`	String	Example: `https://gitlab.example.com/api/v4/projects/4/cluster_agents`
`_links.events`	String	Example: `https://gitlab.example.com/api/v4/projects/4/events`
`_links.issues`	String	Example: `https://gitlab.example.com/api/v4/projects/4/issues`
`_links.labels`	String	Example: `https://gitlab.example.com/api/v4/projects/4/labels`
`_links.members`	String	Example: `https://gitlab.example.com/api/v4/projects/4/members`
`_links.merge_requests`	String	Example: `https://gitlab.example.com/api/v4/projects/4/merge_requests`
`_links.repo_branches`	String	Example: `https://gitlab.example.com/api/v4/projects/4/repository/branches`
`_links.self`	String	Example: `https://gitlab.example.com/api/v4/projects/4`
`allow_merge_on_skipped_pipeline`	Boolean	—
`allow_pipeline_trigger_approve_deployment`	Boolean	—
`analytics_access_level`	String	Example: `enabled`
`archived`	Boolean	—
`auto_cancel_pending_pipelines`	String	Example: `enabled`
`auto_devops_deploy_strategy`	String	Example: `continuous`
`auto_devops_enabled`	Boolean	—
`autoclose_referenced_issues`	Boolean	—
`automatic_rebase_enabled`	Boolean	—
`avatar_url`	String	Example: `http://example.com/uploads/project/avatar/3/uploads/avatar.png`
`build_git_strategy`	String	Example: `fetch`
`build_timeout`	Integer	Example: `3600`
`builds_access_level`	String	Example: `enabled`
`can_create_merge_request_in`	Boolean	—
`ci_allow_fork_pipelines_to_run_in_parent_project`	Boolean	—
`ci_config_path`	String	Example: ``
`ci_default_git_depth`	Integer	Example: `20`
`ci_delete_pipelines_in_seconds`	Integer	Example: `86400`
`ci_display_pipeline_variables`	Boolean	—
`ci_forward_deployment_enabled`	Boolean	—
`ci_forward_deployment_rollback_allowed`	Boolean	—
`ci_id_token_sub_claim_components`	Array of strings	—
`ci_job_token_scope_enabled`	Boolean	—
`ci_pipeline_variables_minimum_override_role`	String	—
`ci_push_repository_for_job_token_allowed`	Boolean	—
`ci_separated_caches`	Boolean	—
`ci_skip_branch_pipelines_for_mrs`	Boolean	—
`container_expiration_policy`	APIEntitiesContainerExpirationPolicy	—
`container_registry_access_level`	String	Example: `enabled`
`container_registry_enabled`	Boolean	—
`container_registry_image_prefix`	String	Example: `registry.gitlab.example.com/gitlab/gitlab-client`
`created_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`creator_id`	Integer (int64)	Example: `1`
`custom_attributes`	APIEntitiesCustomAttribute	—
`default_branch`	String	Example: `main`
`description`	String	Example: `desc`
`description_html`	String	—
`emails_disabled`	Boolean	—
`emails_enabled`	Boolean	—
`empty_repo`	Boolean	—
`enforce_auth_checks_on_uploads`	Boolean	—
`environments_access_level`	String	Example: `enabled`
`fe_project_setting_attributes`	Object	—
`feature_flags_access_level`	String	Example: `enabled`
`forked_from_project`	APIEntitiesBasicProjectDetails	—
`forking_access_level`	String	Example: `enabled`
`forks_count`	Integer	Example: `1`
`group_runners_enabled`	Boolean	—
`http_url_to_repo`	String	Example: `https://gitlab.example.com/gitlab/gitlab.git`
`id`	Integer (int64)	Example: `1`
`import_error`	String	Example: `Import error`
`import_status`	String	Example: `none`
`import_type`	String	Example: `git`
`import_url`	String	Example: `https://gitlab.com/gitlab/gitlab.git`
`infrastructure_access_level`	String	Example: `enabled`
`issue_branch_template`	String	Example: `%(title)`
`issues_access_level`	String	Example: `enabled`
`issues_enabled`	Boolean	—
`jobs_enabled`	Boolean	—
`keep_latest_artifact`	Boolean	—
`last_activity_at`	String (date-time)	Example: `2013-09-30T13:46:02Z`
`lfs_enabled`	Boolean	—
`license`	APIEntitiesLicenseBasic	—
`license_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab/blob/master/LICENCE`
`marked_for_deletion_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`marked_for_deletion_on`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`max_artifacts_size`	Integer	—
`max_pipelines_per_merge_train`	Integer	—
`merge_commit_template`	String	Example: `%(title)`
`merge_method`	String	Example: `merge`
`merge_pipelines_enabled`	Boolean	—
`merge_request_title_regex`	String	—
`merge_request_title_regex_description`	String	—
`merge_requests_access_level`	String	Example: `enabled`
`merge_requests_enabled`	Boolean	—
`merge_train_enforced`	Boolean	—
`merge_trains_enabled`	Boolean	—
`merge_trains_skip_train_allowed`	Boolean	—
`model_experiments_access_level`	String	Example: `enabled`
`model_registry_access_level`	String	Example: `enabled`
`monitor_access_level`	String	Example: `enabled`
`mr_default_target_self`	Boolean	—
`mr_default_title_template`	String	Example: `%(source_branch)`
`name`	String	Example: `project1`
`name_with_namespace`	String	Example: `John Doe / project1`
`namespace`	APIEntitiesNamespaceBasic	—
`only_allow_merge_if_all_discussions_are_resolved`	Boolean	—
`only_allow_merge_if_pipeline_succeeds`	Boolean	—
`open_issues_count`	Integer	Example: `1`
`owner`	APIEntitiesUserBasic	—
`package_registry_access_level`	String	Example: `enabled`
`packages_enabled`	Boolean	—
`pages_access_level`	String	Example: `enabled`
`path`	String	Example: `project1`
`path_with_namespace`	String	Example: `namespace1/project1`
`printing_merge_request_link_enabled`	Boolean	—
`protect_merge_request_pipelines`	Boolean	—
`public_jobs`	Boolean	—
`readme_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab/blob/master/README.md`
`releases_access_level`	String	Example: `enabled`
`remove_source_branch_after_merge`	Boolean	—
`repository_access_level`	String	Example: `enabled`
`repository_object_format`	String	Example: `sha1`
`repository_storage`	String	Example: `default`
`request_access_enabled`	Boolean	—
`resolve_outdated_diff_discussions`	Boolean	—
`resource_group_default_process_mode`	String	Example: `unordered`
`restrict_user_defined_variables`	Boolean	—
`runner_token_expiration_interval`	Integer	Example: `3600`
`runners_token`	String	Example: `b8547b1dc37721d05889db52fa2f02`
`security_and_compliance_access_level`	String	Example: `enabled`
`service_desk_address`	String	Example: `address@example.com`
`service_desk_enabled`	Boolean	—
`shared_runners_enabled`	Boolean	—
`shared_with_groups`	Array of objects	—
`show_diff_preview_in_email`	Boolean	—
`snippets_access_level`	String	Example: `enabled`
`snippets_enabled`	Boolean	—
`squash_commit_template`	String	Example: `%(source_branch)`
`squash_option`	String	Example: `default_off`
`ssh_url_to_repo`	String	Example: `git@gitlab.example.com:gitlab/gitlab.git`
`star_count`	Integer	Example: `1`
`statistics`	APIEntitiesProjectStatistics	—
`suggestion_commit_message`	String	Example: `Suggestion message`
`tag_list`	Array of strings	Example: `["tag"]`
`topics`	Array of strings	Example: `["topic"]`
`updated_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`visibility`	String	Example: `public`
`warn_about_potentially_unwanted_characters`	Boolean	—
`web_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab`
`wiki_access_level`	String	Example: `enabled`
`wiki_enabled`	Boolean	—

APIEntitiesProjectAccess

Property	Type	Description
`access_level`	String	—
`notification_level`	String	—

APIEntitiesProjectDailyFetches

Property	Type	Description
`count`	Integer	Example: `3`
`date`	String (date)	Example: `2022-01-01`

APIEntitiesProjectDailyStatistics

Property	Type	Description
`fetches`	Object	—
`fetches.days`	Array of APIEntitiesProjectDailyFetches	—
`fetches.total`	Integer	Example: `3`

APIEntitiesProjectGroupLink

Property	Type	Description
`expires_at`	String (date)	Example: `2016-09-26`
`group_access`	Integer	Example: `10`
`group_id`	Integer (int64)	Example: `1`
`id`	Integer (int64)	Example: `1`
`project_id`	Integer (int64)	Example: `1`

APIEntitiesProjectRepositoryStorage

Property	Type	Description
`created_at`	String (date-time)	Example: `2012-10-12T17:04:47Z`
`disk_path`	String	Example: `@hashed/6b/86/6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b`
`project_id`	Integer (int64)	Example: `1`
`repository_storage`	String	Example: `default`

APIEntitiesProjectsContainerRegistryProtectionRule

Property	Type	Description
`id`	Integer (int64)	Example: `1`
`minimum_access_level_for_delete`	String	Example: `maintainer`
`minimum_access_level_for_push`	String	Example: `maintainer`
`project_id`	Integer (int64)	Example: `1`
`repository_path_pattern`	String	Example: `flightjs/flight0`

APIEntitiesProjectsContainerRegistryProtectionTagRule

Property	Type	Description
`id`	Integer (int64)	Example: `1`
`minimum_access_level_for_delete`	String	Example: `maintainer`
`minimum_access_level_for_push`	String	Example: `maintainer`
`project_id`	Integer (int64)	Example: `123`
`tag_name_pattern`	String	Example: `v*-release`

APIEntitiesProjectsPackagesProtectionRule

Property	Type	Description
`id`	Integer (int64)	Example: `1`
`minimum_access_level_for_delete`	String	Example: `owner`
`minimum_access_level_for_push`	String	Example: `maintainer`
`package_name_pattern`	String	Example: `flightjs/flight`
`package_type`	String	Example: `npm`
`project_id`	Integer (int64)	Example: `1`

APIEntitiesProjectStatistics

Property	Type	Description
`commit_count`	Integer	Example: `37`
`container_registry_size`	Integer	Example: `0`
`job_artifacts_size`	Integer	Example: `0`
`lfs_objects_size`	Integer	Example: `0`
`packages_size`	Integer	Example: `0`
`pipeline_artifacts_size`	Integer	Example: `0`
`repository_size`	Integer	Example: `1.03809e+06`
`snippets_size`	Integer	Example: `0`
`storage_size`	Integer	Example: `1.03809e+06`
`uploads_size`	Integer	Example: `0`
`wiki_size`	Integer	Example: `0`

APIEntitiesProjectsWithAccessAndCatalogSetting

Property	Type	Description
`_links`	Object	—
`_links.cluster_agents`	String	Example: `https://gitlab.example.com/api/v4/projects/4/cluster_agents`
`_links.events`	String	Example: `https://gitlab.example.com/api/v4/projects/4/events`
`_links.issues`	String	Example: `https://gitlab.example.com/api/v4/projects/4/issues`
`_links.labels`	String	Example: `https://gitlab.example.com/api/v4/projects/4/labels`
`_links.members`	String	Example: `https://gitlab.example.com/api/v4/projects/4/members`
`_links.merge_requests`	String	Example: `https://gitlab.example.com/api/v4/projects/4/merge_requests`
`_links.repo_branches`	String	Example: `https://gitlab.example.com/api/v4/projects/4/repository/branches`
`_links.self`	String	Example: `https://gitlab.example.com/api/v4/projects/4`
`allow_merge_on_skipped_pipeline`	Boolean	—
`allow_pipeline_trigger_approve_deployment`	Boolean	—
`analytics_access_level`	String	Example: `enabled`
`archived`	Boolean	—
`auto_cancel_pending_pipelines`	String	Example: `enabled`
`auto_devops_deploy_strategy`	String	Example: `continuous`
`auto_devops_enabled`	Boolean	—
`autoclose_referenced_issues`	Boolean	—
`automatic_rebase_enabled`	Boolean	—
`avatar_url`	String	Example: `http://example.com/uploads/project/avatar/3/uploads/avatar.png`
`build_git_strategy`	String	Example: `fetch`
`build_timeout`	Integer	Example: `3600`
`builds_access_level`	String	Example: `enabled`
`can_create_merge_request_in`	Boolean	—
`ci_allow_fork_pipelines_to_run_in_parent_project`	Boolean	—
`ci_config_path`	String	Example: ``
`ci_default_git_depth`	Integer	Example: `20`
`ci_delete_pipelines_in_seconds`	Integer	Example: `86400`
`ci_display_pipeline_variables`	Boolean	—
`ci_forward_deployment_enabled`	Boolean	—
`ci_forward_deployment_rollback_allowed`	Boolean	—
`ci_id_token_sub_claim_components`	Array of strings	—
`ci_job_token_scope_enabled`	Boolean	—
`ci_pipeline_variables_minimum_override_role`	String	—
`ci_push_repository_for_job_token_allowed`	Boolean	—
`ci_separated_caches`	Boolean	—
`ci_skip_branch_pipelines_for_mrs`	Boolean	—
`cicd_catalog_enabled`	Boolean	—
`container_expiration_policy`	APIEntitiesContainerExpirationPolicy	—
`container_registry_access_level`	String	Example: `enabled`
`container_registry_enabled`	Boolean	—
`container_registry_image_prefix`	String	Example: `registry.gitlab.example.com/gitlab/gitlab-client`
`created_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`creator_id`	Integer (int64)	Example: `1`
`custom_attributes`	APIEntitiesCustomAttribute	—
`default_branch`	String	Example: `main`
`description`	String	Example: `desc`
`description_html`	String	—
`emails_disabled`	Boolean	—
`emails_enabled`	Boolean	—
`empty_repo`	Boolean	—
`enforce_auth_checks_on_uploads`	Boolean	—
`environments_access_level`	String	Example: `enabled`
`fe_project_setting_attributes`	Object	—
`feature_flags_access_level`	String	Example: `enabled`
`forked_from_project`	APIEntitiesBasicProjectDetails	—
`forking_access_level`	String	Example: `enabled`
`forks_count`	Integer	Example: `1`
`group_runners_enabled`	Boolean	—
`http_url_to_repo`	String	Example: `https://gitlab.example.com/gitlab/gitlab.git`
`id`	Integer (int64)	Example: `1`
`import_error`	String	Example: `Import error`
`import_status`	String	Example: `none`
`import_type`	String	Example: `git`
`import_url`	String	Example: `https://gitlab.com/gitlab/gitlab.git`
`infrastructure_access_level`	String	Example: `enabled`
`issue_branch_template`	String	Example: `%(title)`
`issues_access_level`	String	Example: `enabled`
`issues_enabled`	Boolean	—
`jobs_enabled`	Boolean	—
`keep_latest_artifact`	Boolean	—
`last_activity_at`	String (date-time)	Example: `2013-09-30T13:46:02Z`
`lfs_enabled`	Boolean	—
`license`	APIEntitiesLicenseBasic	—
`license_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab/blob/master/LICENCE`
`marked_for_deletion_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`marked_for_deletion_on`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`max_artifacts_size`	Integer	—
`max_pipelines_per_merge_train`	Integer	—
`merge_commit_template`	String	Example: `%(title)`
`merge_method`	String	Example: `merge`
`merge_pipelines_enabled`	Boolean	—
`merge_request_title_regex`	String	—
`merge_request_title_regex_description`	String	—
`merge_requests_access_level`	String	Example: `enabled`
`merge_requests_enabled`	Boolean	—
`merge_train_enforced`	Boolean	—
`merge_trains_enabled`	Boolean	—
`merge_trains_skip_train_allowed`	Boolean	—
`model_experiments_access_level`	String	Example: `enabled`
`model_registry_access_level`	String	Example: `enabled`
`monitor_access_level`	String	Example: `enabled`
`mr_default_target_self`	Boolean	—
`mr_default_title_template`	String	Example: `%(source_branch)`
`name`	String	Example: `project1`
`name_with_namespace`	String	Example: `John Doe / project1`
`namespace`	APIEntitiesNamespaceBasic	—
`only_allow_merge_if_all_discussions_are_resolved`	Boolean	—
`only_allow_merge_if_pipeline_succeeds`	Boolean	—
`open_issues_count`	Integer	Example: `1`
`owner`	APIEntitiesUserBasic	—
`package_registry_access_level`	String	Example: `enabled`
`packages_enabled`	Boolean	—
`pages_access_level`	String	Example: `enabled`
`path`	String	Example: `project1`
`path_with_namespace`	String	Example: `namespace1/project1`
`permissions`	Object	—
`permissions.group_access`	APIEntitiesGroupAccess	—
`permissions.project_access`	APIEntitiesProjectAccess	—
`printing_merge_request_link_enabled`	Boolean	—
`protect_merge_request_pipelines`	Boolean	—
`public_jobs`	Boolean	—
`readme_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab/blob/master/README.md`
`releases_access_level`	String	Example: `enabled`
`remove_source_branch_after_merge`	Boolean	—
`repository_access_level`	String	Example: `enabled`
`repository_object_format`	String	Example: `sha1`
`repository_storage`	String	Example: `default`
`request_access_enabled`	Boolean	—
`resolve_outdated_diff_discussions`	Boolean	—
`resource_group_default_process_mode`	String	Example: `unordered`
`restrict_user_defined_variables`	Boolean	—
`runner_token_expiration_interval`	Integer	Example: `3600`
`runners_token`	String	Example: `b8547b1dc37721d05889db52fa2f02`
`security_and_compliance_access_level`	String	Example: `enabled`
`service_desk_address`	String	Example: `address@example.com`
`service_desk_enabled`	Boolean	—
`shared_runners_enabled`	Boolean	—
`shared_with_groups`	Array of objects	—
`show_diff_preview_in_email`	Boolean	—
`snippets_access_level`	String	Example: `enabled`
`snippets_enabled`	Boolean	—
`squash_commit_template`	String	Example: `%(source_branch)`
`squash_option`	String	Example: `default_off`
`ssh_url_to_repo`	String	Example: `git@gitlab.example.com:gitlab/gitlab.git`
`star_count`	Integer	Example: `1`
`statistics`	APIEntitiesProjectStatistics	—
`suggestion_commit_message`	String	Example: `Suggestion message`
`tag_list`	Array of strings	Example: `["tag"]`
`topics`	Array of strings	Example: `["topic"]`
`updated_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`visibility`	String	Example: `public`
`warn_about_potentially_unwanted_characters`	Boolean	—
`web_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab`
`wiki_access_level`	String	Example: `enabled`
`wiki_enabled`	Boolean	—

APIEntitiesProjectsWithCatalogSetting

Property	Type	Description
`_links`	Object	—
`_links.cluster_agents`	String	Example: `https://gitlab.example.com/api/v4/projects/4/cluster_agents`
`_links.events`	String	Example: `https://gitlab.example.com/api/v4/projects/4/events`
`_links.issues`	String	Example: `https://gitlab.example.com/api/v4/projects/4/issues`
`_links.labels`	String	Example: `https://gitlab.example.com/api/v4/projects/4/labels`
`_links.members`	String	Example: `https://gitlab.example.com/api/v4/projects/4/members`
`_links.merge_requests`	String	Example: `https://gitlab.example.com/api/v4/projects/4/merge_requests`
`_links.repo_branches`	String	Example: `https://gitlab.example.com/api/v4/projects/4/repository/branches`
`_links.self`	String	Example: `https://gitlab.example.com/api/v4/projects/4`
`allow_merge_on_skipped_pipeline`	Boolean	—
`allow_pipeline_trigger_approve_deployment`	Boolean	—
`analytics_access_level`	String	Example: `enabled`
`archived`	Boolean	—
`auto_cancel_pending_pipelines`	String	Example: `enabled`
`auto_devops_deploy_strategy`	String	Example: `continuous`
`auto_devops_enabled`	Boolean	—
`autoclose_referenced_issues`	Boolean	—
`automatic_rebase_enabled`	Boolean	—
`avatar_url`	String	Example: `http://example.com/uploads/project/avatar/3/uploads/avatar.png`
`build_git_strategy`	String	Example: `fetch`
`build_timeout`	Integer	Example: `3600`
`builds_access_level`	String	Example: `enabled`
`can_create_merge_request_in`	Boolean	—
`ci_allow_fork_pipelines_to_run_in_parent_project`	Boolean	—
`ci_config_path`	String	Example: ``
`ci_default_git_depth`	Integer	Example: `20`
`ci_delete_pipelines_in_seconds`	Integer	Example: `86400`
`ci_display_pipeline_variables`	Boolean	—
`ci_forward_deployment_enabled`	Boolean	—
`ci_forward_deployment_rollback_allowed`	Boolean	—
`ci_id_token_sub_claim_components`	Array of strings	—
`ci_job_token_scope_enabled`	Boolean	—
`ci_pipeline_variables_minimum_override_role`	String	—
`ci_push_repository_for_job_token_allowed`	Boolean	—
`ci_separated_caches`	Boolean	—
`ci_skip_branch_pipelines_for_mrs`	Boolean	—
`cicd_catalog_enabled`	Boolean	—
`container_expiration_policy`	APIEntitiesContainerExpirationPolicy	—
`container_registry_access_level`	String	Example: `enabled`
`container_registry_enabled`	Boolean	—
`container_registry_image_prefix`	String	Example: `registry.gitlab.example.com/gitlab/gitlab-client`
`created_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`creator_id`	Integer (int64)	Example: `1`
`custom_attributes`	APIEntitiesCustomAttribute	—
`default_branch`	String	Example: `main`
`description`	String	Example: `desc`
`description_html`	String	—
`emails_disabled`	Boolean	—
`emails_enabled`	Boolean	—
`empty_repo`	Boolean	—
`enforce_auth_checks_on_uploads`	Boolean	—
`environments_access_level`	String	Example: `enabled`
`fe_project_setting_attributes`	Object	—
`feature_flags_access_level`	String	Example: `enabled`
`forked_from_project`	APIEntitiesBasicProjectDetails	—
`forking_access_level`	String	Example: `enabled`
`forks_count`	Integer	Example: `1`
`group_runners_enabled`	Boolean	—
`http_url_to_repo`	String	Example: `https://gitlab.example.com/gitlab/gitlab.git`
`id`	Integer (int64)	Example: `1`
`import_error`	String	Example: `Import error`
`import_status`	String	Example: `none`
`import_type`	String	Example: `git`
`import_url`	String	Example: `https://gitlab.com/gitlab/gitlab.git`
`infrastructure_access_level`	String	Example: `enabled`
`issue_branch_template`	String	Example: `%(title)`
`issues_access_level`	String	Example: `enabled`
`issues_enabled`	Boolean	—
`jobs_enabled`	Boolean	—
`keep_latest_artifact`	Boolean	—
`last_activity_at`	String (date-time)	Example: `2013-09-30T13:46:02Z`
`lfs_enabled`	Boolean	—
`license`	APIEntitiesLicenseBasic	—
`license_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab/blob/master/LICENCE`
`marked_for_deletion_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`marked_for_deletion_on`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`max_artifacts_size`	Integer	—
`max_pipelines_per_merge_train`	Integer	—
`merge_commit_template`	String	Example: `%(title)`
`merge_method`	String	Example: `merge`
`merge_pipelines_enabled`	Boolean	—
`merge_request_title_regex`	String	—
`merge_request_title_regex_description`	String	—
`merge_requests_access_level`	String	Example: `enabled`
`merge_requests_enabled`	Boolean	—
`merge_train_enforced`	Boolean	—
`merge_trains_enabled`	Boolean	—
`merge_trains_skip_train_allowed`	Boolean	—
`model_experiments_access_level`	String	Example: `enabled`
`model_registry_access_level`	String	Example: `enabled`
`monitor_access_level`	String	Example: `enabled`
`mr_default_target_self`	Boolean	—
`mr_default_title_template`	String	Example: `%(source_branch)`
`name`	String	Example: `project1`
`name_with_namespace`	String	Example: `John Doe / project1`
`namespace`	APIEntitiesNamespaceBasic	—
`only_allow_merge_if_all_discussions_are_resolved`	Boolean	—
`only_allow_merge_if_pipeline_succeeds`	Boolean	—
`open_issues_count`	Integer	Example: `1`
`owner`	APIEntitiesUserBasic	—
`package_registry_access_level`	String	Example: `enabled`
`packages_enabled`	Boolean	—
`pages_access_level`	String	Example: `enabled`
`path`	String	Example: `project1`
`path_with_namespace`	String	Example: `namespace1/project1`
`printing_merge_request_link_enabled`	Boolean	—
`protect_merge_request_pipelines`	Boolean	—
`public_jobs`	Boolean	—
`readme_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab/blob/master/README.md`
`releases_access_level`	String	Example: `enabled`
`remove_source_branch_after_merge`	Boolean	—
`repository_access_level`	String	Example: `enabled`
`repository_object_format`	String	Example: `sha1`
`repository_storage`	String	Example: `default`
`request_access_enabled`	Boolean	—
`resolve_outdated_diff_discussions`	Boolean	—
`resource_group_default_process_mode`	String	Example: `unordered`
`restrict_user_defined_variables`	Boolean	—
`runner_token_expiration_interval`	Integer	Example: `3600`
`runners_token`	String	Example: `b8547b1dc37721d05889db52fa2f02`
`security_and_compliance_access_level`	String	Example: `enabled`
`service_desk_address`	String	Example: `address@example.com`
`service_desk_enabled`	Boolean	—
`shared_runners_enabled`	Boolean	—
`shared_with_groups`	Array of objects	—
`show_diff_preview_in_email`	Boolean	—
`snippets_access_level`	String	Example: `enabled`
`snippets_enabled`	Boolean	—
`squash_commit_template`	String	Example: `%(source_branch)`
`squash_option`	String	Example: `default_off`
`ssh_url_to_repo`	String	Example: `git@gitlab.example.com:gitlab/gitlab.git`
`star_count`	Integer	Example: `1`
`statistics`	APIEntitiesProjectStatistics	—
`suggestion_commit_message`	String	Example: `Suggestion message`
`tag_list`	Array of strings	Example: `["tag"]`
`topics`	Array of strings	Example: `["topic"]`
`updated_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`visibility`	String	Example: `public`
`warn_about_potentially_unwanted_characters`	Boolean	—
`web_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab`
`wiki_access_level`	String	Example: `enabled`
`wiki_enabled`	Boolean	—

APIEntitiesProjectUpload

Property	Type	Description
`alt`	String	Example: `filename`
`full_path`	String	Example: `/-/project/1/uploads/secret/filename`
`id`	Integer (int64)	Example: `1`
`markdown`	String	Example: `[filename](/uploads/secret/filename)`
`url`	String	Example: `/uploads/secret/filename`

APIEntitiesPublicGroupDetails

Property	Type	Description
`avatar_url`	String	Example: `http://gitlab.example.com/uploads/group/avatar/1/avatar.png`
`full_name`	String	Example: `Foobar Group`
`full_path`	String	Example: `foo-bar`
`id`	Integer (int64)	—
`name`	String	Example: `Diaspora`
`web_url`	String	Example: `http://gitlab.example.com/groups/diaspora`

APIEntitiesTaskCompletionStatus

Property	Type	Description
`completed_count`	Integer	Example: `3`
`count`	Integer	Example: `5`

APIEntitiesTerraformStateProtectionRule

Property	Type	Description
`allowed_from`	String	Example: `ci_only`
`id`	Integer (int64)	Example: `1`
`minimum_access_level_for_write`	String	Example: `maintainer`
`project_id`	Integer (int64)	Example: `1`
`state_name`	String	Example: `production`

APIEntitiesUserBasic

Property	Type	Description
`avatar_path`	String	Example: `/user/avatar/28/The-Big-Lebowski-400-400.png`
`avatar_url`	String	Example: `https://gravatar.com/avatar/1`
`custom_attributes`	Array of APIEntitiesCustomAttribute	—
`id`	Integer (int64)	Example: `1`
`locked`	Boolean	—
`name`	String	Example: `Administrator`
`public_email`	String	Example: `john@example.com`
`state`	String	Example: `active`
`username`	String	Example: `admin`
`web_url`	String	Example: `https://gitlab.example.com/root`

APIEntitiesUserSafe

Property	Type	Description
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `Administrator`
`public_email`	String	Example: `john@example.com`
`username`	String	Example: `admin`

List CODEOWNERS entries that match a file path

List all projects

Create a project

Create a project for a user

Retrieve a project

Update a project

Delete a project

Search a project

Archive a project

Create a fork of a project

Delete a fork relationship

Create a fork relationship

List all forks of a project

List all ancestor groups

Start the housekeeping task for a project

Import members

List all invited groups in a project

List all project issues

Create an issue

Retrieve a project issue

Update an issue

Delete an issue

Clone an issue

List all merge requests that close an issue on merge

Move an issue

Update the order of an issue

Retrieve issues statistics for a project

Retrieve programming language usage information

List all package protection rules

Create a package protection rule

Update a package protection rule

Delete a package protection rule

Check pages access of this project

List all container repository protection rules

Create a container repository protection rule

Update a container repository protection rule

Delete a container repository protection rule

List all container registry protection tag rules

Create a container registry protection tag rule

Update a container registry protection tag rule

Delete a container registry protection tag rule

Start a task to recalculate repository size for a project

Restore a project marked for deletion

List all runners for a project

Assign a runner to a project

Reset runner registration token

Unassign a runner from a project

Share a project with a group

Delete a shared project link in a group

List all groups available to invite to a project

Star a project

List all users who starred a project

Retrieve the statistics of the last 30 days

Retrieve the path to repository storage

List all Terraform state protection rules for a project

Create a Terraform state protection rule for a project

Update a Terraform state protection rule for a project

Delete a Terraform state protection rule

Transfer a project to another namespace

List all transferable namespaces for a project

Unarchive a project

Unstar a project

List all uploads

Create an upload

Workhorse authorize the file upload

Download an uploaded file by secret and filename

Delete an uploaded file by secret and filename

Download an uploaded file by ID

Delete an uploaded file by ID

List all members of a project

Get projects associated with a runner

List all projects contributions for a user

List all personal projects for a user

List all projects starred by a user

Validate CODEOWNERS file by project full path

Schemas

APIEntitiesBasicProjectDetails

APIEntitiesCiResetTokenResult

APIEntitiesCiRunner