GitLab

GET

/v3/application/settings

Get the current application settings

Responses

200Get the current application settings

Body

Name	Data Type	Description
`ApplicationSetting`	object	Modify application settings

Properties

`user_oauth_applications`	string
`updated_at`	string
`signup_enabled`	string
`signin_enabled`	string
`sign_in_text`	string
`session_expire_delay`	string
`restricted_visibility_levels`	string
`repository_storages`	string
`repository_storage`	string
`plantuml_url`	string
`plantuml_enabled`	string
`max_attachment_size`	string
`koding_url`	string
`koding_enabled`	string
`id`	string
`home_page_url`	string
`gravatar_enabled`	string
`domain_whitelist`	string
`domain_blacklist_enabled`	string
`domain_blacklist`	string
`default_snippet_visibility`	string
`default_projects_limit`	string
`default_project_visibility`	string
`default_group_visibility`	string
`default_branch_protection`	string
`created_at`	string
`container_registry_token_expire_delay`	string
`after_sign_up_text`	string
`after_sign_out_path`	string

PUT

/v3/application/settings

Modify application settings

Request

Form Data

Name	Data Type	Description
`housekeeping_gc_period`	integer	Number of Git pushes after which 'git gc' is run.
`housekeeping_full_repack_period`	integer	Number of Git pushes after which a full 'git repack' is run.
`housekeeping_incremental_repack_period`	integer	Number of Git pushes after which an incremental 'git repack' is run.
`housekeeping_bitmaps_enabled`	boolean	Creating pack file bitmaps makes housekeeping take a little longer but bitmaps should accelerate 'git clone' performance.
`housekeeping_enabled`	boolean	Enable automatic repository housekeeping (git repack, git gc)
`html_emails_enabled`	boolean	By default GitLab sends emails in HTML and plain text formats so mail clients can choose what format to use. Disable this option if you only want to send emails in plain text format.
`email_author_in_body`	boolean	Some email servers do not support overriding the email sender name. Enable this option to include the name of the author of the issue, merge request or comment in the email body instead.
`version_check_enabled`	boolean	Let GitLab inform you when an update is available.
`plantuml_url`	string	The PlantUML server URL
`plantuml_enabled`	boolean	Enable PlantUML
`koding_url`	string	The Koding team URL
`koding_enabled`	boolean	Enable Koding
`repository_checks_enabled`	boolean	GitLab will periodically run 'git fsck' in all project and wiki repositories to look for silent disk corruption issues.
`repository_storage`	string	Storage paths for new projects
`sentry_dsn`	string	Sentry Data Source Name
`sentry_enabled`	boolean	Sentry is an error reporting and logging tool which is currently not shipped with GitLab, get it here: https://getsentry.com
`admin_notification_email`	string	Abuse reports will be sent to this address if it is set. Abuse reports are always available in the admin area.
`akismet_api_key`	string	Generate API key at http://www.akismet.com
`akismet_enabled`	boolean	Helps prevent bots from creating issues
`recaptcha_private_key`	string	Generate private key at http://www.google.com/recaptcha
`recaptcha_site_key`	string	Generate site key at http://www.google.com/recaptcha
`recaptcha_enabled`	boolean	Helps prevent bots from creating accounts
`sidekiq_throttling_factor`	float	The factor by which the queues should be throttled. A value between 0.0 and 1.0, exclusive.
`sidekiq_throttling_queus`	array	Choose which queues you wish to throttle
`sidekiq_throttling_enabled`	boolean	Enable Sidekiq Job Throttling
`metrics_packet_size`	integer	The amount of points to store in a single UDP packet
`metrics_sample_interval`	integer	The sampling interval in seconds
`metrics_method_call_threshold`	integer	A method call is only tracked when it takes longer to complete than the given amount of milliseconds.
`metrics_timeout`	integer	The amount of seconds after which an InfluxDB connection will time out
`metrics_pool_size`	integer	The amount of InfluxDB connections to open
`metrics_port`	integer	The UDP port to use for connecting to InfluxDB
`metrics_host`	string	The InfluxDB host
`metrics_enabled`	boolean	Enable the InfluxDB metrics
`container_registry_token_expire_delay`	integer	Authorization token duration (minutes)
`max_artifacts_size`	integer	Set the maximum file size each build's artifacts can have
`shared_runners_text`	string	Shared runners text
`shared_runners_enabled`	boolean	Enable shared runners for new projects
`help_page_text`	string	Custom text displayed on the help page
`sign_in_text`	string	The sign in text of the GitLab application
`after_sign_out_path`	string	We will redirect users to this page after they sign out
`home_page_url`	string	We will redirect non-logged in users to this page
`two_factor_grace_period`	integer	Amount of time (in hours) that users are allowed to skip forced configuration of two-factor authentication
`require_two_factor_authentication`	boolean	Require all users to setup Two-factor authentication
`signin_enabled`	boolean	Flag indicating if sign in is enabled
`after_sign_up_text`	string	Text shown after sign up
`domain_blacklist`	string	Users with e-mail addresses that match these domain(s) will NOT be able to sign-up. Wildcards allowed. Use separate lines for multiple entries. Ex: domain.com, *.domain.com
`domain_blacklist_enabled`	boolean	Enable domain blacklist for sign ups
`domain_whitelist`	string	ONLY users with e-mail addresses that match these domain(s) will be able to sign-up. Wildcards allowed. Use separate lines for multiple entries. Ex: domain.com, *.domain.com
`send_user_confirmation_email`	boolean	Send confirmation email on sign-up
`signup_enabled`	boolean	Flag indicating if sign up is enabled
`user_default_external`	boolean	Newly registered users will by default be external
`user_oauth_applications`	boolean	Allow users to register any application to use GitLab as an OAuth provider
`session_expire_delay`	integer	Session duration in minutes. GitLab restart is required to apply changes.
`max_attachment_size`	integer	Maximum attachment size in MB
`default_projects_limit`	integer	The maximum number of personal projects
`gravatar_enabled`	boolean	Flag indicating if the Gravatar service is enabled
`enabled_git_access_protocol`	string Allowed values: - `ssh` - `http` - `nil`	Allow only the selected protocols to be used for Git access.
`disabled_oauth_sign_in_sources`	array	Disable certain OAuth sign-in sources
`import_sources`	array Allowed values: - `github` - `bitbucket` - `gitlab` - `google_code` - `fogbugz` - `git` - `gitlab_project`	Enabled sources for code import during project creation. OmniAuth must be configured for GitHub, Bitbucket, and GitLab.com
`restricted_visibility_levels`	array	Selected levels cannot be used by non-admin users for projects or snippets. If the public level is restricted, user profiles are only visible to logged in users.
`default_group_visibility`	integer Allowed values: - `0` - `10` - `20`	The default group visibility
`default_snippet_visibility`	integer Allowed values: - `0` - `10` - `20`	The default snippet visibility
`default_project_visibility`	integer Allowed values: - `0` - `10` - `20`	The default project visibility
`default_branch_protection`	integer Allowed values: - `0` - `1` - `2`	Determine if developers can push to master

Responses

200Modify application settings

Body

Name	Data Type	Description
`ApplicationSetting`	object	Modify application settings

Properties

`user_oauth_applications`	string
`updated_at`	string
`signup_enabled`	string
`signin_enabled`	string
`sign_in_text`	string
`session_expire_delay`	string
`restricted_visibility_levels`	string
`repository_storages`	string
`repository_storage`	string
`plantuml_url`	string
`plantuml_enabled`	string
`max_attachment_size`	string
`koding_url`	string
`koding_enabled`	string
`id`	string
`home_page_url`	string
`gravatar_enabled`	string
`domain_whitelist`	string
`domain_blacklist_enabled`	string
`domain_blacklist`	string
`default_snippet_visibility`	string
`default_projects_limit`	string
`default_project_visibility`	string
`default_group_visibility`	string
`default_branch_protection`	string
`created_at`	string
`container_registry_token_expire_delay`	string
`after_sign_up_text`	string
`after_sign_out_path`	string

POST

/v3/ci/lint

Name	Data Type	Description
`content`	string	Content of .gitlab-ci.yml

GET

/v3/deploy_keys

GET

/v3/dockerfiles/{name}

This feature was introduced in GitLab 8.15. This endpoint is deprecated and will be removed in GitLab 9.0.

Request

Path

Name	Data Type	Description
`name`	string	The name of the template

Responses

200Get the text for a specific template present in local filesystem

Body

Name	Data Type	Description
`Template`	object	This feature was introduced in GitLab 8.15. This endpoint is deprecated and will be removed in GitLab 9.0.

Properties

`name`	string
`content`	string

GET

/v3/dockerfiles

Name	Data Type	Description
`TemplatesList`	object	This feature was introduced in GitLab 8.15. This endpoint is deprecated and will be removed in GitLab 9.0.

GET

/v3/gitignores/{name}

This feature was introduced in GitLab 8.8. This endpoint is deprecated and will be removed in GitLab 9.0.

Request

Path

Name	Data Type	Description
`name`	string	The name of the template

Responses

200Get the text for a specific template present in local filesystem

Body

Name	Data Type	Description
`Template`	object	This feature was introduced in GitLab 8.15. This endpoint is deprecated and will be removed in GitLab 9.0.

Properties

`name`	string
`content`	string

GET

/v3/gitignores

Name	Data Type	Description
`TemplatesList`	object	This feature was introduced in GitLab 8.15. This endpoint is deprecated and will be removed in GitLab 9.0.

GET

/v3/gitlab_ci_ymls/{name}

This feature was introduced in GitLab 8.9. This endpoint is deprecated and will be removed in GitLab 9.0.

Request

Path

Name	Data Type	Description
`name`	string	The name of the template

Responses

200Get the text for a specific template present in local filesystem

Body

Name	Data Type	Description
`Template`	object	This feature was introduced in GitLab 8.15. This endpoint is deprecated and will be removed in GitLab 9.0.

Properties

`name`	string
`content`	string

GET

/v3/gitlab_ci_ymls

Name	Data Type	Description
`TemplatesList`	object	This feature was introduced in GitLab 8.15. This endpoint is deprecated and will be removed in GitLab 9.0.

GET

/v3/groups/owned

Get list of owned groups for authenticated user

Request

Query

Name	Data Type	Description
`page`	integer	Current page number
`per_page`	integer	Number of items per page
`statistics`	boolean	Include project statistics

Responses

200Get list of owned groups for authenticated user

Body

Name	Data Type	Description
`Group`	object	Update a group. Available only for users who can administrate groups.

Properties

`web_url`	string
`visibility_level`	string
`statistics`	string
`request_access_enabled`	string
`path`	string
`name`	string
`lfs_enabled`	string
`id`	string
`description`	string
`avatar_url`	string

PUT

/v3/groups/{id}/access_requests/{user_id}/approve

This feature was introduced in GitLab 8.11.

Request

Path

Name	Data Type	Description
`id`	string	The group ID
`user_id`	integer	The user ID of the access requester

Form Data

Name	Data Type	Description
`access_level`	integer	A valid access level (defaults: `30`, developer access level)

Responses

200Approves an access request for the given user.

Body

Name	Data Type	Description
`Member`	object	Updates a member of a group or project.

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`expires_at`	string
`avatar_url`	string
`access_level`	string

DELETE

/v3/groups/{id}/access_requests/{user_id}

GET

/v3/groups/{id}/access_requests

This feature was introduced in GitLab 8.11.

Request

Path

Name	Data Type	Description
`id`	string	The group ID

Query

Name	Data Type	Description
`page`	integer	Current page number
`per_page`	integer	Number of items per page

Responses

200Gets a list of access requests for a group.

Body

Name	Data Type	Description
`AccessRequester`	object	This feature was introduced in GitLab 8.11.

Properties

`web_url`	string
`username`	string
`state`	string
`requested_at`	string
`name`	string
`id`	string
`avatar_url`	string

POST

/v3/groups/{id}/access_requests

This feature was introduced in GitLab 8.11.

Request

Path

Name	Data Type	Description
`id`	string	The group ID

Responses

201Requests access for the authenticated user to a group.

Body

Name	Data Type	Description
`AccessRequester`	object	This feature was introduced in GitLab 8.11.

Properties

`web_url`	string
`username`	string
`state`	string
`requested_at`	string
`name`	string
`id`	string
`avatar_url`	string

GET

/v3/groups/{id}/issues

Get a list of group issues

Request

Path

Name	Data Type	Description
`id`	string	The ID of a group

Query

Name	Data Type	Description
`state`	string Default value: `opened` Allowed values: - `opened` - `closed` - `all`	Return opened, closed, or all issues
`labels`	string	Comma-separated list of label names
`milestone`	string	Return issues for a specific milestone
`order_by`	string Default value: `created_at` Allowed values: - `created_at` - `updated_at`	Return issues ordered by `created_at` or `updated_at` fields.
`sort`	string Default value: `desc` Allowed values: - `asc` - `desc`	Return issues sorted in `asc` or `desc` order.
`page`	integer	Current page number
`per_page`	integer	Number of items per page

Responses

200Get a list of group issues

Body

Name	Data Type	Description
`Issue`	object	Get currently authenticated user's issues

Properties

web_url string

user_notes_count string

upvotes string

updated_at string

title string

subscribed string

state string

project_id string

milestone Milestone


                        Milestone

object

Update an existing project milestone

Properties

`updated_at`	string
`title`	string
`state`	string
`start_date`	string
`project_id`	string
`iid`	string
`id`	string
`due_date`	string
`description`	string
`created_at`	string

labels string

iid string

id string

due_date string

downvotes string

description string

created_at string

confidential string

author UserBasic


                        UserBasic

object

Get a single user

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`avatar_url`	string

assignee UserBasic


                        UserBasic

object

Get a single user

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`avatar_url`	string

DELETE

/v3/groups/{id}/members/{user_id}

GET

/v3/groups/{id}/members/{user_id}

Gets a member of a group or project.

Request

Path

Name	Data Type	Description
`id`	string	The group ID
`user_id`	integer	The user ID of the member

Responses

200Gets a member of a group or project.

Body

Name	Data Type	Description
`Member`	object	Updates a member of a group or project.

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`expires_at`	string
`avatar_url`	string
`access_level`	string

PUT

/v3/groups/{id}/members/{user_id}

Updates a member of a group or project.

Request

Path

Name	Data Type	Description
`id`	string	The group ID
`user_id`	integer	The user ID of the new member

Form Data

Name	Data Type	Description
`access_level`	integer	A valid access level
`expires_at`	dateTime	Date string in the format YEAR-MONTH-DAY

Responses

200Updates a member of a group or project.

Body

Name	Data Type	Description
`Member`	object	Updates a member of a group or project.

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`expires_at`	string
`avatar_url`	string
`access_level`	string

GET

/v3/groups/{id}/members

Gets a list of group or project members viewable by the authenticated user.

Request

Path

Name	Data Type	Description
`id`	string	The group ID

Query

Name	Data Type	Description
`query`	string	A query string to search for members
`page`	integer	Current page number
`per_page`	integer	Number of items per page

Responses

200Gets a list of group or project members viewable by the authenticated user.

Body

Name	Data Type	Description
`Member`	object	Updates a member of a group or project.

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`expires_at`	string
`avatar_url`	string
`access_level`	string

POST

/v3/groups/{id}/members

Adds a member to a group or project.

Request

Path

Name	Data Type	Description
`id`	string	The group ID

Form Data

Name	Data Type	Description
`user_id`	integer	The user ID of the new member
`access_level`	integer	A valid access level (defaults: `30`, developer access level)
`expires_at`	dateTime	Date string in the format YEAR-MONTH-DAY

Responses

201Adds a member to a group or project.

Body

Name	Data Type	Description
`Member`	object	Updates a member of a group or project.

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`expires_at`	string
`avatar_url`	string
`access_level`	string

GET

/v3/groups/{id}/notification_settings

This feature was introduced in GitLab 8.12

Request

Path

Name	Data Type	Description
`id`	string	The group ID or project ID or project NAMESPACE/PROJECT_NAME

Responses

200Get group level notification level settings, defaults to Global

Body

Name	Data Type	Description
`NotificationSetting`	object	This feature was introduced in GitLab 8.12

Properties

`level`	string
`events`	string

PUT

/v3/groups/{id}/notification_settings

This feature was introduced in GitLab 8.12

Request

Path

Name	Data Type	Description
`id`	string	The group ID or project ID or project NAMESPACE/PROJECT_NAME

Form Data

Name	Data Type	Description
`level`	string	The group notification level
`new_note`	boolean	Enable/disable this notification
`new_issue`	boolean	Enable/disable this notification
`reopen_issue`	boolean	Enable/disable this notification
`close_issue`	boolean	Enable/disable this notification
`reassign_issue`	boolean	Enable/disable this notification
`new_merge_request`	boolean	Enable/disable this notification
`reopen_merge_request`	boolean	Enable/disable this notification
`close_merge_request`	boolean	Enable/disable this notification
`reassign_merge_request`	boolean	Enable/disable this notification
`merge_merge_request`	boolean	Enable/disable this notification
`failed_pipeline`	boolean	Enable/disable this notification
`success_pipeline`	boolean	Enable/disable this notification

Responses

200Update group level notification level settings, defaults to Global

Body

Name	Data Type	Description
`NotificationSetting`	object	This feature was introduced in GitLab 8.12

Properties

`level`	string
`events`	string

POST

/v3/groups/{id}/projects/{project_id}

Transfer a project to the group namespace. Available only for admin.

Request

Path

Name	Data Type	Description
`id`	string	The ID of a group
`project_id`	string	The ID or path of the project

Responses

201Transfer a project to the group namespace. Available only for admin.

Body

Name	Data Type	Description
`GroupDetail`	object	Transfer a project to the group namespace. Available only for admin.

Properties

web_url string

visibility_level string

statistics string

shared_projects Project


                        Project

object

Unstar a project

Properties

archived string

avatar_url string

builds_enabled string

container_registry_enabled string

created_at string

creator_id string

default_branch string

description string

forked_from_project BasicProjectDetails


                        BasicProjectDetails

object

Get all projects for admin user

Properties

`web_url`	string
`path_with_namespace`	string
`path`	string
`name_with_namespace`	string
`name`	string
`id`	string
`http_url_to_repo`	string

forks_count string

http_url_to_repo string

id string

issues_enabled string

last_activity_at string

lfs_enabled string

merge_requests_enabled string

name string

name_with_namespace string

namespace Namespace


                        Namespace

object

Get a namespaces list

Properties

`path`	string
`name`	string
`kind`	string
`id`	string

only_allow_merge_if_all_discussions_are_resolved string

only_allow_merge_if_build_succeeds string

open_issues_count string

owner UserBasic


                        UserBasic

object

Get a single user

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`avatar_url`	string

path string

path_with_namespace string

public string

public_builds string

request_access_enabled string

runners_token string

shared_runners_enabled string

shared_with_groups string

snippets_enabled string

ssh_url_to_repo string

star_count string

statistics ProjectStatistics

ProjectStatistics object

Properties

`storage_size`	string
`repository_size`	string
`lfs_objects_size`	string
`commit_count`	string
`build_artifacts_size`	string

tag_list string

visibility_level string

web_url string

wiki_enabled string

request_access_enabled string

projects Project


                        Project

object

Unstar a project

Properties

archived string

avatar_url string

builds_enabled string

container_registry_enabled string

created_at string

creator_id string

default_branch string

description string

forked_from_project BasicProjectDetails


                        BasicProjectDetails

object

Get all projects for admin user

Properties

`web_url`	string
`path_with_namespace`	string
`path`	string
`name_with_namespace`	string
`name`	string
`id`	string
`http_url_to_repo`	string

forks_count string

http_url_to_repo string

id string

issues_enabled string

last_activity_at string

lfs_enabled string

merge_requests_enabled string

name string

name_with_namespace string

namespace Namespace


                        Namespace

object

Get a namespaces list

Properties

`path`	string
`name`	string
`kind`	string
`id`	string

only_allow_merge_if_all_discussions_are_resolved string

only_allow_merge_if_build_succeeds string

open_issues_count string

owner UserBasic


                        UserBasic

object

Get a single user

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`avatar_url`	string

path string

path_with_namespace string

public string

public_builds string

request_access_enabled string

runners_token string

shared_runners_enabled string

shared_with_groups string

snippets_enabled string

ssh_url_to_repo string

star_count string

statistics ProjectStatistics

ProjectStatistics object

Properties

`storage_size`	string
`repository_size`	string
`lfs_objects_size`	string
`commit_count`	string
`build_artifacts_size`	string

tag_list string

visibility_level string

web_url string

wiki_enabled string

path string

name string

lfs_enabled string

id string

description string

avatar_url string

GET

/v3/groups/{id}/projects

Get a list of projects in this group.

Request

Path

Name	Data Type	Description
`id`	string	The ID of a group

Query

Name	Data Type	Description
`archived`	boolean	Limit by archived status
`visibility`	string Allowed values: - `public` - `internal` - `private`	Limit by visibility
`search`	string	Return list of authorized projects matching the search criteria
`order_by`	string Default value: `created_at` Allowed values: - `id` - `name` - `path` - `created_at` - `updated_at` - `last_activity_at`	Return projects ordered by field
`sort`	string Default value: `desc` Allowed values: - `asc` - `desc`	Return projects sorted in ascending and descending order
`simple`	boolean	Return only the ID, URL, name, and path of each project
`page`	integer	Current page number
`per_page`	integer	Number of items per page

Responses

200Get a list of projects in this group.

Body

Name	Data Type	Description
`Project`	object	Unstar a project

Properties

archived string

avatar_url string

builds_enabled string

container_registry_enabled string

created_at string

creator_id string

default_branch string

description string

forked_from_project BasicProjectDetails


                        BasicProjectDetails

object

Get all projects for admin user

Properties

`web_url`	string
`path_with_namespace`	string
`path`	string
`name_with_namespace`	string
`name`	string
`id`	string
`http_url_to_repo`	string

forks_count string

http_url_to_repo string

id string

issues_enabled string

last_activity_at string

lfs_enabled string

merge_requests_enabled string

name string

name_with_namespace string

namespace Namespace


                        Namespace

object

Get a namespaces list

Properties

`path`	string
`name`	string
`kind`	string
`id`	string

only_allow_merge_if_all_discussions_are_resolved string

only_allow_merge_if_build_succeeds string

open_issues_count string

owner UserBasic


                        UserBasic

object

Get a single user

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`avatar_url`	string

path string

path_with_namespace string

public string

public_builds string

request_access_enabled string

runners_token string

shared_runners_enabled string

shared_with_groups string

snippets_enabled string

ssh_url_to_repo string

star_count string

statistics ProjectStatistics

ProjectStatistics object

Properties

`storage_size`	string
`repository_size`	string
`lfs_objects_size`	string
`commit_count`	string
`build_artifacts_size`	string

tag_list string

visibility_level string

web_url string

wiki_enabled string

DELETE

/v3/groups/{id}

GET

/v3/groups/{id}

Get a single group, with containing projects.

Request

Path

Name	Data Type	Description
`id`	string	The ID of a group

Responses

200Get a single group, with containing projects.

Body

Name	Data Type	Description
`GroupDetail`	object	Transfer a project to the group namespace. Available only for admin.

Properties

web_url string

visibility_level string

statistics string

shared_projects Project


                        Project

object

Unstar a project

Properties

archived string

avatar_url string

builds_enabled string

container_registry_enabled string

created_at string

creator_id string

default_branch string

description string

forked_from_project BasicProjectDetails


                        BasicProjectDetails

object

Get all projects for admin user

Properties

`web_url`	string
`path_with_namespace`	string
`path`	string
`name_with_namespace`	string
`name`	string
`id`	string
`http_url_to_repo`	string

forks_count string

http_url_to_repo string

id string

issues_enabled string

last_activity_at string

lfs_enabled string

merge_requests_enabled string

name string

name_with_namespace string

namespace Namespace


                        Namespace

object

Get a namespaces list

Properties

`path`	string
`name`	string
`kind`	string
`id`	string

only_allow_merge_if_all_discussions_are_resolved string

only_allow_merge_if_build_succeeds string

open_issues_count string

owner UserBasic


                        UserBasic

object

Get a single user

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`avatar_url`	string

path string

path_with_namespace string

public string

public_builds string

request_access_enabled string

runners_token string

shared_runners_enabled string

shared_with_groups string

snippets_enabled string

ssh_url_to_repo string

star_count string

statistics ProjectStatistics

ProjectStatistics object

Properties

`storage_size`	string
`repository_size`	string
`lfs_objects_size`	string
`commit_count`	string
`build_artifacts_size`	string

tag_list string

visibility_level string

web_url string

wiki_enabled string

request_access_enabled string

projects Project


                        Project

object

Unstar a project

Properties

archived string

avatar_url string

builds_enabled string

container_registry_enabled string

created_at string

creator_id string

default_branch string

description string

forked_from_project BasicProjectDetails


                        BasicProjectDetails

object

Get all projects for admin user

Properties

`web_url`	string
`path_with_namespace`	string
`path`	string
`name_with_namespace`	string
`name`	string
`id`	string
`http_url_to_repo`	string

forks_count string

http_url_to_repo string

id string

issues_enabled string

last_activity_at string

lfs_enabled string

merge_requests_enabled string

name string

name_with_namespace string

namespace Namespace


                        Namespace

object

Get a namespaces list

Properties

`path`	string
`name`	string
`kind`	string
`id`	string

only_allow_merge_if_all_discussions_are_resolved string

only_allow_merge_if_build_succeeds string

open_issues_count string

owner UserBasic


                        UserBasic

object

Get a single user

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`avatar_url`	string

path string

path_with_namespace string

public string

public_builds string

request_access_enabled string

runners_token string

shared_runners_enabled string

shared_with_groups string

snippets_enabled string

ssh_url_to_repo string

star_count string

statistics ProjectStatistics

ProjectStatistics object

Properties

`storage_size`	string
`repository_size`	string
`lfs_objects_size`	string
`commit_count`	string
`build_artifacts_size`	string

tag_list string

visibility_level string

web_url string

wiki_enabled string

path string

name string

lfs_enabled string

id string

description string

avatar_url string

PUT

/v3/groups/{id}

Update a group. Available only for users who can administrate groups.

Request

Path

Name	Data Type	Description
`id`	string	The ID of a group

Form Data

Name	Data Type	Description
`name`	string	The name of the group
`path`	string	The path of the group
`description`	string	The description of the group
`visibility_level`	integer	The visibility level of the group
`lfs_enabled`	boolean	Enable/disable LFS for the projects in this group
`request_access_enabled`	boolean	Allow users to request member access

Responses

200Update a group. Available only for users who can administrate groups.

Body

Name	Data Type	Description
`Group`	object	Update a group. Available only for users who can administrate groups.

Properties

`web_url`	string
`visibility_level`	string
`statistics`	string
`request_access_enabled`	string
`path`	string
`name`	string
`lfs_enabled`	string
`id`	string
`description`	string
`avatar_url`	string

GET

/v3/groups

Get a groups list

Request

Query

Name	Data Type	Description
`statistics`	boolean	Include project statistics
`all_available`	boolean	Show all group that you have access to
`search`	string	Search for a specific group
`order_by`	string Default value: `name` Allowed values: - `name` - `path`	Order by name or path
`sort`	string Default value: `asc` Allowed values: - `asc` - `desc`	Sort by asc (ascending) or desc (descending)
`page`	integer	Current page number
`per_page`	integer	Number of items per page

Form Data

Name	Data Type	Description
`skip_groups`	array	Array of group ids to exclude from list

Responses

200Get a groups list

Body

Name	Data Type	Description
`Group`	object	Update a group. Available only for users who can administrate groups.

Properties

`web_url`	string
`visibility_level`	string
`statistics`	string
`request_access_enabled`	string
`path`	string
`name`	string
`lfs_enabled`	string
`id`	string
`description`	string
`avatar_url`	string

POST

/v3/groups

Create a group. Available only for users who can create groups.

Request

Form Data

Name	Data Type	Description
`name`	string	The name of the group
`path`	string	The path of the group
`description`	string	The description of the group
`visibility_level`	integer	The visibility level of the group
`lfs_enabled`	boolean	Enable/disable LFS for the projects in this group
`request_access_enabled`	boolean	Allow users to request member access

Responses

201Create a group. Available only for users who can create groups.

Body

Name	Data Type	Description
`Group`	object	Update a group. Available only for users who can administrate groups.

Properties

`web_url`	string
`visibility_level`	string
`statistics`	string
`request_access_enabled`	string
`path`	string
`name`	string
`lfs_enabled`	string
`id`	string
`description`	string
`avatar_url`	string

DELETE

/v3/hooks/{id}

Delete a hook

Request

Path

Name	Data Type	Description
`id`	integer	The ID of the system hook

Responses

200Delete a hook

Body

Name	Data Type	Description
`Hook`	object	Delete a hook

Properties

`url`	string
`tag_push_events`	string
`push_events`	string
`id`	string
`enable_ssl_verification`	string
`created_at`	string

GET

/v3/hooks/{id}

Test a hook

Request

Path

Name	Data Type	Description
`id`	integer	The ID of the system hook

Responses

200Test a hook

Body

Name	Data Type	Description
`Hook`	object	Delete a hook

Properties

`url`	string
`tag_push_events`	string
`push_events`	string
`id`	string
`enable_ssl_verification`	string
`created_at`	string

GET

/v3/hooks

Get the list of system hooks

Responses

200Get the list of system hooks

Body

Name	Data Type	Description
`Hook`	object	Delete a hook

Properties

`url`	string
`tag_push_events`	string
`push_events`	string
`id`	string
`enable_ssl_verification`	string
`created_at`	string

POST

/v3/hooks

Create a new system hook

Request

Form Data

Name	Data Type	Description
`url`	string	The URL to send the request to
`token`	string	The token used to validate payloads
`push_events`	boolean	Trigger hook on push events
`tag_push_events`	boolean	Trigger hook on tag push events
`enable_ssl_verification`	boolean	Do SSL verification when triggering the hook

Responses

201Create a new system hook

Body

Name	Data Type	Description
`Hook`	object	Delete a hook

Properties

`url`	string
`tag_push_events`	string
`push_events`	string
`id`	string
`enable_ssl_verification`	string
`created_at`	string

POST

/v3/internal/allowed

GET

/v3/internal/broadcast_message

GET

/v3/internal/check

GET

/v3/internal/discover

POST

/v3/internal/lfs_authenticate

GET

/v3/internal/merge_request_urls

POST

/v3/internal/two_factor_recovery_codes

GET

/v3/issues

Get currently authenticated user's issues

Request

Query

Name	Data Type	Description
`state`	string Default value: `all` Allowed values: - `opened` - `closed` - `all`	Return opened, closed, or all issues
`labels`	string	Comma-separated list of label names
`milestone`	string	Return issues for a specific milestone
`order_by`	string Default value: `created_at` Allowed values: - `created_at` - `updated_at`	Return issues ordered by `created_at` or `updated_at` fields.
`sort`	string Default value: `desc` Allowed values: - `asc` - `desc`	Return issues sorted in `asc` or `desc` order.
`page`	integer	Current page number
`per_page`	integer	Number of items per page

Responses

200Get currently authenticated user's issues

Body

Name	Data Type	Description
`Issue`	object	Get currently authenticated user's issues

Properties

web_url string

user_notes_count string

upvotes string

updated_at string

title string

subscribed string

state string

project_id string

milestone Milestone


                        Milestone

object

Update an existing project milestone

Properties

`updated_at`	string
`title`	string
`state`	string
`start_date`	string
`project_id`	string
`iid`	string
`id`	string
`due_date`	string
`description`	string
`created_at`	string

labels string

iid string

id string

due_date string

downvotes string

description string

created_at string

confidential string

author UserBasic


                        UserBasic

object

Get a single user

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`avatar_url`	string

assignee UserBasic


                        UserBasic

object

Get a single user

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`avatar_url`	string

GET

/v3/keys/{id}

Get single ssh key by id. Only available to admin users

Request

Path

Name	Data Type	Description
`id`	integer

Responses

200Get single ssh key by id. Only available to admin users

Body

Name	Data Type	Description
`SSHKeyWithUser`	object	Get single ssh key by id. Only available to admin users

Properties

user UserPublic


                        UserPublic

object

Get the currently authenticated user

Properties

avatar_url string

bio string

can_create_group string

can_create_project string

color_scheme_id string

confirmed_at string

created_at string

current_sign_in_at string

email string

external string

id string

identities Identity

Identity object

Properties

`provider`	string
`extern_uid`	string

is_admin string

last_sign_in_at string

linkedin string

location string

name string

organization string

projects_limit string

skype string

state string

theme_id string

twitter string

two_factor_enabled string

username string

web_url string

website_url string

title string

key string

id string

created_at string

can_push string

GET

/v3/licenses/{name}

This feature was introduced in GitLab 8.7. This endpoint is deprecated and will be removed in GitLab 9.0.

Request

Path

Name	Data Type	Description
`name`	string	The name of the template

Responses

200Get the text for a specific license

Body

Name	Data Type	Description
`RepoLicense`	object	This feature was introduced in GitLab 8.7.

Properties

`source_url`	string
`popular`	string
`permissions`	string
`nickname`	string
`name`	string
`limitations`	string
`key`	string
`html_url`	string
`description`	string
`content`	string
`conditions`	string

GET

/v3/licenses

This feature was introduced in GitLab 8.7. This endpoint is deprecated and will be removed in GitLab 9.0.

Request

Query

Name	Data Type	Description
`popular`	boolean	If passed, returns only popular licenses

Responses

200Get the list of the available license template

Body

Name	Data Type	Description
`RepoLicense`	object	This feature was introduced in GitLab 8.7.

Properties

`source_url`	string
`popular`	string
`permissions`	string
`nickname`	string
`name`	string
`limitations`	string
`key`	string
`html_url`	string
`description`	string
`content`	string
`conditions`	string

GET

/v3/namespaces

Get a namespaces list

Request

Query

Name	Data Type	Description
`search`	string	Search query for namespaces
`page`	integer	Current page number
`per_page`	integer	Number of items per page

Responses

200Get a namespaces list

Body

Name	Data Type	Description
`Namespace`	object	Get a namespaces list

Properties

`path`	string
`name`	string
`kind`	string
`id`	string

GET

/v3/notification_settings

PUT

/v3/notification_settings

This feature was introduced in GitLab 8.12

Request

Form Data

Name	Data Type	Description
`level`	string	The global notification level
`notification_email`	string	The email address to send notifications
`new_note`	boolean	Enable/disable this notification
`new_issue`	boolean	Enable/disable this notification
`reopen_issue`	boolean	Enable/disable this notification
`close_issue`	boolean	Enable/disable this notification
`reassign_issue`	boolean	Enable/disable this notification
`new_merge_request`	boolean	Enable/disable this notification
`reopen_merge_request`	boolean	Enable/disable this notification
`close_merge_request`	boolean	Enable/disable this notification
`reassign_merge_request`	boolean	Enable/disable this notification
`merge_merge_request`	boolean	Enable/disable this notification
`failed_pipeline`	boolean	Enable/disable this notification
`success_pipeline`	boolean	Enable/disable this notification

Responses

200Update global notification level settings and email, defaults to Participate

Body

Name	Data Type	Description
`GlobalNotificationSetting`	object	This feature was introduced in GitLab 8.12

Properties

`notification_email`	string
`level`	string
`events`	string

GET

/v3/projects/all

Get all projects for admin user

Request

Query

Name	Data Type	Description
`order_by`	string Default value: `created_at` Allowed values: - `id` - `name` - `path` - `created_at` - `updated_at` - `last_activity_at`	Return projects ordered by field
`sort`	string Default value: `desc` Allowed values: - `asc` - `desc`	Return projects sorted in ascending and descending order
`archived`	boolean	Limit by archived status
`visibility`	string Allowed values: - `public` - `internal` - `private`	Limit by visibility
`search`	string	Return list of authorized projects matching the search criteria
`page`	integer	Current page number
`per_page`	integer	Number of items per page
`simple`	boolean	Return only the ID, URL, name, and path of each project
`statistics`	boolean	Include project statistics

Responses

200Get all projects for admin user

Body

Name	Data Type	Description
`BasicProjectDetails`	object	Get all projects for admin user

Properties

`web_url`	string
`path_with_namespace`	string
`path`	string
`name_with_namespace`	string
`name`	string
`id`	string
`http_url_to_repo`	string

POST

/v3/projects/fork/{id}

Fork new project for the current user or provided namespace.

Request

Path

Name	Data Type	Description
`id`	string	The ID of a project

Form Data

Name	Data Type	Description
`namespace`	string	The ID or name of the namespace that the project will be forked into

Responses

201Fork new project for the current user or provided namespace.

Body

Name	Data Type	Description
`Project`	object	Unstar a project

Properties

archived string

avatar_url string

builds_enabled string

container_registry_enabled string

created_at string

creator_id string

default_branch string

description string

forked_from_project BasicProjectDetails


                        BasicProjectDetails

object

Get all projects for admin user

Properties

`web_url`	string
`path_with_namespace`	string
`path`	string
`name_with_namespace`	string
`name`	string
`id`	string
`http_url_to_repo`	string

forks_count string

http_url_to_repo string

id string

issues_enabled string

last_activity_at string

lfs_enabled string

merge_requests_enabled string

name string

name_with_namespace string

namespace Namespace


                        Namespace

object

Get a namespaces list

Properties

`path`	string
`name`	string
`kind`	string
`id`	string

only_allow_merge_if_all_discussions_are_resolved string

only_allow_merge_if_build_succeeds string

open_issues_count string

owner UserBasic


                        UserBasic

object

Get a single user

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`avatar_url`	string

path string

path_with_namespace string

public string

public_builds string

request_access_enabled string

runners_token string

shared_runners_enabled string

shared_with_groups string

snippets_enabled string

ssh_url_to_repo string

star_count string

statistics ProjectStatistics

ProjectStatistics object

Properties

`storage_size`	string
`repository_size`	string
`lfs_objects_size`	string
`commit_count`	string
`build_artifacts_size`	string

tag_list string

visibility_level string

web_url string

wiki_enabled string

GET

/v3/projects/owned

Get an owned projects list for authenticated user

Request

Query

Name	Data Type	Description
`order_by`	string Default value: `created_at` Allowed values: - `id` - `name` - `path` - `created_at` - `updated_at` - `last_activity_at`	Return projects ordered by field
`sort`	string Default value: `desc` Allowed values: - `asc` - `desc`	Return projects sorted in ascending and descending order
`archived`	boolean	Limit by archived status
`visibility`	string Allowed values: - `public` - `internal` - `private`	Limit by visibility
`search`	string	Return list of authorized projects matching the search criteria
`page`	integer	Current page number
`per_page`	integer	Number of items per page
`simple`	boolean	Return only the ID, URL, name, and path of each project
`statistics`	boolean	Include project statistics

Responses

200Get an owned projects list for authenticated user

Body

Name	Data Type	Description
`BasicProjectDetails`	object	Get all projects for admin user

Properties

`web_url`	string
`path_with_namespace`	string
`path`	string
`name_with_namespace`	string
`name`	string
`id`	string
`http_url_to_repo`	string

GET

/v3/projects/search/{query}

Search for projects the current user has access to

Request

Path

Name	Data Type	Description
`query`	string	The project name to be searched

Query

Name	Data Type	Description
`order_by`	string Default value: `created_at` Allowed values: - `id` - `name` - `path` - `created_at` - `updated_at` - `last_activity_at`	Return projects ordered by field
`sort`	string Default value: `desc` Allowed values: - `asc` - `desc`	Return projects sorted in ascending and descending order
`page`	integer	Current page number
`per_page`	integer	Number of items per page

Responses

200Search for projects the current user has access to

Body

Name	Data Type	Description
`Project`	object	Unstar a project

Properties

archived string

avatar_url string

builds_enabled string

container_registry_enabled string

created_at string

creator_id string

default_branch string

description string

forked_from_project BasicProjectDetails


                        BasicProjectDetails

object

Get all projects for admin user

Properties

`web_url`	string
`path_with_namespace`	string
`path`	string
`name_with_namespace`	string
`name`	string
`id`	string
`http_url_to_repo`	string

forks_count string

http_url_to_repo string

id string

issues_enabled string

last_activity_at string

lfs_enabled string

merge_requests_enabled string

name string

name_with_namespace string

namespace Namespace


                        Namespace

object

Get a namespaces list

Properties

`path`	string
`name`	string
`kind`	string
`id`	string

only_allow_merge_if_all_discussions_are_resolved string

only_allow_merge_if_build_succeeds string

open_issues_count string

owner UserBasic


                        UserBasic

object

Get a single user

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`avatar_url`	string

path string

path_with_namespace string

public string

public_builds string

request_access_enabled string

runners_token string

shared_runners_enabled string

shared_with_groups string

snippets_enabled string

ssh_url_to_repo string

star_count string

statistics ProjectStatistics

ProjectStatistics object

Properties

`storage_size`	string
`repository_size`	string
`lfs_objects_size`	string
`commit_count`	string
`build_artifacts_size`	string

tag_list string

visibility_level string

web_url string

wiki_enabled string

GET

/v3/projects/starred

Gets starred project for the authenticated user

Request

Query

Name	Data Type	Description
`order_by`	string Default value: `created_at` Allowed values: - `id` - `name` - `path` - `created_at` - `updated_at` - `last_activity_at`	Return projects ordered by field
`sort`	string Default value: `desc` Allowed values: - `asc` - `desc`	Return projects sorted in ascending and descending order
`archived`	boolean	Limit by archived status
`visibility`	string Allowed values: - `public` - `internal` - `private`	Limit by visibility
`search`	string	Return list of authorized projects matching the search criteria
`page`	integer	Current page number
`per_page`	integer	Number of items per page
`simple`	boolean	Return only the ID, URL, name, and path of each project

Responses

200Gets starred project for the authenticated user

Body

Name	Data Type	Description
`BasicProjectDetails`	object	Get all projects for admin user

Properties

`web_url`	string
`path_with_namespace`	string
`path`	string
`name_with_namespace`	string
`name`	string
`id`	string
`http_url_to_repo`	string

POST

/v3/projects/user/{user_id}

Create new project for a specified user. Only available to admin users.

Request

Path

Name	Data Type	Description
`user_id`	integer	The ID of a user

Form Data

Name	Data Type	Description
`import_url`	string	URL from which the project is imported
`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 discussions are resolved
`only_allow_merge_if_build_succeeds`	boolean	Only allow to merge if builds succeed
`request_access_enabled`	boolean	Allow users to request member access
`public_builds`	boolean	Perform public builds
`visibility_level`	integer Allowed values: - `0` - `10` - `20`	Create a public project. The same as visibility_level = 20.
`public`	boolean	Create a public project. The same as visibility_level = 20.
`lfs_enabled`	boolean	Flag indication if Git LFS is enabled for that project
`container_registry_enabled`	boolean	Flag indication if the container registry is enabled for that project
`shared_runners_enabled`	boolean	Flag indication if shared runners are enabled for that project
`snippets_enabled`	boolean	Flag indication if snippets are enabled
`builds_enabled`	boolean	Flag indication if builds are enabled
`wiki_enabled`	boolean	Flag indication if the wiki is enabled
`merge_requests_enabled`	boolean	Flag indication if merge requests are enabled
`issues_enabled`	boolean	Flag indication if the issue tracker is enabled
`description`	string	The description of the project
`default_branch`	string	The default branch of the project
`name`	string	The name of the project

Responses

201Create new project for a specified user. Only available to admin users.

Body

Name	Data Type	Description
`Project`	object	Unstar a project

Properties

archived string

avatar_url string

builds_enabled string

container_registry_enabled string

created_at string

creator_id string

default_branch string

description string

forked_from_project BasicProjectDetails


                        BasicProjectDetails

object

Get all projects for admin user

Properties

`web_url`	string
`path_with_namespace`	string
`path`	string
`name_with_namespace`	string
`name`	string
`id`	string
`http_url_to_repo`	string

forks_count string

http_url_to_repo string

id string

issues_enabled string

last_activity_at string

lfs_enabled string

merge_requests_enabled string

name string

name_with_namespace string

namespace Namespace


                        Namespace

object

Get a namespaces list

Properties

`path`	string
`name`	string
`kind`	string
`id`	string

only_allow_merge_if_all_discussions_are_resolved string

only_allow_merge_if_build_succeeds string

open_issues_count string

owner UserBasic


                        UserBasic

object

Get a single user

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`avatar_url`	string

path string

path_with_namespace string

public string

public_builds string

request_access_enabled string

runners_token string

shared_runners_enabled string

shared_with_groups string

snippets_enabled string

ssh_url_to_repo string

star_count string

statistics ProjectStatistics

ProjectStatistics object

Properties

`storage_size`	string
`repository_size`	string
`lfs_objects_size`	string
`commit_count`	string
`build_artifacts_size`	string

tag_list string

visibility_level string

web_url string

wiki_enabled string

GET

/v3/projects/visible

Get a list of visible projects for authenticated user

Request

Query

Name	Data Type	Description
`order_by`	string Default value: `created_at` Allowed values: - `id` - `name` - `path` - `created_at` - `updated_at` - `last_activity_at`	Return projects ordered by field
`sort`	string Default value: `desc` Allowed values: - `asc` - `desc`	Return projects sorted in ascending and descending order
`archived`	boolean	Limit by archived status
`visibility`	string Allowed values: - `public` - `internal` - `private`	Limit by visibility
`search`	string	Return list of authorized projects matching the search criteria
`page`	integer	Current page number
`per_page`	integer	Number of items per page
`simple`	boolean	Return only the ID, URL, name, and path of each project

Responses

200Get a list of visible projects for authenticated user

Body

Name	Data Type	Description
`BasicProjectDetails`	object	Get all projects for admin user

Properties

`web_url`	string
`path_with_namespace`	string
`path`	string
`name_with_namespace`	string
`name`	string
`id`	string
`http_url_to_repo`	string

POST

/v3/projects/{id}/(ref/{ref}/)trigger/builds

Trigger a GitLab project build

Request

Path

Name	Data Type	Description
`id`	string	The ID of a project
`ref`	string	The commit sha or name of a branch or tag

Form Data

Name	Data Type	Description
`token`	string	The unique token of trigger

Responses

201Trigger a GitLab project build

Body

Name	Data Type	Description
`TriggerRequest`	object	Trigger a GitLab project build

Properties

`variables`	string
`id`	string

PUT

/v3/projects/{id}/access_requests/{user_id}/approve

This feature was introduced in GitLab 8.11.

Request

Path

Name	Data Type	Description
`id`	string	The project ID
`user_id`	integer	The user ID of the access requester

Form Data

Name	Data Type	Description
`access_level`	integer	A valid access level (defaults: `30`, developer access level)

Responses

200Approves an access request for the given user.

Body

Name	Data Type	Description
`Member`	object	Updates a member of a group or project.

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`expires_at`	string
`avatar_url`	string
`access_level`	string

DELETE

/v3/projects/{id}/access_requests/{user_id}

GET

/v3/projects/{id}/access_requests

This feature was introduced in GitLab 8.11.

Request

Path

Name	Data Type	Description
`id`	string	The project ID

Query

Name	Data Type	Description
`page`	integer	Current page number
`per_page`	integer	Number of items per page

Responses

200Gets a list of access requests for a project.

Body

Name	Data Type	Description
`AccessRequester`	object	This feature was introduced in GitLab 8.11.

Properties

`web_url`	string
`username`	string
`state`	string
`requested_at`	string
`name`	string
`id`	string
`avatar_url`	string

POST

/v3/projects/{id}/access_requests

This feature was introduced in GitLab 8.11.

Request

Path

Name	Data Type	Description
`id`	string	The project ID

Responses

201Requests access for the authenticated user to a project.

Body

Name	Data Type	Description
`AccessRequester`	object	This feature was introduced in GitLab 8.11.

Properties

`web_url`	string
`username`	string
`state`	string
`requested_at`	string
`name`	string
`id`	string
`avatar_url`	string

POST

/v3/projects/{id}/archive

Archive a project

Request

Path

Name	Data Type	Description
`id`	string	The ID of a project

Responses

201Archive a project

Body

Name	Data Type	Description
`Project`	object	Unstar a project

Properties

archived string

avatar_url string

builds_enabled string

container_registry_enabled string

created_at string

creator_id string

default_branch string

description string

forked_from_project BasicProjectDetails


                        BasicProjectDetails

object

Get all projects for admin user

Properties

`web_url`	string
`path_with_namespace`	string
`path`	string
`name_with_namespace`	string
`name`	string
`id`	string
`http_url_to_repo`	string

forks_count string

http_url_to_repo string

id string

issues_enabled string

last_activity_at string

lfs_enabled string

merge_requests_enabled string

name string

name_with_namespace string

namespace Namespace


                        Namespace

object

Get a namespaces list

Properties

`path`	string
`name`	string
`kind`	string
`id`	string

only_allow_merge_if_all_discussions_are_resolved string

only_allow_merge_if_build_succeeds string

open_issues_count string

owner UserBasic


                        UserBasic

object

Get a single user

Properties

`web_url`	string
`username`	string
`state`	string
`name`	string
`id`	string
`avatar_url`	string

path string

path_with_namespace string

public string

public_builds string

request_access_enabled string

runners_token string

shared_runners_enabled string

shared_with_groups string

snippets_enabled string

ssh_url_to_repo string

star_count string

statistics ProjectStatistics

ProjectStatistics object

Properties

`storage_size`	string
`repository_size`	string
`lfs_objects_size`	string
`commit_count`	string
`build_artifacts_size`	string

tag_list string

visibility_level string

web_url string

wiki_enabled string

DELETE

/v3/projects/{id}/boards/{board_id}/lists/{list_id}

This feature was introduced in 8.13

Request

Path

Name	Data Type	Description
`id`	string	The ID of a project
`board_id`	integer	The ID of a board
`list_id`	integer	The ID of a board list

Responses

200Delete a board list

Body

Name	Data Type	Description
`List`	object	This feature was introduced in 8.13

Properties

position string

label LabelBasic

LabelBasic object

Properties

`name`	string
`id`	string
`description`	string
`color`	string

id string

GET

/v3/projects/{id}/boards/{board_id}/lists/{list_id}

This feature was introduced in 8.13

Request

Path

Name	Data Type	Description
`id`	string	The ID of a project
`board_id`	integer	The ID of a board
`list_id`	integer	The ID of a list

Responses

200Get a list of a project board

Body

Name	Data Type	Description
`List`	object	This feature was introduced in 8.13

Properties

position string

label LabelBasic

LabelBasic object

Properties

`name`	string
`id`	string
`description`	string
`color`	string

id string

PUT

/v3/projects/{id}/boards/{board_id}/lists/{list_id}

This feature was introduced in 8.13

Request

Path

Name	Data Type	Description
`id`	string	The ID of a project
`board_id`	integer	The ID of a board
`list_id`	integer	The ID of a list

Form Data

Name	Data Type	Description
`position`	integer	The position of the list

Responses

200Moves a board list to a new position

Body

Name	Data Type	Description
`List`	object	This feature was introduced in 8.13

Properties

position string

label LabelBasic

LabelBasic object

Properties

`name`	string
`id`	string
`description`	string
`color`	string

id string

GET

/v3/projects/{id}/boards/{board_id}/lists

Does not include backlog and done lists. This feature was introduced in 8.13

Request

Path

Name	Data Type	Description
`id`	string	The ID of a project
`board_id`	integer	The ID of a board

Responses

200Get the lists of a project board

Body

Name	Data Type	Description
`List`	object	This feature was introduced in 8.13

Properties

position string

label LabelBasic

LabelBasic object

Properties

`name`	string
`id`	string
`description`	string
`color`	string

id string

POST

/v3/projects/{id}/boards/{board_id}/lists

This feature was introduced in 8.13

Request

Path

Name	Data Type	Description
`id`	string	The ID of a project
`board_id`	integer	The ID of a board

Form Data

Name	Data Type	Description
`label_id`	integer	The ID of an existing label

Responses

201Create a new board list

Body

Name	Data Type	Description
`List`	object	This feature was introduced in 8.13

Properties

position string

label LabelBasic

LabelBasic object

Properties

`name`	string
`id`	string
`description`	string
`color`	string

id string

GET

/v3/projects/{id}/boards

This feature was introduced in 8.13

Request

Path

Name	Data Type	Description
`id`	string	The ID of a project

Responses

200Get all project boards

Body

Name	Data Type	Description
`Board`	object	This feature was introduced in 8.13

Properties

lists List


                        List

object

This feature was introduced in 8.13

Properties

position string

label LabelBasic

LabelBasic object

Properties

`name`	string
`id`	string
`description`	string
`color`	string

id string

GET

/v3/projects/{id}/builds/artifacts/{ref_name}/download

This feature was introduced in GitLab 8.10

Request

Path

Name	Data Type	Description
`id`	string	The ID of a project
`ref_name`	string	The ref from repository

Query

Name	Data Type	Description
`job`	string	The name for the build

Responses

200Download the artifacts file from build

POST

/v3/projects/{id}/builds/{build_id}/artifacts/keep

Keep the artifacts to prevent them from being deleted

Request

Path

Name	Data Type	Description
`id`	string	The ID of a project
`build_id`	integer	The ID of a build

Responses

201Keep the artifacts to prevent them from being deleted

Body

Name	Data Type	Description
`Build`	object	This feature was added in GitLab 8.11

Properties

user User

User object

Properties

`website_url`	string
`web_url`	string
`username`	string
`twitter`	string
`state`	string
`skype`	string
`organization`	string
`name`	string
`location`	string
`linkedin`	string
`is_admin`	string
`id`	string
`created_at`	string
`bio`	string
`avatar_url`	string

tag string

status string

started_at string

stage string

runner Runner


                        Runner

object

Remove a runner

Properties

`name`	string
`is_shared`	string
`id`	string
`description`	string
`active`	string

ref string

pipeline PipelineBasic

PipelineBasic object

Properties

`status`	string
`sha`	string
`ref`	string
`id`	string

name string

id string

finished_at string

created_at string

coverage string

commit RepoCommit


                        RepoCommit

object

Get the commits of a merge request

Properties

`title`	string
`short_id`	string
`message`	string
`id`	string
`created_at`	string
`committer_name`	string
`committer_email`	string
`author_name`	string
`author_email`	string

artifacts_file BuildArtifactFile

BuildArtifactFile object

Properties

`size`	string
`filename`	string

GET

/v3/projects/{id}/builds/{build_id}/artifacts

POST

/v3/projects/{id}/builds/{build_id}/cancel

Cancel a specific build of a project

Request

Path

Name	Data Type	Description
`id`	string	The ID of a project
`build_id`	integer	The ID of a build

Responses

201Cancel a specific build of a project

Body

Name	Data Type	Description
`Build`	object	This feature was added in GitLab 8.11

Properties

user User

User object

Properties

`website_url`	string
`web_url`	string
`username`	string
`twitter`	string
`state`	string
`skype`	string
`organization`	string
`name`	string
`location`	string
`linkedin`	string
`is_admin`	string
`id`	string
`created_at`	string
`bio`	string
`avatar_url`	string

tag string

status string

started_at string

stage string

runner Runner


                        Runner

object

Remove a runner

Properties

`name`	string
`is_shared`	string
`id`	string
`description`	string
`active`	string

ref string

pipeline PipelineBasic

PipelineBasic object

Properties

`status`	string
`sha`	string
`ref`	string
`id`	string

name string

id string

finished_at string

created_at string

coverage string

commit RepoCommit


                        RepoCommit

object

Get the commits of a merge request

Properties

`title`	string
`short_id`	string
`message`	string
`id`	string
`created_at`	string
`committer_name`	string
`committer_email`	string
`author_name`	string
`author_email`	string

artifacts_file BuildArtifactFile

BuildArtifactFile object

Properties

`size`	string
`filename`	string

POST

/v3/projects/{id}/builds/{build_id}/erase

Erase build (remove artifacts and build trace)

Request

Path

Name	Data Type	Description
`id`	string	The ID of a project
`build_id`	integer	The ID of a build

Responses

201Erase build (remove artifacts and build trace)

Body

Name	Data Type	Description
`Build`	object	This feature was added in GitLab 8.11

Properties

user User

User object

Properties

`website_url`	string
`web_url`	string
`username`	string
`twitter`	string
`state`	string
`skype`	string
`organization`	string
`name`	string
`location`	string
`linkedin`	string
`is_admin`	string
`id`	string
`created_at`	string
`bio`	string
`avatar_url`	string

tag string

status string

started_at string

stage string

runner Runner


                        Runner

object

Remove a runner

Properties

`name`	string
`is_shared`	string
`id`	string
`description`	string
`active`	string

ref string

pipeline PipelineBasic

PipelineBasic object

Properties

`status`	string
`sha`	string
`ref`	string
`id`	string

name string

id string

finished_at string

created_at string

coverage string

commit RepoCommit


                        RepoCommit

object

Get the commits of a merge request

Properties

`title`	string
`short_id`	string
`message`	string
`id`	string
`created_at`	string
`committer_name`	string
`committer_email`	string
`author_name`	string
`author_email`	string

artifacts_file BuildArtifactFile

BuildArtifactFile object

Properties

`size`	string
`filename`	string

POST

/v3/projects/{id}/builds/{build_id}/play

Resources

application

Responses

Body

Properties

Request

Form Data

Responses

Body

Properties

ci

Request

Form Data

Responses

deploy_keys

Responses

dockerfiles

Request

Path

Responses

Body

Properties

Responses

Body

Properties

gitignores

Request

Path

Responses

Body

Properties

Responses

Body

Properties

gitlab_ci_ymls

Request

Path

Responses

Body

Properties

Responses

Body

Properties

groups

Request

Query

Responses

Body

Properties

Request

Path

Form Data

Responses

Body

Properties

Request

Path

Responses

Request

Path

Query

Responses

Body

Properties

Request

Path

Responses

Body

Properties

Request

Path

Query

Responses

Body

Properties

Properties

Properties

Properties

Request