Create a project for a user

POST

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

Creates a project for a user. Administrators only.

Authorizations

http
oauth2

Parameters

Path Parameters

user_id

required

integer

The ID of a user

Example

Request Body^required

multipart/form-data

object

name

required

The name of the project

string

nullable

Example

New Project

path

The path of the repository

string

nullable

Example

new_project

default_branch

The default branch of the project

string

nullable

Example

main

description

The description of the project

string

nullable

build_git_strategy

The Git strategy. Defaults to fetch

string

nullable

Allowed values: fetch clone

build_timeout

Build timeout

integer

nullable

auto_cancel_pending_pipelines

Auto-cancel pending pipelines

string

nullable

Allowed values: disabled enabled

ci_config_path

The path to CI config file. Defaults to .gitlab-ci.yml

string

nullable

service_desk_enabled

Disable or enable the service desk

boolean

nullable

issues_enabled

Flag indication if the issue tracker is enabled

boolean

nullable

merge_requests_enabled

Flag indication if merge requests are enabled

boolean

nullable

wiki_enabled

Flag indication if the wiki is enabled

boolean

nullable

jobs_enabled

Flag indication if jobs are enabled

boolean

nullable

snippets_enabled

Flag indication if snippets are enabled

boolean

nullable

issues_access_level

Issues access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

repository_access_level

Repository access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

merge_requests_access_level

Merge requests access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

forking_access_level

Forks access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

wiki_access_level

Wiki access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

builds_access_level

Builds access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

snippets_access_level

Snippets access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

package_registry_access_level

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

string

nullable

Allowed values: disabled private enabled public

pages_access_level

Pages access level. One of disabled, private, enabled or public

string

nullable

Allowed values: disabled private enabled public

analytics_access_level

Analytics access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

container_registry_access_level

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

string

nullable

Allowed values: disabled private enabled

security_and_compliance_access_level

Security and compliance access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

releases_access_level

Releases access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

environments_access_level

Environments access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

feature_flags_access_level

Feature flags access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

infrastructure_access_level

Infrastructure access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

monitor_access_level

Monitor access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

model_experiments_access_level

Model experiments access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

model_registry_access_level

Model registry access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

emails_disabled

Deprecated: Use emails_enabled instead.

boolean

nullable

emails_enabled

Enable email notifications

boolean

nullable

show_default_award_emojis

Show default award emojis

boolean

nullable

show_diff_preview_in_email

Include the code diff preview in merge request notification emails

boolean

nullable

warn_about_potentially_unwanted_characters

Warn about potentially unwanted characters

boolean

nullable

enforce_auth_checks_on_uploads

Enforce auth check on uploads

boolean

nullable

shared_runners_enabled

Flag indication if shared runners are enabled for that project

boolean

nullable

group_runners_enabled

Flag indication if group runners are enabled for that project

boolean

nullable

resource_group_default_process_mode

The process mode of the resource group

string

nullable

Allowed values: unordered oldest_first newest_first newest_ready_first

resolve_outdated_diff_discussions

Automatically resolve merge request diff threads on lines changed with a push

boolean

nullable

remove_source_branch_after_merge

Remove the source branch by default after merge

boolean

nullable

packages_enabled

Deprecated: Use :package_registry_access_level instead. Enable project packages feature

boolean

nullable

container_registry_enabled

Deprecated: Use :container_registry_access_level instead. Flag indication if the container registry is enabled for that project

boolean

nullable

container_expiration_policy_attributes

Object that contains information on the container expiration policy

object

cadence

Container expiration policy cadence for recurring job

string

nullable

keep_n

Container expiration policy number of images to keep

integer

nullable

older_than

Container expiration policy remove images older than value

string

nullable

name_regex

Container expiration policy regex for image removal

string

nullable

name_regex_keep

Container expiration policy regex for image retention

string

nullable

enabled

Flag indication if container expiration policy is enabled

boolean

nullable

lfs_enabled

Flag indication if Git LFS is enabled for that project

boolean

nullable

visibility

The visibility of the project.

string

nullable

Allowed values: private internal public

public_builds

Deprecated: Use public_jobs instead.

boolean

nullable

public_jobs

Perform public builds

boolean

nullable

request_access_enabled

Allow users to request member access

boolean

nullable

only_allow_merge_if_pipeline_succeeds

Only allow to merge if builds succeed

boolean

nullable

allow_merge_on_skipped_pipeline

Allow to merge if pipeline is skipped

boolean

nullable

only_allow_merge_if_all_discussions_are_resolved

Only allow to merge if all threads are resolved

boolean

nullable

tag_list

Deprecated: Use :topics instead

Array<string>

nullable

topics

The list of topics for a project

Array<string>

nullable

avatar

Avatar image for project

string format: binary

nullable

printing_merge_request_link_enabled

Show link to create/view merge request when pushing from the command line

boolean

nullable

merge_method

The merge method used when merging merge requests

string

nullable

Allowed values: ff rebase_merge merge

suggestion_commit_message

The commit message used to apply merge request suggestions

string

nullable

merge_commit_template

Template used to create merge commit message

string

nullable

squash_commit_template

Template used to create squash commit message

string

nullable

issue_branch_template

Template used to create a branch from an issue

string

nullable

auto_devops_enabled

Flag indication if Auto DevOps is enabled

boolean

nullable

auto_devops_deploy_strategy

Auto Deploy strategy

string

nullable

Allowed values: continuous manual timed_incremental

autoclose_referenced_issues

Flag indication if referenced issues auto-closing is enabled

boolean

nullable

repository_storage

Which storage shard the repository is on. Available only to admins

string

nullable

squash_option

Squash default for project. One of never, always, default_on, or default_off.

string

nullable

Allowed values: never always default_on default_off

mr_default_target_self

Merge requests of this forked project targets itself by default

boolean

nullable

mr_default_title_template

Template used to generate the default merge request title. Maximum 100 characters.

string

nullable <= 100 characters

only_allow_merge_if_all_status_checks_passed

Blocks merge requests from merging unless all status checks have passed

boolean

nullable

approvals_before_merge

How many approvers should approve merge request by default

integer

nullable

mirror

[Deprecated] Enables pull mirroring in a project

boolean

nullable

mirror_trigger_builds

[Deprecated] Pull mirroring triggers builds

boolean

nullable

external_authorization_classification_label

The classification label for the project

string

nullable

requirements_access_level

Requirements feature access level. One of disabled, private or enabled

string

nullable

Allowed values: disabled private enabled

prevent_merge_without_jira_issue

Require an associated issue from Jira

boolean

nullable

auto_duo_code_review_enabled

Enable automatic reviews by GitLab Duo on merge requests

boolean

nullable

duo_remote_flows_enabled

Enable GitLab Duo remote flows for this project

boolean

nullable

duo_sast_fp_detection_enabled

Enable GitLab Duo SAST false positive detection for this project

boolean

nullable

duo_secret_detection_fp_enabled

Enable GitLab Duo Secret Detection false positive detection for this project

boolean

nullable

duo_dependency_bump_breaking_changes_enabled

Turn on Agentic Breaking Change Resolution for this project

boolean

nullable

duo_sast_vr_workflow_enabled

Enable GitLab Duo SAST vulnerability resolution workflow for this project

boolean

nullable

spp_repository_pipeline_access

Grant read-only access to security policy configurations for enforcement in linked CI/CD projects

boolean

nullable

merge_request_title_regex

The regex the Merge Request must adhere to

string

nullable

merge_request_title_regex_description

The description for the regex the Merge Request must adhere to

string

nullable

repository_object_format

The object format of the project repository

string

nullable

Allowed values: sha1 sha256

initialize_with_readme

Initialize a project with a README.md

boolean

nullable

use_custom_template

Use custom template

boolean

nullable

group_with_project_templates_id

Group ID that serves as the template source

integer

nullable

namespace_id

Namespace ID for the new project. Default to the user namespace.

integer

nullable

import_url

URL from which the project is imported

string

nullable

template_name

Name of template from which to create project

string

nullable

template_project_id

Project ID of template from which to create project

integer

nullable

Responses

201

Created

application/json

object

integer format: int64

description

string

name

string

name_with_namespace

string

path

string

path_with_namespace

string

created_at

string format: date-time

default_branch

string

tag_list

Array<string>

topics

Array<string>

ssh_url_to_repo

string

http_url_to_repo

string

web_url

string

readme_url

string

forks_count

integer

license_url

string

license

object

key

string

name

string

nickname

string

html_url

string

source_url

string

avatar_url

string

star_count

integer

last_activity_at

string format: date-time

visibility

string

namespace

object

integer format: int64

name

string

path

string

kind

string

full_path

string

parent_id

integer format: int64

avatar_url

string

web_url

string

custom_attributes

object

key

string

value

string

repository_storage

string

forked_from_project

object

integer format: int64

description

string

name

string

name_with_namespace

string

path

string

path_with_namespace

string

created_at

string format: date-time

default_branch

string

tag_list

Array<string>

topics

Array<string>

ssh_url_to_repo

string

http_url_to_repo

string

web_url

string

readme_url

string

forks_count

integer

license_url

string

license

object

key

string

name

string

nickname

string

html_url

string

source_url

string

avatar_url

string

star_count

integer

last_activity_at

string format: date-time

visibility

string

namespace

object

integer format: int64

name

string

path

string

kind

string

full_path

string

parent_id

integer format: int64

avatar_url

string

web_url

string

custom_attributes

object

key

string

value

string

repository_storage

string

container_registry_image_prefix

string

_links

object

marked_for_deletion_at

string format: date-time

marked_for_deletion_on

string format: date-time

packages_enabled

boolean

empty_repo

boolean

archived

boolean

owner

object

integer format: int64

username

string

public_email

string

name

string

state

string

locked

boolean

avatar_url

string

avatar_path

string

custom_attributes

Array<object>

object

key

string

value

string

web_url

string

resolve_outdated_diff_discussions

boolean

container_expiration_policy

object

cadence

string

enabled

string

keep_n

string

older_than

string

name_regex

string

name_regex_keep

string

next_run_at

string

repository_object_format

string

issues_enabled

boolean

merge_requests_enabled

boolean

wiki_enabled

boolean

jobs_enabled

boolean

snippets_enabled

boolean

container_registry_enabled

boolean

service_desk_enabled

boolean

service_desk_address

string

can_create_merge_request_in

boolean

issues_access_level

string

repository_access_level

string

merge_requests_access_level

string

forking_access_level

string

wiki_access_level

string

builds_access_level

string

snippets_access_level

string

pages_access_level

string

analytics_access_level

string

container_registry_access_level

string

security_and_compliance_access_level

string

releases_access_level

string

environments_access_level

string

feature_flags_access_level

string

infrastructure_access_level

string

monitor_access_level

string

model_experiments_access_level

string

model_registry_access_level

string

package_registry_access_level

string

emails_disabled

boolean

emails_enabled

boolean

show_diff_preview_in_email

boolean

shared_runners_enabled

boolean

lfs_enabled

boolean

creator_id

integer format: int64

mr_default_target_self

boolean

import_url

string

import_type

string

import_status

string

import_error

string

open_issues_count

integer

description_html

string

updated_at

string format: date-time

ci_default_git_depth

integer

ci_delete_pipelines_in_seconds

integer

ci_forward_deployment_enabled

boolean

ci_forward_deployment_rollback_allowed

boolean

ci_job_token_scope_enabled

boolean

ci_separated_caches

boolean

ci_allow_fork_pipelines_to_run_in_parent_project

boolean

ci_id_token_sub_claim_components

Array<string>

build_git_strategy

string

keep_latest_artifact

boolean

restrict_user_defined_variables

boolean

ci_pipeline_variables_minimum_override_role

string

runner_token_expiration_interval

integer

group_runners_enabled

boolean

resource_group_default_process_mode

string

auto_cancel_pending_pipelines

string

build_timeout

integer

auto_devops_enabled

boolean

auto_devops_deploy_strategy

string

ci_push_repository_for_job_token_allowed

boolean

protect_merge_request_pipelines

boolean

ci_display_pipeline_variables

boolean

runners_token

string

ci_config_path

string

public_jobs

boolean

shared_with_groups

Array<object>

object

only_allow_merge_if_pipeline_succeeds

boolean

allow_merge_on_skipped_pipeline

boolean

request_access_enabled

boolean

only_allow_merge_if_all_discussions_are_resolved

boolean

remove_source_branch_after_merge

boolean

printing_merge_request_link_enabled

boolean

merge_method

string

squash_option

string

enforce_auth_checks_on_uploads

boolean

suggestion_commit_message

string

merge_commit_template

string

squash_commit_template

string

mr_default_title_template

string

issue_branch_template

string

statistics

object

commit_count

integer

storage_size

integer

repository_size

integer

wiki_size

integer

lfs_objects_size

integer

job_artifacts_size

integer

pipeline_artifacts_size

integer

packages_size

integer

snippets_size

integer

uploads_size

integer

container_registry_size

integer

warn_about_potentially_unwanted_characters

boolean

autoclose_referenced_issues

boolean

max_artifacts_size

integer

approvals_before_merge

string

mirror

string

mirror_user_id

string

mirror_trigger_builds

string

only_mirror_protected_branches

string

mirror_overwrites_diverged_branches

string

external_authorization_classification_label

string

requirements_enabled

string

requirements_access_level

string

security_and_compliance_enabled

string

secret_push_protection_enabled

boolean

pre_receive_secret_detection_enabled

boolean

compliance_frameworks

string

issues_template

string

merge_requests_template

string

ci_restrict_pipeline_cancellation_role

string

merge_pipelines_enabled

string

merge_trains_enabled

string

merge_trains_skip_train_allowed

string

merge_train_enforcement

string

max_pipelines_per_merge_train

string

only_allow_merge_if_all_status_checks_passed

string

allow_pipeline_trigger_approve_deployment

boolean

prevent_merge_without_jira_issue

string

auto_duo_code_review_enabled

string

reviewer_assignment_strategy

string

duo_remote_flows_enabled

string

duo_foundational_flows_enabled

string

duo_sast_fp_detection_enabled

string

duo_secret_detection_fp_enabled

string

duo_dependency_bump_breaking_changes_enabled

string

duo_sast_vr_workflow_enabled

string

web_based_commit_signing_enabled

string

spp_repository_pipeline_access

The spp_repository_pipeline_access setting is only visible if the security_orchestration_policies feature is available.

boolean

security_policy_pipeline_must_succeed

Require all security policy pipelines to succeed before merge requests can be merged.

boolean

merge_request_title_regex

string

merge_request_title_regex_description

string

Example

{
  "id": 1,
  "description": "desc",
  "name": "project1",
  "name_with_namespace": "John Doe / project1",
  "path": "project1",
  "path_with_namespace": "namespace1/project1",
  "created_at": "2020-05-07T04:27:17.016Z",
  "default_branch": "main",
  "tag_list": [
    "tag"
  ],
  "topics": [
    "topic"
  ],
  "ssh_url_to_repo": "git@gitlab.example.com:gitlab/gitlab.git",
  "http_url_to_repo": "https://gitlab.example.com/gitlab/gitlab.git",
  "web_url": "https://gitlab.example.com/gitlab/gitlab",
  "readme_url": "https://gitlab.example.com/gitlab/gitlab/blob/master/README.md",
  "forks_count": 1,
  "license_url": "https://gitlab.example.com/gitlab/gitlab/blob/master/LICENCE",
  "license": {
    "key": "gpl-3.0",
    "name": "GNU General Public License v3.0",
    "nickname": "GNU GPLv3",
    "html_url": "http://choosealicense.com/licenses/gpl-3.0"
  },
  "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
  "star_count": 1,
  "last_activity_at": "2013-09-30T13:46:02Z",
  "visibility": "public",
  "namespace": {
    "id": 2,
    "name": "project",
    "path": "my_project",
    "kind": "project",
    "full_path": "group/my_project",
    "parent_id": 1,
    "avatar_url": "https://example.com/avatar/12345",
    "web_url": "https://example.com/group/my_project"
  },
  "custom_attributes": {
    "key": "foo",
    "value": "bar"
  },
  "repository_storage": "default",
  "forked_from_project": {
    "id": 1,
    "description": "desc",
    "name": "project1",
    "name_with_namespace": "John Doe / project1",
    "path": "project1",
    "path_with_namespace": "namespace1/project1",
    "created_at": "2020-05-07T04:27:17.016Z",
    "default_branch": "main",
    "tag_list": [
      "tag"
    ],
    "topics": [
      "topic"
    ],
    "ssh_url_to_repo": "git@gitlab.example.com:gitlab/gitlab.git",
    "http_url_to_repo": "https://gitlab.example.com/gitlab/gitlab.git",
    "web_url": "https://gitlab.example.com/gitlab/gitlab",
    "readme_url": "https://gitlab.example.com/gitlab/gitlab/blob/master/README.md",
    "forks_count": 1,
    "license_url": "https://gitlab.example.com/gitlab/gitlab/blob/master/LICENCE",
    "license": {
      "key": "gpl-3.0",
      "name": "GNU General Public License v3.0",
      "nickname": "GNU GPLv3",
      "html_url": "http://choosealicense.com/licenses/gpl-3.0"
    },
    "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
    "star_count": 1,
    "last_activity_at": "2013-09-30T13:46:02Z",
    "visibility": "public",
    "namespace": {
      "id": 2,
      "name": "project",
      "path": "my_project",
      "kind": "project",
      "full_path": "group/my_project",
      "parent_id": 1,
      "avatar_url": "https://example.com/avatar/12345",
      "web_url": "https://example.com/group/my_project"
    },
    "custom_attributes": {
      "key": "foo",
      "value": "bar"
    },
    "repository_storage": "default"
  },
  "container_registry_image_prefix": "registry.gitlab.example.com/gitlab/gitlab-client",
  "marked_for_deletion_at": "2020-05-07T04:27:17.016Z",
  "marked_for_deletion_on": "2020-05-07T04:27:17.016Z",
  "owner": {
    "id": 1,
    "username": "admin",
    "public_email": "john@example.com",
    "name": "Administrator",
    "state": "active",
    "avatar_url": "https://gravatar.com/avatar/1",
    "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
    "custom_attributes": [
      {
        "key": "foo",
        "value": "bar"
      }
    ],
    "web_url": "https://gitlab.example.com/root"
  },
  "repository_object_format": "sha1",
  "service_desk_address": "address@example.com",
  "issues_access_level": "enabled",
  "repository_access_level": "enabled",
  "merge_requests_access_level": "enabled",
  "forking_access_level": "enabled",
  "wiki_access_level": "enabled",
  "builds_access_level": "enabled",
  "snippets_access_level": "enabled",
  "pages_access_level": "enabled",
  "analytics_access_level": "enabled",
  "container_registry_access_level": "enabled",
  "security_and_compliance_access_level": "enabled",
  "releases_access_level": "enabled",
  "environments_access_level": "enabled",
  "feature_flags_access_level": "enabled",
  "infrastructure_access_level": "enabled",
  "monitor_access_level": "enabled",
  "model_experiments_access_level": "enabled",
  "model_registry_access_level": "enabled",
  "package_registry_access_level": "enabled",
  "creator_id": 1,
  "import_url": "https://gitlab.com/gitlab/gitlab.git",
  "import_type": "git",
  "import_status": "none",
  "import_error": "Import error",
  "open_issues_count": 1,
  "updated_at": "2020-05-07T04:27:17.016Z",
  "ci_default_git_depth": 20,
  "ci_delete_pipelines_in_seconds": 86400,
  "build_git_strategy": "fetch",
  "runner_token_expiration_interval": 3600,
  "resource_group_default_process_mode": "unordered",
  "auto_cancel_pending_pipelines": "enabled",
  "build_timeout": 3600,
  "auto_devops_deploy_strategy": "continuous",
  "runners_token": "b8547b1dc37721d05889db52fa2f02",
  "ci_config_path": "",
  "merge_method": "merge",
  "squash_option": "default_off",
  "suggestion_commit_message": "Suggestion message",
  "merge_commit_template": "%(title)",
  "squash_commit_template": "%(source_branch)",
  "mr_default_title_template": "%(source_branch)",
  "issue_branch_template": "%(title)",
  "statistics": {
    "commit_count": 37,
    "storage_size": 1038090,
    "repository_size": 1038090,
    "wiki_size": 0,
    "lfs_objects_size": 0,
    "job_artifacts_size": 0,
    "pipeline_artifacts_size": 0,
    "packages_size": 0,
    "snippets_size": 0,
    "uploads_size": 0,
    "container_registry_size": 0
  },
  "reviewer_assignment_strategy": "code_owners",
  "merge_request_title_regex": "/Title of merge request/",
  "merge_request_title_regex_description": "This requires the title to include a Jira label"
}

400

Bad request

403

Unauthenticated

404

Not found

Create a project for a user

Authorizations

Parameters

Path Parameters

Example

Request Body required

Example

Example

Example

Responses

201

Example

400

403

404

Request Body^required