The platform for modern developers GitLab unifies issues, code review, CI and CD into a single UI
Operations about applications
Get the current application settings
Name | Data Type | Description |
---|---|---|
ApplicationSetting
|
object |
Modify application settings |
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 |
Modify application settings
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 |
Name | Data Type | Description |
---|---|---|
ApplicationSetting
|
object |
Modify application settings |
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 |
Operations about cis
Validation of .gitlab-ci.yml content
Name | Data Type | Description |
---|---|---|
content
|
string |
Content of .gitlab-ci.yml |
Operations about deploy_keys
Operations about dockerfiles
This feature was introduced in GitLab 8.15. This endpoint is deprecated and will be removed in GitLab 9.0.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the template |
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. |
name
|
string | |
content
|
string |
This feature was introduced in GitLab 8.15. This endpoint is deprecated and will be removed in GitLab 9.0.
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. |
name
|
string |
Operations about gitignores
This feature was introduced in GitLab 8.8. This endpoint is deprecated and will be removed in GitLab 9.0.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the template |
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. |
name
|
string | |
content
|
string |
This feature was introduced in GitLab 8.8. This endpoint is deprecated and will be removed in GitLab 9.0.
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. |
name
|
string |
Operations about gitlab_ci_ymls
This feature was introduced in GitLab 8.9. This endpoint is deprecated and will be removed in GitLab 9.0.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the template |
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. |
name
|
string | |
content
|
string |
This feature was introduced in GitLab 8.9. This endpoint is deprecated and will be removed in GitLab 9.0.
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. |
name
|
string |
Operations about groups
Get list of owned groups for authenticated user
Name | Data Type | Description |
---|---|---|
statistics
|
boolean |
Include project statistics |
per_page
|
integer |
Number of items per page |
page
|
integer |
Current page number |
Name | Data Type | Description |
---|---|---|
Group
|
object |
Update a group. Available only for users who can administrate groups. |
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 |
This feature was introduced in GitLab 8.11.
Name | Data Type | Description |
---|---|---|
user_id
|
integer |
The user ID of the access requester |
id
|
string |
The group ID |
Name | Data Type | Description |
---|---|---|
access_level
|
integer |
A valid access level (defaults: |
Name | Data Type | Description |
---|---|---|
Member
|
object |
Updates a member of a group or project. |
web_url
|
string | |
username
|
string | |
state
|
string | |
name
|
string | |
id
|
string | |
expires_at
|
string | |
avatar_url
|
string | |
access_level
|
string |
This feature was introduced in GitLab 8.11.
Name | Data Type | Description |
---|---|---|
user_id
|
integer |
The user ID of the access requester |
id
|
string |
The group ID |
This feature was introduced in GitLab 8.11.
Name | Data Type | Description |
---|---|---|
id
|
string |
The group ID |
Name | Data Type | Description |
---|---|---|
per_page
|
integer |
Number of items per page |
page
|
integer |
Current page number |
Name | Data Type | Description |
---|---|---|
AccessRequester
|
object |
This feature was introduced in GitLab 8.11. |
web_url
|
string | |
username
|
string | |
state
|
string | |
requested_at
|
string | |
name
|
string | |
id
|
string | |
avatar_url
|
string |
This feature was introduced in GitLab 8.11.
Name | Data Type | Description |
---|---|---|
id
|
string |
The group ID |
Name | Data Type | Description |
---|---|---|
AccessRequester
|
object |
This feature was introduced in GitLab 8.11. |
web_url
|
string | |
username
|
string | |
state
|
string | |
requested_at
|
string | |
name
|
string | |
id
|
string | |
avatar_url
|
string |
Get a list of group issues
Name | Data Type | Description |
---|---|---|
id
|
string |
The ID of a group |
Name | Data Type | Description |
---|---|---|
per_page
|
integer |
Number of items per page |
page
|
integer |
Current page number |
sort
|
string Default value: desc Allowed values: - asc - desc |
Return issues sorted in |
order_by
|
string Default value: created_at Allowed values: - created_at - updated_at |
Return issues ordered by |
milestone
|
string |
Return issues for a specific milestone |
labels
|
string |
Comma-separated list of label names |
state
|
string Default value: opened Allowed values: - opened - closed - all |
Return opened, closed, or all issues |
Name | Data Type | Description |
---|---|---|
Issue
|
object |
Get currently authenticated user's issues |
web_url
|
string | |||||||||||||||||||||||||||||||||||
user_notes_count
|
string | |||||||||||||||||||||||||||||||||||
upvotes
|
string | |||||||||||||||||||||||||||||||||||
updated_at
|
string | |||||||||||||||||||||||||||||||||||
title
|
string | |||||||||||||||||||||||||||||||||||
subscribed
|
string | |||||||||||||||||||||||||||||||||||
state
|
string | |||||||||||||||||||||||||||||||||||
project_id
|
string | |||||||||||||||||||||||||||||||||||
milestone
|
Milestone | |||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
labels
|
string | |||||||||||||||||||||||||||||||||||
iid
|
string | |||||||||||||||||||||||||||||||||||
id
|
string | |||||||||||||||||||||||||||||||||||
due_date
|
string | |||||||||||||||||||||||||||||||||||
downvotes
|
string | |||||||||||||||||||||||||||||||||||
description
|
string | |||||||||||||||||||||||||||||||||||
created_at
|
string | |||||||||||||||||||||||||||||||||||
confidential
|
string | |||||||||||||||||||||||||||||||||||
author
|
UserBasic | |||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
assignee
|
UserBasic | |||||||||||||||||||||||||||||||||||
Properties
|
Removes a user from a group or project.
Name | Data Type | Description |
---|---|---|
user_id
|
integer |
The user ID of the member |
id
|
string |
The group ID |
Gets a member of a group or project.
Name | Data Type | Description |
---|---|---|
user_id
|
integer |
The user ID of the member |
id
|
string |
The group ID |
Name | Data Type | Description |
---|---|---|
Member
|
object |
Updates a member of a group or project. |
web_url
|
string | |
username
|
string | |
state
|
string | |
name
|
string | |
id
|
string | |
expires_at
|
string | |
avatar_url
|
string | |
access_level
|
string |
Updates a member of a group or project.
Name | Data Type | Description |
---|---|---|
user_id
|
integer |
The user ID of the new member |
id
|
string |
The group ID |
Name | Data Type | Description |
---|---|---|
expires_at
|
dateTime |
Date string in the format YEAR-MONTH-DAY |
access_level
|
integer |
A valid access level |
Name | Data Type | Description |
---|---|---|
Member
|
object |
Updates a member of a group or project. |
web_url
|
string | |
username
|
string | |
state
|
string | |
name
|
string | |
id
|
string | |
expires_at
|
string | |
avatar_url
|
string | |
access_level
|
string |
Gets a list of group or project members viewable by the authenticated user.
Name | Data Type | Description |
---|---|---|
id
|
string |
The group ID |
Name | Data Type | Description |
---|---|---|
per_page
|
integer |
Number of items per page |
page
|
integer |
Current page number |
query
|
string |
A query string to search for members |
Name | Data Type | Description |
---|---|---|
Member
|
object |
Updates a member of a group or project. |
web_url
|
string | |
username
|
string | |
state
|
string | |
name
|
string | |
id
|
string | |
expires_at
|
string | |
avatar_url
|
string | |
access_level
|
string |
Adds a member to a group or project.
Name | Data Type | Description |
---|---|---|
id
|
string |
The group ID |
Name | Data Type | Description |
---|---|---|
expires_at
|
dateTime |
Date string in the format YEAR-MONTH-DAY |
access_level
|
integer |
A valid access level (defaults: |
user_id
|
integer |
The user ID of the new member |
Name | Data Type | Description |
---|---|---|
Member
|
object |
Updates a member of a group or project. |
web_url
|
string | |
username
|
string | |
state
|
string | |
name
|
string | |
id
|
string | |
expires_at
|
string | |
avatar_url
|
string | |
access_level
|
string |
This feature was introduced in GitLab 8.12
Name | Data Type | Description |
---|---|---|
id
|
string |
The group ID or project ID or project NAMESPACE/PROJECT_NAME |
Name | Data Type | Description |
---|---|---|
NotificationSetting
|
object |
This feature was introduced in GitLab 8.12 |
level
|
string | |
events
|
string |
This feature was introduced in GitLab 8.12
Name | Data Type | Description |
---|---|---|
id
|
string |
The group ID or project ID or project NAMESPACE/PROJECT_NAME |
Name | Data Type | Description |
---|---|---|
success_pipeline
|
boolean |
Enable/disable this notification |
failed_pipeline
|
boolean |
Enable/disable this notification |
merge_merge_request
|
boolean |
Enable/disable this notification |
reassign_merge_request
|
boolean |
Enable/disable this notification |
close_merge_request
|
boolean |
Enable/disable this notification |
reopen_merge_request
|
boolean |
Enable/disable this notification |
new_merge_request
|
boolean |
Enable/disable this notification |
reassign_issue
|
boolean |
Enable/disable this notification |
close_issue
|
boolean |
Enable/disable this notification |
reopen_issue
|
boolean |
Enable/disable this notification |
new_issue
|
boolean |
Enable/disable this notification |
new_note
|
boolean |
Enable/disable this notification |
level
|
string |
The group notification level |
Name | Data Type | Description |
---|---|---|
NotificationSetting
|
object |
This feature was introduced in GitLab 8.12 |
level
|
string | |
events
|
string |
Transfer a project to the group namespace. Available only for admin.
Name | Data Type | Description |
---|---|---|
project_id
|
string |
The ID or path of the project |
id
|
string |
The ID of a group |
Name | Data Type | Description |
---|---|---|
GroupDetail
|
object |
Transfer a project to the group namespace. Available only for admin. |
web_url
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
visibility_level
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statistics
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shared_projects
|
Project | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
request_access_enabled
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
projects
|
Project | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
path
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lfs_enabled
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
avatar_url
|
string |
Get a list of projects in this group.
Name | Data Type | Description |
---|---|---|
id
|
string |
The ID of a group |
Name | Data Type | Description |
---|---|---|
per_page
|
integer |
Number of items per page |
page
|
integer |
Current page number |
simple
|
boolean |
Return only the ID, URL, name, and path of each project |
sort
|
string Default value: desc Allowed values: - asc - desc |
Return projects sorted in ascending and descending order |
order_by
|
string Default value: created_at Allowed values: - id - name - path - created_at - updated_at - last_activity_at |
Return projects ordered by field |
search
|
string |
Return list of authorized projects matching the search criteria |
visibility
|
string Allowed values: - public - internal - private |
Limit by visibility |
archived
|
boolean |
Limit by archived status |
Name | Data Type | Description |
---|---|---|
Project
|
object |
Unstar a project |
wiki_enabled
|
string | ||||||||||||||||||||||||||
web_url
|
string | ||||||||||||||||||||||||||
visibility_level
|
string | ||||||||||||||||||||||||||
tag_list
|
string | ||||||||||||||||||||||||||
statistics
|
ProjectStatistics | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
star_count
|
string | ||||||||||||||||||||||||||
ssh_url_to_repo
|
string | ||||||||||||||||||||||||||
snippets_enabled
|
string | ||||||||||||||||||||||||||
shared_with_groups
|
string | ||||||||||||||||||||||||||
shared_runners_enabled
|
string | ||||||||||||||||||||||||||
runners_token
|
string | ||||||||||||||||||||||||||
request_access_enabled
|
string | ||||||||||||||||||||||||||
public_builds
|
string | ||||||||||||||||||||||||||
public
|
string | ||||||||||||||||||||||||||
path_with_namespace
|
string | ||||||||||||||||||||||||||
path
|
string | ||||||||||||||||||||||||||
owner
|
UserBasic | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
open_issues_count
|
string | ||||||||||||||||||||||||||
only_allow_merge_if_build_succeeds
|
string | ||||||||||||||||||||||||||
only_allow_merge_if_all_discussions_are_resolved
|
string | ||||||||||||||||||||||||||
namespace
|
Namespace | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
name_with_namespace
|
string | ||||||||||||||||||||||||||
name
|
string | ||||||||||||||||||||||||||
merge_requests_enabled
|
string | ||||||||||||||||||||||||||
lfs_enabled
|
string | ||||||||||||||||||||||||||
last_activity_at
|
string | ||||||||||||||||||||||||||
issues_enabled
|
string | ||||||||||||||||||||||||||
id
|
string | ||||||||||||||||||||||||||
http_url_to_repo
|
string | ||||||||||||||||||||||||||
forks_count
|
string | ||||||||||||||||||||||||||
forked_from_project
|
BasicProjectDetails | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
description
|
string | ||||||||||||||||||||||||||
default_branch
|
string | ||||||||||||||||||||||||||
creator_id
|
string | ||||||||||||||||||||||||||
created_at
|
string | ||||||||||||||||||||||||||
container_registry_enabled
|
string | ||||||||||||||||||||||||||
builds_enabled
|
string | ||||||||||||||||||||||||||
avatar_url
|
string | ||||||||||||||||||||||||||
archived
|
string |
Remove a group.
Name | Data Type | Description |
---|---|---|
id
|
string |
The ID of a group |
Get a single group, with containing projects.
Name | Data Type | Description |
---|---|---|
id
|
string |
The ID of a group |
Name | Data Type | Description |
---|---|---|
GroupDetail
|
object |
Transfer a project to the group namespace. Available only for admin. |
web_url
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
visibility_level
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statistics
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shared_projects
|
Project | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
request_access_enabled
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
projects
|
Project | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
path
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lfs_enabled
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
avatar_url
|
string |
Update a group. Available only for users who can administrate groups.
Name | Data Type | Description |
---|---|---|
id
|
string |
The ID of a group |
Name | Data Type | Description |
---|---|---|
request_access_enabled
|
boolean |
Allow users to request member access |
lfs_enabled
|
boolean |
Enable/disable LFS for the projects in this group |
visibility_level
|
integer |
The visibility level of the group |
description
|
string |
The description of the group |
path
|
string |
The path of the group |
name
|
string |
The name of the group |
Name | Data Type | Description |
---|---|---|
Group
|
object |
Update a group. Available only for users who can administrate groups. |
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 a groups list
Name | Data Type | Description |
---|---|---|
per_page
|
integer |
Number of items per page |
page
|
integer |
Current page number |
sort
|
string Default value: asc Allowed values: - asc - desc |
Sort by asc (ascending) or desc (descending) |
order_by
|
string Default value: name Allowed values: - name - path |
Order by name or path |
search
|
string |
Search for a specific group |
all_available
|
boolean |
Show all group that you have access to |
statistics
|
boolean |
Include project statistics |
Name | Data Type | Description |
---|---|---|
skip_groups
|
array |
Array of group ids to exclude from list |
Name | Data Type | Description |
---|---|---|
Group
|
object |
Update a group. Available only for users who can administrate groups. |
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 |
Create a group. Available only for users who can create groups.
Name | Data Type | Description |
---|---|---|
request_access_enabled
|
boolean |
Allow users to request member access |
lfs_enabled
|
boolean |
Enable/disable LFS for the projects in this group |
visibility_level
|
integer |
The visibility level of the group |
description
|
string |
The description of the group |
path
|
string |
The path of the group |
name
|
string |
The name of the group |
Name | Data Type | Description |
---|---|---|
Group
|
object |
Update a group. Available only for users who can administrate groups. |
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 |
Operations about hooks
Delete a hook
Name | Data Type | Description |
---|---|---|
id
|
integer |
The ID of the system hook |
Name | Data Type | Description |
---|---|---|
Hook
|
object |
Delete a hook |
url
|
string | |
tag_push_events
|
string | |
push_events
|
string | |
id
|
string | |
enable_ssl_verification
|
string | |
created_at
|
string |
Test a hook
Name | Data Type | Description |
---|---|---|
id
|
integer |
The ID of the system hook |
Name | Data Type | Description |
---|---|---|
Hook
|
object |
Delete a hook |
url
|
string | |
tag_push_events
|
string | |
push_events
|
string | |
id
|
string | |
enable_ssl_verification
|
string | |
created_at
|
string |
Get the list of system hooks
Name | Data Type | Description |
---|---|---|
Hook
|
object |
Delete a hook |
url
|
string | |
tag_push_events
|
string | |
push_events
|
string | |
id
|
string | |
enable_ssl_verification
|
string | |
created_at
|
string |
Create a new system hook
Name | Data Type | Description |
---|---|---|
enable_ssl_verification
|
boolean |
Do SSL verification when triggering the hook |
tag_push_events
|
boolean |
Trigger hook on tag push events |
push_events
|
boolean |
Trigger hook on push events |
token
|
string |
The token used to validate payloads |
url
|
string |
The URL to send the request to |
Name | Data Type | Description |
---|---|---|
Hook
|
object |
Delete a hook |
url
|
string | |
tag_push_events
|
string | |
push_events
|
string | |
id
|
string | |
enable_ssl_verification
|
string | |
created_at
|
string |
Operations about internals
Operations about issues
Get currently authenticated user's issues
Name | Data Type | Description |
---|---|---|
per_page
|
integer |
Number of items per page |
page
|
integer |
Current page number |
sort
|
string Default value: desc Allowed values: - asc - desc |
Return issues sorted in |
order_by
|
string Default value: created_at Allowed values: - created_at - updated_at |
Return issues ordered by |
milestone
|
string |
Return issues for a specific milestone |
labels
|
string |
Comma-separated list of label names |
state
|
string Default value: all Allowed values: - opened - closed - all |
Return opened, closed, or all issues |
Name | Data Type | Description |
---|---|---|
Issue
|
object |
Get currently authenticated user's issues |
web_url
|
string | |||||||||||||||||||||||||||||||||||
user_notes_count
|
string | |||||||||||||||||||||||||||||||||||
upvotes
|
string | |||||||||||||||||||||||||||||||||||
updated_at
|
string | |||||||||||||||||||||||||||||||||||
title
|
string | |||||||||||||||||||||||||||||||||||
subscribed
|
string | |||||||||||||||||||||||||||||||||||
state
|
string | |||||||||||||||||||||||||||||||||||
project_id
|
string | |||||||||||||||||||||||||||||||||||
milestone
|
Milestone | |||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
labels
|
string | |||||||||||||||||||||||||||||||||||
iid
|
string | |||||||||||||||||||||||||||||||||||
id
|
string | |||||||||||||||||||||||||||||||||||
due_date
|
string | |||||||||||||||||||||||||||||||||||
downvotes
|
string | |||||||||||||||||||||||||||||||||||
description
|
string | |||||||||||||||||||||||||||||||||||
created_at
|
string | |||||||||||||||||||||||||||||||||||
confidential
|
string | |||||||||||||||||||||||||||||||||||
author
|
UserBasic | |||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
assignee
|
UserBasic | |||||||||||||||||||||||||||||||||||
Properties
|
Operations about keys
Get single ssh key by id. Only available to admin users
Name | Data Type | Description |
---|---|---|
id
|
integer |
Name | Data Type | Description |
---|---|---|
SSHKeyWithUser
|
object |
Get single ssh key by id. Only available to admin users |
user
|
UserPublic | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
title
|
string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
key
|
string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at
|
string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
can_push
|
string |
Operations about licenses
This feature was introduced in GitLab 8.7. This endpoint is deprecated and will be removed in GitLab 9.0.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the template |
Name | Data Type | Description |
---|---|---|
RepoLicense
|
object |
This feature was introduced in GitLab 8.7. |
source_url
|
string | |
popular
|
string | |
permissions
|
string | |
nickname
|
string | |
name
|
string | |
limitations
|
string | |
key
|
string | |
html_url
|
string | |
description
|
string | |
content
|
string | |
conditions
|
string |
This feature was introduced in GitLab 8.7. This endpoint is deprecated and will be removed in GitLab 9.0.
Name | Data Type | Description |
---|---|---|
popular
|
boolean |
If passed, returns only popular licenses |
Name | Data Type | Description |
---|---|---|
RepoLicense
|
object |
This feature was introduced in GitLab 8.7. |
source_url
|
string | |
popular
|
string | |
permissions
|
string | |
nickname
|
string | |
name
|
string | |
limitations
|
string | |
key
|
string | |
html_url
|
string | |
description
|
string | |
content
|
string | |
conditions
|
string |
Operations about namespaces
Get a namespaces list
Name | Data Type | Description |
---|---|---|
per_page
|
integer |
Number of items per page |
page
|
integer |
Current page number |
search
|
string |
Search query for namespaces |
Name | Data Type | Description |
---|---|---|
Namespace
|
object |
Get a namespaces list |
path
|
string | |
name
|
string | |
kind
|
string | |
id
|
string |
Operations about notification_settings
This feature was introduced in GitLab 8.12
Name | Data Type | Description |
---|---|---|
GlobalNotificationSetting
|
object |
This feature was introduced in GitLab 8.12 |
notification_email
|
string | |
level
|
string | |
events
|
string |
This feature was introduced in GitLab 8.12
Name | Data Type | Description |
---|---|---|
success_pipeline
|
boolean |
Enable/disable this notification |
failed_pipeline
|
boolean |
Enable/disable this notification |
merge_merge_request
|
boolean |
Enable/disable this notification |
reassign_merge_request
|
boolean |
Enable/disable this notification |
close_merge_request
|
boolean |
Enable/disable this notification |
reopen_merge_request
|
boolean |
Enable/disable this notification |
new_merge_request
|
boolean |
Enable/disable this notification |
reassign_issue
|
boolean |
Enable/disable this notification |
close_issue
|
boolean |
Enable/disable this notification |
reopen_issue
|
boolean |
Enable/disable this notification |
new_issue
|
boolean |
Enable/disable this notification |
new_note
|
boolean |
Enable/disable this notification |
notification_email
|
string |
The email address to send notifications |
level
|
string |
The global notification level |
Name | Data Type | Description |
---|---|---|
GlobalNotificationSetting
|
object |
This feature was introduced in GitLab 8.12 |
notification_email
|
string | |
level
|
string | |
events
|
string |
Operations about projects
Get all projects for admin user
Name | Data Type | Description |
---|---|---|
statistics
|
boolean |
Include project statistics |
simple
|
boolean |
Return only the ID, URL, name, and path of each project |
per_page
|
integer |
Number of items per page |
page
|
integer |
Current page number |
search
|
string |
Return list of authorized projects matching the search criteria |
visibility
|
string Allowed values: - public - internal - private |
Limit by visibility |
archived
|
boolean |
Limit by archived status |
sort
|
string Default value: desc Allowed values: - asc - desc |
Return projects sorted in ascending and descending order |
order_by
|
string Default value: created_at Allowed values: - id - name - path - created_at - updated_at - last_activity_at |
Return projects ordered by field |
Name | Data Type | Description |
---|---|---|
BasicProjectDetails
|
object |
Get all projects for admin user |
web_url
|
string | |
path_with_namespace
|
string | |
path
|
string | |
name_with_namespace
|
string | |
name
|
string | |
id
|
string | |
http_url_to_repo
|
string |
Fork new project for the current user or provided namespace.
Name | Data Type | Description |
---|---|---|
id
|
string |
The ID of a project |
Name | Data Type | Description |
---|---|---|
namespace
|
string |
The ID or name of the namespace that the project will be forked into |
Name | Data Type | Description |
---|---|---|
Project
|
object |
Unstar a project |
wiki_enabled
|
string | ||||||||||||||||||||||||||
web_url
|
string | ||||||||||||||||||||||||||
visibility_level
|
string | ||||||||||||||||||||||||||
tag_list
|
string | ||||||||||||||||||||||||||
statistics
|
ProjectStatistics | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
star_count
|
string | ||||||||||||||||||||||||||
ssh_url_to_repo
|
string | ||||||||||||||||||||||||||
snippets_enabled
|
string | ||||||||||||||||||||||||||
shared_with_groups
|
string | ||||||||||||||||||||||||||
shared_runners_enabled
|
string | ||||||||||||||||||||||||||
runners_token
|
string | ||||||||||||||||||||||||||
request_access_enabled
|
string | ||||||||||||||||||||||||||
public_builds
|
string | ||||||||||||||||||||||||||
public
|
string | ||||||||||||||||||||||||||
path_with_namespace
|
string | ||||||||||||||||||||||||||
path
|
string | ||||||||||||||||||||||||||
owner
|
UserBasic | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
open_issues_count
|
string | ||||||||||||||||||||||||||
only_allow_merge_if_build_succeeds
|
string | ||||||||||||||||||||||||||
only_allow_merge_if_all_discussions_are_resolved
|
string | ||||||||||||||||||||||||||
namespace
|
Namespace | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
name_with_namespace
|
string | ||||||||||||||||||||||||||
name
|
string | ||||||||||||||||||||||||||
merge_requests_enabled
|
string | ||||||||||||||||||||||||||
lfs_enabled
|
string | ||||||||||||||||||||||||||
last_activity_at
|
string | ||||||||||||||||||||||||||
issues_enabled
|
string | ||||||||||||||||||||||||||
id
|
string | ||||||||||||||||||||||||||
http_url_to_repo
|
string | ||||||||||||||||||||||||||
forks_count
|
string | ||||||||||||||||||||||||||
forked_from_project
|
BasicProjectDetails | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
description
|
string | ||||||||||||||||||||||||||
default_branch
|
string | ||||||||||||||||||||||||||
creator_id
|
string | ||||||||||||||||||||||||||
created_at
|
string | ||||||||||||||||||||||||||
container_registry_enabled
|
string | ||||||||||||||||||||||||||
builds_enabled
|
string | ||||||||||||||||||||||||||
avatar_url
|
string | ||||||||||||||||||||||||||
archived
|
string |
Get an owned projects list for authenticated user
Name | Data Type | Description |
---|---|---|
statistics
|
boolean |
Include project statistics |
simple
|
boolean |
Return only the ID, URL, name, and path of each project |
per_page
|
integer |
Number of items per page |
page
|
integer |
Current page number |
search
|
string |
Return list of authorized projects matching the search criteria |
visibility
|
string Allowed values: - public - internal - private |
Limit by visibility |
archived
|
boolean |
Limit by archived status |
sort
|
string Default value: desc Allowed values: - asc - desc |
Return projects sorted in ascending and descending order |
order_by
|
string Default value: created_at Allowed values: - id - name - path - created_at - updated_at - last_activity_at |
Return projects ordered by field |
Name | Data Type | Description |
---|---|---|
BasicProjectDetails
|
object |
Get all projects for admin user |
web_url
|
string | |
path_with_namespace
|
string | |
path
|
string | |
name_with_namespace
|
string | |
name
|
string | |
id
|
string | |
http_url_to_repo
|
string |
Search for projects the current user has access to
Name | Data Type | Description |
---|---|---|
query
|
string |
The project name to be searched |
Name | Data Type | Description |
---|---|---|
per_page
|
integer |
Number of items per page |
page
|
integer |
Current page number |
sort
|
string Default value: desc Allowed values: - asc - desc |
Return projects sorted in ascending and descending order |
order_by
|
string Default value: created_at Allowed values: - id - name - path - created_at - updated_at - last_activity_at |
Return projects ordered by field |
Name | Data Type | Description |
---|---|---|
Project
|
object |
Unstar a project |
wiki_enabled
|
string | ||||||||||||||||||||||||||
web_url
|
string | ||||||||||||||||||||||||||
visibility_level
|
string | ||||||||||||||||||||||||||
tag_list
|
string | ||||||||||||||||||||||||||
statistics
|
ProjectStatistics | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
star_count
|
string | ||||||||||||||||||||||||||
ssh_url_to_repo
|
string | ||||||||||||||||||||||||||
snippets_enabled
|
string | ||||||||||||||||||||||||||
shared_with_groups
|
string | ||||||||||||||||||||||||||
shared_runners_enabled
|
string | ||||||||||||||||||||||||||
runners_token
|
string | ||||||||||||||||||||||||||
request_access_enabled
|
string | ||||||||||||||||||||||||||
public_builds
|
string | ||||||||||||||||||||||||||
public
|
string | ||||||||||||||||||||||||||
path_with_namespace
|
string | ||||||||||||||||||||||||||
path
|
string | ||||||||||||||||||||||||||
owner
|
UserBasic | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
open_issues_count
|
string | ||||||||||||||||||||||||||
only_allow_merge_if_build_succeeds
|
string | ||||||||||||||||||||||||||
only_allow_merge_if_all_discussions_are_resolved
|
string | ||||||||||||||||||||||||||
namespace
|
Namespace | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
name_with_namespace
|
string | ||||||||||||||||||||||||||
name
|
string | ||||||||||||||||||||||||||
merge_requests_enabled
|
string | ||||||||||||||||||||||||||
lfs_enabled
|
string | ||||||||||||||||||||||||||
last_activity_at
|
string | ||||||||||||||||||||||||||
issues_enabled
|
string | ||||||||||||||||||||||||||
id
|
string | ||||||||||||||||||||||||||
http_url_to_repo
|
string | ||||||||||||||||||||||||||
forks_count
|
string | ||||||||||||||||||||||||||
forked_from_project
|
BasicProjectDetails | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
description
|
string | ||||||||||||||||||||||||||
default_branch
|
string | ||||||||||||||||||||||||||
creator_id
|
string | ||||||||||||||||||||||||||
created_at
|
string | ||||||||||||||||||||||||||
container_registry_enabled
|
string | ||||||||||||||||||||||||||
builds_enabled
|
string | ||||||||||||||||||||||||||
avatar_url
|
string | ||||||||||||||||||||||||||
archived
|
string |
Gets starred project for the authenticated user
Name | Data Type | Description |
---|---|---|
simple
|
boolean |
Return only the ID, URL, name, and path of each project |
per_page
|
integer |
Number of items per page |
page
|
integer |
Current page number |
search
|
string |
Return list of authorized projects matching the search criteria |
visibility
|
string Allowed values: - public - internal - private |
Limit by visibility |
archived
|
boolean |
Limit by archived status |
sort
|
string Default value: desc Allowed values: - asc - desc |
Return projects sorted in ascending and descending order |
order_by
|
string Default value: created_at Allowed values: - id - name - path - created_at - updated_at - last_activity_at |
Return projects ordered by field |
Name | Data Type | Description |
---|---|---|
BasicProjectDetails
|
object |
Get all projects for admin user |
web_url
|
string | |
path_with_namespace
|
string | |
path
|
string | |
name_with_namespace
|
string | |
name
|
string | |
id
|
string | |
http_url_to_repo
|
string |
Create new project for a specified user. Only available to admin users.
Name | Data Type | Description |
---|---|---|
user_id
|
integer |
The ID of a user |
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 |
Name | Data Type | Description |
---|---|---|
Project
|
object |
Unstar a project |
wiki_enabled
|
string | ||||||||||||||||||||||||||
web_url
|
string | ||||||||||||||||||||||||||
visibility_level
|
string | ||||||||||||||||||||||||||
tag_list
|
string | ||||||||||||||||||||||||||
statistics
|
ProjectStatistics | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
star_count
|
string | ||||||||||||||||||||||||||
ssh_url_to_repo
|
string | ||||||||||||||||||||||||||
snippets_enabled
|
string | ||||||||||||||||||||||||||
shared_with_groups
|
string | ||||||||||||||||||||||||||
shared_runners_enabled
|
string | ||||||||||||||||||||||||||
runners_token
|
string | ||||||||||||||||||||||||||
request_access_enabled
|
string | ||||||||||||||||||||||||||
public_builds
|
string | ||||||||||||||||||||||||||
public
|
string | ||||||||||||||||||||||||||
path_with_namespace
|
string | ||||||||||||||||||||||||||
path
|
string | ||||||||||||||||||||||||||
owner
|
UserBasic | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
open_issues_count
|
string | ||||||||||||||||||||||||||
only_allow_merge_if_build_succeeds
|
string | ||||||||||||||||||||||||||
only_allow_merge_if_all_discussions_are_resolved
|
string | ||||||||||||||||||||||||||
namespace
|
Namespace | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
name_with_namespace
|
string | ||||||||||||||||||||||||||
name
|
string | ||||||||||||||||||||||||||
merge_requests_enabled
|
string | ||||||||||||||||||||||||||
lfs_enabled
|
string | ||||||||||||||||||||||||||
last_activity_at
|
string | ||||||||||||||||||||||||||
issues_enabled
|
string | ||||||||||||||||||||||||||
id
|
string | ||||||||||||||||||||||||||
http_url_to_repo
|
string | ||||||||||||||||||||||||||
forks_count
|
string | ||||||||||||||||||||||||||
forked_from_project
|
BasicProjectDetails | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
description
|
string | ||||||||||||||||||||||||||
default_branch
|
string | ||||||||||||||||||||||||||
creator_id
|
string | ||||||||||||||||||||||||||
created_at
|
string | ||||||||||||||||||||||||||
container_registry_enabled
|
string | ||||||||||||||||||||||||||
builds_enabled
|
string | ||||||||||||||||||||||||||
avatar_url
|
string | ||||||||||||||||||||||||||
archived
|
string |
Get a list of visible projects for authenticated user
Name | Data Type | Description |
---|---|---|
simple
|
boolean |
Return only the ID, URL, name, and path of each project |
per_page
|
integer |
Number of items per page |
page
|
integer |
Current page number |
search
|
string |
Return list of authorized projects matching the search criteria |
visibility
|
string Allowed values: - public - internal - private |
Limit by visibility |
archived
|
boolean |
Limit by archived status |
sort
|
string Default value: desc Allowed values: - asc - desc |
Return projects sorted in ascending and descending order |
order_by
|
string Default value: created_at Allowed values: - id - name - path - created_at - updated_at - last_activity_at |
Return projects ordered by field |
Name | Data Type | Description |
---|---|---|
BasicProjectDetails
|
object |
Get all projects for admin user |
web_url
|
string | |
path_with_namespace
|
string | |
path
|
string | |
name_with_namespace
|
string | |
name
|
string | |
id
|
string | |
http_url_to_repo
|
string |
Trigger a GitLab project build
Name | Data Type | Description |
---|---|---|
ref
|
string |
The commit sha or name of a branch or tag |
id
|
string |
The ID of a project |
Name | Data Type | Description |
---|---|---|
token
|
string |
The unique token of trigger |
Name | Data Type | Description |
---|---|---|
TriggerRequest
|
object |
Trigger a GitLab project build |
variables
|
string | |
id
|
string |
This feature was introduced in GitLab 8.11.
Name | Data Type | Description |
---|---|---|
user_id
|
integer |
The user ID of the access requester |
id
|
string |
The project ID |
Name | Data Type | Description |
---|---|---|
access_level
|
integer |
A valid access level (defaults: |
Name | Data Type | Description |
---|---|---|
Member
|
object |
Updates a member of a group or project. |
web_url
|
string | |
username
|
string | |
state
|
string | |
name
|
string | |
id
|
string | |
expires_at
|
string | |
avatar_url
|
string | |
access_level
|
string |
This feature was introduced in GitLab 8.11.
Name | Data Type | Description |
---|---|---|
user_id
|
integer |
The user ID of the access requester |
id
|
string |
The project ID |
This feature was introduced in GitLab 8.11.
Name | Data Type | Description |
---|---|---|
id
|
string |
The project ID |
Name | Data Type | Description |
---|---|---|
per_page
|
integer |
Number of items per page |
page
|
integer |
Current page number |
Name | Data Type | Description |
---|---|---|
AccessRequester
|
object |
This feature was introduced in GitLab 8.11. |
web_url
|
string | |
username
|
string | |
state
|
string | |
requested_at
|
string | |
name
|
string | |
id
|
string | |
avatar_url
|
string |
This feature was introduced in GitLab 8.11.
Name | Data Type | Description |
---|---|---|
id
|
string |
The project ID |
Name | Data Type | Description |
---|---|---|
AccessRequester
|
object |
This feature was introduced in GitLab 8.11. |
web_url
|
string | |
username
|
string | |
state
|
string | |
requested_at
|
string | |
name
|
string | |
id
|
string | |
avatar_url
|
string |
Archive a project
Name | Data Type | Description |
---|---|---|
id
|
string |
The ID of a project |
Name | Data Type | Description |
---|---|---|
Project
|
object |
Unstar a project |
wiki_enabled
|
string | ||||||||||||||||||||||||||
web_url
|
string | ||||||||||||||||||||||||||
visibility_level
|
string | ||||||||||||||||||||||||||
tag_list
|
string | ||||||||||||||||||||||||||
statistics
|
ProjectStatistics | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
star_count
|
string | ||||||||||||||||||||||||||
ssh_url_to_repo
|
string | ||||||||||||||||||||||||||
snippets_enabled
|
string | ||||||||||||||||||||||||||
shared_with_groups
|
string | ||||||||||||||||||||||||||
shared_runners_enabled
|
string | ||||||||||||||||||||||||||
runners_token
|
string | ||||||||||||||||||||||||||
request_access_enabled
|
string | ||||||||||||||||||||||||||
public_builds
|
string | ||||||||||||||||||||||||||
public
|
string | ||||||||||||||||||||||||||
path_with_namespace
|
string | ||||||||||||||||||||||||||
path
|
string | ||||||||||||||||||||||||||
owner
|
UserBasic | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
open_issues_count
|
string | ||||||||||||||||||||||||||
only_allow_merge_if_build_succeeds
|
string | ||||||||||||||||||||||||||
only_allow_merge_if_all_discussions_are_resolved
|
string | ||||||||||||||||||||||||||
namespace
|
Namespace | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
name_with_namespace
|
string | ||||||||||||||||||||||||||
name
|
string | ||||||||||||||||||||||||||
merge_requests_enabled
|
string | ||||||||||||||||||||||||||
lfs_enabled
|
string | ||||||||||||||||||||||||||
last_activity_at
|
string | ||||||||||||||||||||||||||
issues_enabled
|
string | ||||||||||||||||||||||||||
id
|
string | ||||||||||||||||||||||||||
http_url_to_repo
|
string | ||||||||||||||||||||||||||
forks_count
|
string | ||||||||||||||||||||||||||
forked_from_project
|
BasicProjectDetails | ||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
description
|
string | ||||||||||||||||||||||||||
default_branch
|
string | ||||||||||||||||||||||||||
creator_id
|
string | ||||||||||||||||||||||||||
created_at
|
string | ||||||||||||||||||||||||||
container_registry_enabled
|
string | ||||||||||||||||||||||||||
builds_enabled
|
string | ||||||||||||||||||||||||||
avatar_url
|
string | ||||||||||||||||||||||||||
archived
|
string |
This feature was introduced in 8.13
Name | Data Type | Description |
---|---|---|
list_id
|
integer |
The ID of a board list |
board_id
|
integer |
The ID of a board |
id
|
string |
The ID of a project |
Name | Data Type | Description |
---|---|---|
List
|
object |
This feature was introduced in 8.13 |
position
|
string | |||||||||||||||||
label
|
LabelBasic | |||||||||||||||||
Properties
|
||||||||||||||||||
id
|
string |
This feature was introduced in 8.13
Name | Data Type | Description |
---|---|---|
list_id
|
integer |
The ID of a list |
board_id
|
integer |
The ID of a board |
id
|
string |
The ID of a project |
Name | Data Type | Description |
---|---|---|
List
|
object |
This feature was introduced in 8.13 |
position
|
string | |||||||||||||||||
label
|
LabelBasic | |||||||||||||||||
Properties
|
||||||||||||||||||
id
|
string |
This feature was introduced in 8.13
Name | Data Type | Description |
---|---|---|
list_id
|
integer |
The ID of a list |
board_id
|
integer |
The ID of a board |
id
|
string |
The ID of a project |
Name | Data Type | Description |
---|---|---|
position
|
integer |
The position of the list |
Name | Data Type | Description |
---|---|---|
List
|
object |
This feature was introduced in 8.13 |
position
|
string | |||||||||||||||||
label
|
LabelBasic | |||||||||||||||||
Properties
|
||||||||||||||||||
id
|
string |
Does not include backlog
and done
lists. This feature was introduced in 8.13
Name | Data Type | Description |
---|---|---|
board_id
|
integer |
The ID of a board |
id
|
string |
The ID of a project |
Name | Data Type | Description |
---|---|---|
List
|
object |
This feature was introduced in 8.13 |
position
|
string | |||||||||||||||||
label
|
LabelBasic | |||||||||||||||||
Properties
|
||||||||||||||||||
id
|
string |
This feature was introduced in 8.13
Name | Data Type | Description |
---|---|---|
board_id
|
integer |
The ID of a board |
id
|
string |
The ID of a project |
Name | Data Type | Description |
---|---|---|
label_id
|
integer |
The ID of an existing label |
Name | Data Type | Description |
---|---|---|
List
|
object |
This feature was introduced in 8.13 |
position
|
string | |||||||||||||||||
label
|
LabelBasic | |||||||||||||||||
Properties
|
||||||||||||||||||
id
|
string |
This feature was introduced in 8.13
Name | Data Type | Description |
---|---|---|
id
|
string |
The ID of a project |
Name | Data Type | Description |
---|---|---|
Board
|
object |
This feature was introduced in 8.13 |
lists
|
List | |||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||
id
|
string |
This feature was introduced in GitLab 8.10
Name | Data Type | Description |
---|---|---|
ref_name
|
string |
The ref from repository |
id
|
string |
The ID of a project |
Name | Data Type | Description |
---|---|---|
job
|
string |
The name for the build |
Keep the artifacts to prevent them from being deleted
Name | Data Type | Description |
---|---|---|
build_id
|
integer |
The ID of a build |
id
|
string |
The ID of a project |
Name | Data Type | Description |
---|---|---|
Build
|
object |
This feature was added in GitLab 8.11 |
user
|
User | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
tag
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
status
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
started_at
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
stage
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
runner
|
Runner | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
ref
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
pipeline
|
PipelineBasic | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
finished_at
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
created_at
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
coverage
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
commit
|
RepoCommit | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
artifacts_file
|
BuildArtifactFile | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
This feature was introduced in GitLab 8.5
Name | Data Type | Description |
---|---|---|
build_id
|
integer |
The ID of a build |
id
|
string |
The ID of a project |
Cancel a specific build of a project
Name | Data Type | Description |
---|---|---|
build_id
|
integer |
The ID of a build |
id
|
string |
The ID of a project |
Name | Data Type | Description |
---|---|---|
Build
|
object |
This feature was added in GitLab 8.11 |
user
|
User | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
tag
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
status
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
started_at
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
stage
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
runner
|
Runner | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
ref
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
pipeline
|
PipelineBasic | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
finished_at
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
created_at
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
coverage
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
commit
|
RepoCommit | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
artifacts_file
|
BuildArtifactFile | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Erase build (remove artifacts and build trace)
Name | Data Type | Description |
---|---|---|
build_id
|
integer |
The ID of a build |
id
|
string |
The ID of a project |
Name | Data Type | Description |
---|---|---|
Build
|
object |
This feature was added in GitLab 8.11 |
user
|
User | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
tag
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
status
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
started_at
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
stage
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
runner
|
Runner | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
ref
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
pipeline
|
PipelineBasic | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
finished_at
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
created_at
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
coverage
|
string | ||||||||||||||||||||||||||||||||||||||||||||||||||
commit
|
RepoCommit | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
artifacts_file
|
BuildArtifactFile | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|