@datafire/gitlab
Client library for Gitlab
Installation and Usage
npm install --save @datafire/gitlab
let gitlab = require('@datafire/gitlab').create({
private_token_header: "",
private_token_query: ""
});
.then(data => {
console.log(data);
});
Description
The platform for modern developers GitLab unifies issues, code review, CI and CD into a single UI
Actions
getV3ApplicationSettings
Get the current application settings
gitlab.getV3ApplicationSettings(null, context)
Input
This action has no parameters
Output
- output ApplicationSetting
putV3ApplicationSettings
Modify application settings
gitlab.putV3ApplicationSettings({
"domain_blacklist": "",
"two_factor_grace_period": 0,
"shared_runners_text": "",
"metrics_host": "",
"metrics_port": 0,
"metrics_pool_size": 0,
"metrics_timeout": 0,
"metrics_method_call_threshold": 0,
"metrics_sample_interval": 0,
"metrics_packet_size": 0,
"sidekiq_throttling_queus": [],
"sidekiq_throttling_factor": 0,
"recaptcha_site_key": "",
"recaptcha_private_key": "",
"akismet_api_key": "",
"sentry_dsn": "",
"koding_url": "",
"plantuml_url": "",
"housekeeping_bitmaps_enabled": true,
"housekeeping_incremental_repack_period": 0,
"housekeeping_full_repack_period": 0,
"housekeeping_gc_period": 0
}, context)
Input
- input
object
- default_branch_protection
integer
(values: 0, 1, 2): Determine if developers can push to master - default_project_visibility
integer
(values: 0, 10, 20): The default project visibility - default_snippet_visibility
integer
(values: 0, 10, 20): The default snippet visibility - default_group_visibility
integer
(values: 0, 10, 20): The default group visibility - 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. - import_sources
array
(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 - disabled_oauth_sign_in_sources
array
: Disable certain OAuth sign-in sources - enabled_git_access_protocol
string
(values: ssh, http, nil): Allow only the selected protocols to be used for Git access. - gravatar_enabled
boolean
: Flag indicating if the Gravatar service is enabled - default_projects_limit
integer
: The maximum number of personal projects - max_attachment_size
integer
: Maximum attachment size in MB - session_expire_delay
integer
: Session duration in minutes. GitLab restart is required to apply changes. - user_oauth_applications
boolean
: Allow users to register any application to use GitLab as an OAuth provider - user_default_external
boolean
: Newly registered users will by default be external - signup_enabled
boolean
: Flag indicating if sign up is enabled - send_user_confirmation_email
boolean
: Send confirmation email on sign-up - 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 - domain_blacklist_enabled
boolean
: Enable domain blacklist for sign ups - domain_blacklist required
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 - after_sign_up_text
string
: Text shown after sign up - signin_enabled
boolean
: Flag indicating if sign in is enabled - require_two_factor_authentication
boolean
: Require all users to setup Two-factor authentication - two_factor_grace_period required
integer
: Amount of time (in hours) that users are allowed to skip forced configuration of two-factor authentication - home_page_url
string
: We will redirect non-logged in users to this page - after_sign_out_path
string
: We will redirect users to this page after they sign out - sign_in_text
string
: The sign in text of the GitLab application - help_page_text
string
: Custom text displayed on the help page - shared_runners_enabled
boolean
: Enable shared runners for new projects - shared_runners_text required
string
: Shared runners text - max_artifacts_size
integer
: Set the maximum file size each build's artifacts can have - container_registry_token_expire_delay
integer
: Authorization token duration (minutes) - metrics_enabled
boolean
: Enable the InfluxDB metrics - metrics_host required
string
: The InfluxDB host - metrics_port required
integer
: The UDP port to use for connecting to InfluxDB - metrics_pool_size required
integer
: The amount of InfluxDB connections to open - metrics_timeout required
integer
: The amount of seconds after which an InfluxDB connection will time out - metrics_method_call_threshold required
integer
: A method call is only tracked when it takes longer to complete than the given amount of milliseconds. - metrics_sample_interval required
integer
: The sampling interval in seconds - metrics_packet_size required
integer
: The amount of points to store in a single UDP packet - sidekiq_throttling_enabled
boolean
: Enable Sidekiq Job Throttling - sidekiq_throttling_queus required
array
: Choose which queues you wish to throttle - sidekiq_throttling_factor required
number
: The factor by which the queues should be throttled. A value between 0.0 and 1.0, exclusive. - recaptcha_enabled
boolean
: Helps prevent bots from creating accounts - recaptcha_site_key required
string
: Generate site key at http://www.google.com/recaptcha - recaptcha_private_key required
string
: Generate private key at http://www.google.com/recaptcha - akismet_enabled
boolean
: Helps prevent bots from creating issues - akismet_api_key required
string
: Generate API key at http://www.akismet.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. - sentry_enabled
boolean
: Sentry is an error reporting and logging tool which is currently not shipped with GitLab, get it here: https://getsentry.com - sentry_dsn required
string
: Sentry Data Source Name - repository_storage
string
: Storage paths for new projects - repository_checks_enabled
boolean
: GitLab will periodically run 'git fsck' in all project and wiki repositories to look for silent disk corruption issues. - koding_enabled
boolean
: Enable Koding - koding_url required
string
: The Koding team URL - plantuml_enabled
boolean
: Enable PlantUML - plantuml_url required
string
: The PlantUML server URL - version_check_enabled
boolean
: Let GitLab inform you when an update is available. - 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. - 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. - housekeeping_enabled
boolean
: Enable automatic repository housekeeping (git repack, git gc) - housekeeping_bitmaps_enabled required
boolean
: Creating pack file bitmaps makes housekeeping take a little longer but bitmaps should accelerate 'git clone' performance. - housekeeping_incremental_repack_period required
integer
: Number of Git pushes after which an incremental 'git repack' is run. - housekeeping_full_repack_period required
integer
: Number of Git pushes after which a full 'git repack' is run. - housekeeping_gc_period required
integer
: Number of Git pushes after which 'git gc' is run.
- default_branch_protection
Output
- output ApplicationSetting
postV3CiLint
Validation of .gitlab-ci.yml content
gitlab.postV3CiLint({
"content": ""
}, context)
Input
- input
object
- content required
string
: Content of .gitlab-ci.yml
- content required
Output
Output schema unknown
getV3DeployKeys
gitlab.getV3DeployKeys(null, context)
Input
This action has no parameters
Output
Output schema unknown
getV3Dockerfiles
This feature was introduced in GitLab 8.15. This endpoint is deprecated and will be removed in GitLab 9.0.
gitlab.getV3Dockerfiles(null, context)
Input
This action has no parameters
Output
- output TemplatesList
getV3DockerfilesName
This feature was introduced in GitLab 8.15. This endpoint is deprecated and will be removed in GitLab 9.0.
gitlab.getV3DockerfilesName({
"name": ""
}, context)
Input
- input
object
- name required
string
: The name of the template
- name required
Output
- output Template
getV3Gitignores
This feature was introduced in GitLab 8.8. This endpoint is deprecated and will be removed in GitLab 9.0.
gitlab.getV3Gitignores(null, context)
Input
This action has no parameters
Output
- output TemplatesList
getV3GitignoresName
This feature was introduced in GitLab 8.8. This endpoint is deprecated and will be removed in GitLab 9.0.
gitlab.getV3GitignoresName({
"name": ""
}, context)
Input
- input
object
- name required
string
: The name of the template
- name required
Output
- output Template
getV3GitlabCiYmls
This feature was introduced in GitLab 8.9. This endpoint is deprecated and will be removed in GitLab 9.0.
gitlab.getV3GitlabCiYmls(null, context)
Input
This action has no parameters
Output
- output TemplatesList
getV3GitlabCiYmlsName
This feature was introduced in GitLab 8.9. This endpoint is deprecated and will be removed in GitLab 9.0.
gitlab.getV3GitlabCiYmlsName({
"name": ""
}, context)
Input
- input
object
- name required
string
: The name of the template
- name required
Output
- output Template
getV3Groups
Get a groups list
gitlab.getV3Groups({}, context)
Input
- input
object
- statistics
boolean
: Include project statistics - skip_groups
array
: Array of group ids to exclude from list - all_available
boolean
: Show all group that you have access to - search
string
: Search for a specific group - order_by
string
(values: name, path): Order by name or path - sort
string
(values: asc, desc): Sort by asc (ascending) or desc (descending) - page
integer
: Current page number - per_page
integer
: Number of items per page
- statistics
Output
- output Group
postV3Groups
Create a group. Available only for users who can create groups.
gitlab.postV3Groups({
"name": "",
"path": ""
}, context)
Input
- input
object
- name required
string
: The name of the group - path required
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
- name required
Output
- output Group
getV3GroupsOwned
Get list of owned groups for authenticated user
gitlab.getV3GroupsOwned({}, context)
Input
- input
object
- page
integer
: Current page number - per_page
integer
: Number of items per page - statistics
boolean
: Include project statistics
- page
Output
- output Group
deleteV3GroupsId
Remove a group.
gitlab.deleteV3GroupsId({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a group
- id required
Output
Output schema unknown
getV3GroupsId
Get a single group, with containing projects.
gitlab.getV3GroupsId({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a group
- id required
Output
- output GroupDetail
putV3GroupsId
Update a group. Available only for users who can administrate groups.
gitlab.putV3GroupsId({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a group - 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
- id required
Output
- output Group
getV3GroupsIdAccessRequests
This feature was introduced in GitLab 8.11.
gitlab.getV3GroupsIdAccessRequests({
"id": ""
}, context)
Input
- input
object
- id required
string
: The group ID - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output AccessRequester
postV3GroupsIdAccessRequests
This feature was introduced in GitLab 8.11.
gitlab.postV3GroupsIdAccessRequests({
"id": ""
}, context)
Input
- input
object
- id required
string
: The group ID
- id required
Output
- output AccessRequester
deleteV3GroupsIdAccessRequestsUserId
This feature was introduced in GitLab 8.11.
gitlab.deleteV3GroupsIdAccessRequestsUserId({
"id": "",
"user_id": 0
}, context)
Input
- input
object
- id required
string
: The group ID - user_id required
integer
: The user ID of the access requester
- id required
Output
Output schema unknown
putV3GroupsIdAccessRequestsUserIdApprove
This feature was introduced in GitLab 8.11.
gitlab.putV3GroupsIdAccessRequestsUserIdApprove({
"id": "",
"user_id": 0
}, context)
Input
- input
object
- id required
string
: The group ID - user_id required
integer
: The user ID of the access requester - access_level
integer
: A valid access level (defaults:30
, developer access level)
- id required
Output
- output Member
getV3GroupsIdIssues
Get a list of group issues
gitlab.getV3GroupsIdIssues({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a group - state
string
(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
(values: created_at, updated_at): Return issues ordered bycreated_at
orupdated_at
fields. - sort
string
(values: asc, desc): Return issues sorted inasc
ordesc
order. - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Issue
getV3GroupsIdMembers
Gets a list of group or project members viewable by the authenticated user.
gitlab.getV3GroupsIdMembers({
"id": ""
}, context)
Input
- input
object
- id required
string
: The group ID - query
string
: A query string to search for members - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Member
postV3GroupsIdMembers
Adds a member to a group or project.
gitlab.postV3GroupsIdMembers({
"id": "",
"user_id": 0,
"access_level": 0
}, context)
Input
- input
object
- id required
string
: The group ID - user_id required
integer
: The user ID of the new member - access_level required
integer
: A valid access level (defaults:30
, developer access level) - expires_at
string
: Date string in the format YEAR-MONTH-DAY
- id required
Output
- output Member
deleteV3GroupsIdMembersUserId
Removes a user from a group or project.
gitlab.deleteV3GroupsIdMembersUserId({
"id": "",
"user_id": 0
}, context)
Input
- input
object
- id required
string
: The group ID - user_id required
integer
: The user ID of the member
- id required
Output
Output schema unknown
getV3GroupsIdMembersUserId
Gets a member of a group or project.
gitlab.getV3GroupsIdMembersUserId({
"id": "",
"user_id": 0
}, context)
Input
- input
object
- id required
string
: The group ID - user_id required
integer
: The user ID of the member
- id required
Output
- output Member
putV3GroupsIdMembersUserId
Updates a member of a group or project.
gitlab.putV3GroupsIdMembersUserId({
"id": "",
"user_id": 0,
"access_level": 0
}, context)
Input
- input
object
- id required
string
: The group ID - user_id required
integer
: The user ID of the new member - access_level required
integer
: A valid access level - expires_at
string
: Date string in the format YEAR-MONTH-DAY
- id required
Output
- output Member
getV3GroupsIdNotificationSettings
This feature was introduced in GitLab 8.12
gitlab.getV3GroupsIdNotificationSettings({
"id": ""
}, context)
Input
- input
object
- id required
string
: The group ID or project ID or project NAMESPACE/PROJECT_NAME
- id required
Output
- output NotificationSetting
putV3GroupsIdNotificationSettings
This feature was introduced in GitLab 8.12
gitlab.putV3GroupsIdNotificationSettings({
"id": ""
}, context)
Input
- input
object
- id required
string
: The group ID or project ID or project NAMESPACE/PROJECT_NAME - 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
- id required
Output
- output NotificationSetting
getV3GroupsIdProjects
Get a list of projects in this group.
gitlab.getV3GroupsIdProjects({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a group - archived
boolean
: Limit by archived status - visibility
string
(values: public, internal, private): Limit by visibility - search
string
: Return list of authorized projects matching the search criteria - order_by
string
(values: id, name, path, created_at, updated_at, last_activity_at): Return projects ordered by field - sort
string
(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
- id required
Output
- output Project
postV3GroupsIdProjectsProjectId
Transfer a project to the group namespace. Available only for admin.
gitlab.postV3GroupsIdProjectsProjectId({
"id": "",
"project_id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a group - project_id required
string
: The ID or path of the project
- id required
Output
- output GroupDetail
getV3Hooks
Get the list of system hooks
gitlab.getV3Hooks(null, context)
Input
This action has no parameters
Output
- output Hook
postV3Hooks
Create a new system hook
gitlab.postV3Hooks({
"url": ""
}, context)
Input
- input
object
- url required
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
- url required
Output
- output Hook
deleteV3HooksId
Delete a hook
gitlab.deleteV3HooksId({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the system hook
- id required
Output
- output Hook
getV3HooksId
Test a hook
gitlab.getV3HooksId({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the system hook
- id required
Output
- output Hook
postV3InternalAllowed
gitlab.postV3InternalAllowed(null, context)
Input
This action has no parameters
Output
Output schema unknown
getV3InternalBroadcastMessage
gitlab.getV3InternalBroadcastMessage(null, context)
Input
This action has no parameters
Output
Output schema unknown
getV3InternalCheck
gitlab.getV3InternalCheck(null, context)
Input
This action has no parameters
Output
Output schema unknown
getV3InternalDiscover
gitlab.getV3InternalDiscover(null, context)
Input
This action has no parameters
Output
Output schema unknown
postV3InternalLfsAuthenticate
gitlab.postV3InternalLfsAuthenticate(null, context)
Input
This action has no parameters
Output
Output schema unknown
getV3InternalMergeRequestUrls
gitlab.getV3InternalMergeRequestUrls(null, context)
Input
This action has no parameters
Output
Output schema unknown
postV3InternalTwoFactorRecoveryCodes
gitlab.postV3InternalTwoFactorRecoveryCodes(null, context)
Input
This action has no parameters
Output
Output schema unknown
getV3Issues
Get currently authenticated user's issues
gitlab.getV3Issues({}, context)
Input
- input
object
- state
string
(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
(values: created_at, updated_at): Return issues ordered bycreated_at
orupdated_at
fields. - sort
string
(values: asc, desc): Return issues sorted inasc
ordesc
order. - page
integer
: Current page number - per_page
integer
: Number of items per page
- state
Output
- output Issue
getV3KeysId
Get single ssh key by id. Only available to admin users
gitlab.getV3KeysId({
"id": 0
}, context)
Input
- input
object
- id required
integer
- id required
Output
- output SSHKeyWithUser
getV3Licenses
This feature was introduced in GitLab 8.7. This endpoint is deprecated and will be removed in GitLab 9.0.
gitlab.getV3Licenses({}, context)
Input
- input
object
- popular
boolean
: If passed, returns only popular licenses
- popular
Output
- output RepoLicense
getV3LicensesName
This feature was introduced in GitLab 8.7. This endpoint is deprecated and will be removed in GitLab 9.0.
gitlab.getV3LicensesName({
"name": ""
}, context)
Input
- input
object
- name required
string
: The name of the template
- name required
Output
- output RepoLicense
getV3Namespaces
Get a namespaces list
gitlab.getV3Namespaces({}, context)
Input
- input
object
- search
string
: Search query for namespaces - page
integer
: Current page number - per_page
integer
: Number of items per page
- search
Output
- output Namespace
getV3NotificationSettings
This feature was introduced in GitLab 8.12
gitlab.getV3NotificationSettings(null, context)
Input
This action has no parameters
Output
- output GlobalNotificationSetting
putV3NotificationSettings
This feature was introduced in GitLab 8.12
gitlab.putV3NotificationSettings({}, context)
Input
- input
object
- 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
- level
Output
- output GlobalNotificationSetting
getV3Projects
Get a projects list for authenticated user
gitlab.getV3Projects({}, context)
Input
- input
object
- order_by
string
(values: id, name, path, created_at, updated_at, last_activity_at): Return projects ordered by field - sort
string
(values: asc, desc): Return projects sorted in ascending and descending order - archived
boolean
: Limit by archived status - visibility
string
(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
- order_by
Output
- output BasicProjectDetails
postV3Projects
Create new project
gitlab.postV3Projects({
"name": ""
}, context)
Input
- input
object
- name required
string
: The name of the project - path
string
: The path of the repository - description
string
: The description of the project - issues_enabled
boolean
: Flag indication if the issue tracker is enabled - merge_requests_enabled
boolean
: Flag indication if merge requests are enabled - wiki_enabled
boolean
: Flag indication if the wiki is enabled - builds_enabled
boolean
: Flag indication if builds are enabled - snippets_enabled
boolean
: Flag indication if snippets are enabled - shared_runners_enabled
boolean
: Flag indication if shared runners are enabled for that project - container_registry_enabled
boolean
: Flag indication if the container registry is enabled for that project - lfs_enabled
boolean
: Flag indication if Git LFS is enabled for that project - public
boolean
: Create a public project. The same as visibility_level = 20. - visibility_level
integer
(values: 0, 10, 20): Create a public project. The same as visibility_level = 20. - public_builds
boolean
: Perform public builds - request_access_enabled
boolean
: Allow users to request member access - only_allow_merge_if_build_succeeds
boolean
: Only allow to merge if builds succeed - only_allow_merge_if_all_discussions_are_resolved
boolean
: Only allow to merge if all discussions are resolved - namespace_id
integer
: Namespace ID for the new project. Default to the user namespace. - import_url
string
: URL from which the project is imported
- name required
Output
- output Project
getV3ProjectsAll
Get all projects for admin user
gitlab.getV3ProjectsAll({}, context)
Input
- input
object
- order_by
string
(values: id, name, path, created_at, updated_at, last_activity_at): Return projects ordered by field - sort
string
(values: asc, desc): Return projects sorted in ascending and descending order - archived
boolean
: Limit by archived status - visibility
string
(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
- order_by
Output
- output BasicProjectDetails
postV3ProjectsForkId
Fork new project for the current user or provided namespace.
gitlab.postV3ProjectsForkId({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - namespace
string
: The ID or name of the namespace that the project will be forked into
- id required
Output
- output Project
getV3ProjectsOwned
Get an owned projects list for authenticated user
gitlab.getV3ProjectsOwned({}, context)
Input
- input
object
- order_by
string
(values: id, name, path, created_at, updated_at, last_activity_at): Return projects ordered by field - sort
string
(values: asc, desc): Return projects sorted in ascending and descending order - archived
boolean
: Limit by archived status - visibility
string
(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
- order_by
Output
- output BasicProjectDetails
getV3ProjectsSearchQuery
Search for projects the current user has access to
gitlab.getV3ProjectsSearchQuery({
"query": ""
}, context)
Input
- input
object
- query required
string
: The project name to be searched - order_by
string
(values: id, name, path, created_at, updated_at, last_activity_at): Return projects ordered by field - sort
string
(values: asc, desc): Return projects sorted in ascending and descending order - page
integer
: Current page number - per_page
integer
: Number of items per page
- query required
Output
- output Project
getV3ProjectsStarred
Gets starred project for the authenticated user
gitlab.getV3ProjectsStarred({}, context)
Input
- input
object
- order_by
string
(values: id, name, path, created_at, updated_at, last_activity_at): Return projects ordered by field - sort
string
(values: asc, desc): Return projects sorted in ascending and descending order - archived
boolean
: Limit by archived status - visibility
string
(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
- order_by
Output
- output BasicProjectDetails
postV3ProjectsUserUserId
Create new project for a specified user. Only available to admin users.
gitlab.postV3ProjectsUserUserId({
"name": "",
"user_id": 0
}, context)
Input
- input
object
- name required
string
: The name of the project - user_id required
integer
: The ID of a user - default_branch
string
: The default branch of the project - description
string
: The description of the project - issues_enabled
boolean
: Flag indication if the issue tracker is enabled - merge_requests_enabled
boolean
: Flag indication if merge requests are enabled - wiki_enabled
boolean
: Flag indication if the wiki is enabled - builds_enabled
boolean
: Flag indication if builds are enabled - snippets_enabled
boolean
: Flag indication if snippets are enabled - shared_runners_enabled
boolean
: Flag indication if shared runners are enabled for that project - container_registry_enabled
boolean
: Flag indication if the container registry is enabled for that project - lfs_enabled
boolean
: Flag indication if Git LFS is enabled for that project - public
boolean
: Create a public project. The same as visibility_level = 20. - visibility_level
integer
(values: 0, 10, 20): Create a public project. The same as visibility_level = 20. - public_builds
boolean
: Perform public builds - request_access_enabled
boolean
: Allow users to request member access - only_allow_merge_if_build_succeeds
boolean
: Only allow to merge if builds succeed - only_allow_merge_if_all_discussions_are_resolved
boolean
: Only allow to merge if all discussions are resolved - namespace_id
integer
: Namespace ID for the new project. Default to the user namespace. - import_url
string
: URL from which the project is imported
- name required
Output
- output Project
getV3ProjectsVisible
Get a list of visible projects for authenticated user
gitlab.getV3ProjectsVisible({}, context)
Input
- input
object
- order_by
string
(values: id, name, path, created_at, updated_at, last_activity_at): Return projects ordered by field - sort
string
(values: asc, desc): Return projects sorted in ascending and descending order - archived
boolean
: Limit by archived status - visibility
string
(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
- order_by
Output
- output BasicProjectDetails
deleteV3ProjectsId
Remove a project
gitlab.deleteV3ProjectsId({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project
- id required
Output
Output schema unknown
getV3ProjectsId
Get a single project
gitlab.getV3ProjectsId({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project
- id required
Output
- output ProjectWithAccess
putV3ProjectsId
Update an existing project
gitlab.putV3ProjectsId({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - name
string
: The name of the project - default_branch
string
: The default branch of the project - path
string
: The path of the repository - description
string
: The description of the project - issues_enabled
boolean
: Flag indication if the issue tracker is enabled - merge_requests_enabled
boolean
: Flag indication if merge requests are enabled - wiki_enabled
boolean
: Flag indication if the wiki is enabled - builds_enabled
boolean
: Flag indication if builds are enabled - snippets_enabled
boolean
: Flag indication if snippets are enabled - shared_runners_enabled
boolean
: Flag indication if shared runners are enabled for that project - container_registry_enabled
boolean
: Flag indication if the container registry is enabled for that project - lfs_enabled
boolean
: Flag indication if Git LFS is enabled for that project - public
boolean
: Create a public project. The same as visibility_level = 20. - visibility_level
integer
(values: 0, 10, 20): Create a public project. The same as visibility_level = 20. - public_builds
boolean
: Perform public builds - request_access_enabled
boolean
: Allow users to request member access - only_allow_merge_if_build_succeeds
boolean
: Only allow to merge if builds succeed - only_allow_merge_if_all_discussions_are_resolved
boolean
: Only allow to merge if all discussions are resolved
- id required
Output
- output Project
v3.projects.id._ref.ref._trigger.builds.post
Trigger a GitLab project build
gitlab.v3.projects.id._ref.ref._trigger.builds.post({
"id": "",
"ref": "",
"token": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - ref required
string
: The commit sha or name of a branch or tag - token required
string
: The unique token of trigger
- id required
Output
- output TriggerRequest
getV3ProjectsIdAccessRequests
This feature was introduced in GitLab 8.11.
gitlab.getV3ProjectsIdAccessRequests({
"id": ""
}, context)
Input
- input
object
- id required
string
: The project ID - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output AccessRequester
postV3ProjectsIdAccessRequests
This feature was introduced in GitLab 8.11.
gitlab.postV3ProjectsIdAccessRequests({
"id": ""
}, context)
Input
- input
object
- id required
string
: The project ID
- id required
Output
- output AccessRequester
deleteV3ProjectsIdAccessRequestsUserId
This feature was introduced in GitLab 8.11.
gitlab.deleteV3ProjectsIdAccessRequestsUserId({
"id": "",
"user_id": 0
}, context)
Input
- input
object
- id required
string
: The project ID - user_id required
integer
: The user ID of the access requester
- id required
Output
Output schema unknown
putV3ProjectsIdAccessRequestsUserIdApprove
This feature was introduced in GitLab 8.11.
gitlab.putV3ProjectsIdAccessRequestsUserIdApprove({
"id": "",
"user_id": 0
}, context)
Input
- input
object
- id required
string
: The project ID - user_id required
integer
: The user ID of the access requester - access_level
integer
: A valid access level (defaults:30
, developer access level)
- id required
Output
- output Member
postV3ProjectsIdArchive
Archive a project
gitlab.postV3ProjectsIdArchive({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project
- id required
Output
- output Project
getV3ProjectsIdBoards
This feature was introduced in 8.13
gitlab.getV3ProjectsIdBoards({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project
- id required
Output
- output Board
getV3ProjectsIdBoardsBoardIdLists
Does not include backlog
and done
lists. This feature was introduced in 8.13
gitlab.getV3ProjectsIdBoardsBoardIdLists({
"id": "",
"board_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - board_id required
integer
: The ID of a board
- id required
Output
- output List
postV3ProjectsIdBoardsBoardIdLists
This feature was introduced in 8.13
gitlab.postV3ProjectsIdBoardsBoardIdLists({
"id": "",
"board_id": 0,
"label_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - board_id required
integer
: The ID of a board - label_id required
integer
: The ID of an existing label
- id required
Output
- output List
deleteV3ProjectsIdBoardsBoardIdListsListId
This feature was introduced in 8.13
gitlab.deleteV3ProjectsIdBoardsBoardIdListsListId({
"id": "",
"board_id": 0,
"list_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - board_id required
integer
: The ID of a board - list_id required
integer
: The ID of a board list
- id required
Output
- output List
getV3ProjectsIdBoardsBoardIdListsListId
This feature was introduced in 8.13
gitlab.getV3ProjectsIdBoardsBoardIdListsListId({
"id": "",
"board_id": 0,
"list_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - board_id required
integer
: The ID of a board - list_id required
integer
: The ID of a list
- id required
Output
- output List
putV3ProjectsIdBoardsBoardIdListsListId
This feature was introduced in 8.13
gitlab.putV3ProjectsIdBoardsBoardIdListsListId({
"id": "",
"board_id": 0,
"list_id": 0,
"position": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - board_id required
integer
: The ID of a board - list_id required
integer
: The ID of a list - position required
integer
: The position of the list
- id required
Output
- output List
getV3ProjectsIdBuilds
Get a project builds
gitlab.getV3ProjectsIdBuilds({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - scope
string
(values: pending, running, failed, success, canceled): The scope of builds to show - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Build
getV3ProjectsIdBuildsArtifactsRefNameDownload
This feature was introduced in GitLab 8.10
gitlab.getV3ProjectsIdBuildsArtifactsRefNameDownload({
"id": "",
"ref_name": "",
"job": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - ref_name required
string
: The ref from repository - job required
string
: The name for the build
- id required
Output
Output schema unknown
getV3ProjectsIdBuildsBuildId
Get a specific build of a project
gitlab.getV3ProjectsIdBuildsBuildId({
"id": "",
"build_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - build_id required
integer
: The ID of a build
- id required
Output
- output Build
getV3ProjectsIdBuildsBuildIdArtifacts
This feature was introduced in GitLab 8.5
gitlab.getV3ProjectsIdBuildsBuildIdArtifacts({
"id": "",
"build_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - build_id required
integer
: The ID of a build
- id required
Output
Output schema unknown
postV3ProjectsIdBuildsBuildIdArtifactsKeep
Keep the artifacts to prevent them from being deleted
gitlab.postV3ProjectsIdBuildsBuildIdArtifactsKeep({
"id": "",
"build_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - build_id required
integer
: The ID of a build
- id required
Output
- output Build
postV3ProjectsIdBuildsBuildIdCancel
Cancel a specific build of a project
gitlab.postV3ProjectsIdBuildsBuildIdCancel({
"id": "",
"build_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - build_id required
integer
: The ID of a build
- id required
Output
- output Build
postV3ProjectsIdBuildsBuildIdErase
Erase build (remove artifacts and build trace)
gitlab.postV3ProjectsIdBuildsBuildIdErase({
"id": "",
"build_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - build_id required
integer
: The ID of a build
- id required
Output
- output Build
postV3ProjectsIdBuildsBuildIdPlay
This feature was added in GitLab 8.11
gitlab.postV3ProjectsIdBuildsBuildIdPlay({
"id": "",
"build_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - build_id required
integer
: The ID of a Build
- id required
Output
- output Build
postV3ProjectsIdBuildsBuildIdRetry
Retry a specific build of a project
gitlab.postV3ProjectsIdBuildsBuildIdRetry({
"id": "",
"build_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - build_id required
integer
: The ID of a build
- id required
Output
- output Build
getV3ProjectsIdBuildsBuildIdTrace
Get a trace of a specific build of a project
gitlab.getV3ProjectsIdBuildsBuildIdTrace({
"id": "",
"build_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - build_id required
integer
: The ID of a build
- id required
Output
Output schema unknown
getV3ProjectsIdDeployKeys
Get a specific project's deploy keys
gitlab.getV3ProjectsIdDeployKeys({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of the project
- id required
Output
- output SSHKey
postV3ProjectsIdDeployKeys
Add new deploy key to currently authenticated user
gitlab.postV3ProjectsIdDeployKeys({
"id": "",
"key": "",
"title": ""
}, context)
Input
- input
object
- id required
string
: The ID of the project - key required
string
: The new deploy key - title required
string
: The name of the deploy key
- id required
Output
- output SSHKey
deleteV3ProjectsIdDeployKeysKeyId
Delete deploy key for a project
gitlab.deleteV3ProjectsIdDeployKeysKeyId({
"id": "",
"key_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of the project - key_id required
integer
: The ID of the deploy key
- id required
Output
- output SSHKey
getV3ProjectsIdDeployKeysKeyId
Get single deploy key
gitlab.getV3ProjectsIdDeployKeysKeyId({
"id": "",
"key_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of the project - key_id required
integer
: The ID of the deploy key
- id required
Output
- output SSHKey
deleteV3ProjectsIdDeployKeysKeyIdDisable
This feature was added in GitLab 8.11
gitlab.deleteV3ProjectsIdDeployKeysKeyIdDisable({
"id": "",
"key_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of the project - key_id required
integer
: The ID of the deploy key
- id required
Output
- output SSHKey
postV3ProjectsIdDeployKeysKeyIdEnable
This feature was added in GitLab 8.11
gitlab.postV3ProjectsIdDeployKeysKeyIdEnable({
"id": "",
"key_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of the project - key_id required
integer
: The ID of the deploy key
- id required
Output
- output SSHKey
getV3ProjectsIdDeployments
This feature was introduced in GitLab 8.11.
gitlab.getV3ProjectsIdDeployments({
"id": ""
}, context)
Input
- input
object
- id required
string
: The project ID - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Deployment
getV3ProjectsIdDeploymentsDeploymentId
This feature was introduced in GitLab 8.11.
gitlab.getV3ProjectsIdDeploymentsDeploymentId({
"id": "",
"deployment_id": 0
}, context)
Input
- input
object
- id required
string
: The project ID - deployment_id required
integer
: The deployment ID
- id required
Output
- output Deployment
getV3ProjectsIdEnvironments
This feature was introduced in GitLab 8.11.
gitlab.getV3ProjectsIdEnvironments({
"id": ""
}, context)
Input
- input
object
- id required
string
: The project ID - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Environment
postV3ProjectsIdEnvironments
This feature was introduced in GitLab 8.11.
gitlab.postV3ProjectsIdEnvironments({
"id": "",
"name": ""
}, context)
Input
- input
object
- id required
string
: The project ID - name required
string
: The name of the environment to be created - external_url
string
: URL on which this deployment is viewable - slug
string
- id required
Output
- output Environment
deleteV3ProjectsIdEnvironmentsEnvironmentId
This feature was introduced in GitLab 8.11.
gitlab.deleteV3ProjectsIdEnvironmentsEnvironmentId({
"id": "",
"environment_id": 0
}, context)
Input
- input
object
- id required
string
: The project ID - environment_id required
integer
: The environment ID
- id required
Output
- output Environment
putV3ProjectsIdEnvironmentsEnvironmentId
This feature was introduced in GitLab 8.11.
gitlab.putV3ProjectsIdEnvironmentsEnvironmentId({
"id": "",
"environment_id": 0
}, context)
Input
- input
object
- id required
string
: The project ID - environment_id required
integer
: The environment ID - name
string
: The new environment name - external_url
string
: The new URL on which this deployment is viewable - slug
string
- id required
Output
- output Environment
getV3ProjectsIdEvents
Get events for a single project
gitlab.getV3ProjectsIdEvents({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Event
deleteV3ProjectsIdFork
Remove a forked_from relationship
gitlab.deleteV3ProjectsIdFork({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project
- id required
Output
Output schema unknown
postV3ProjectsIdForkForkedFromId
Mark this project as forked from another
gitlab.postV3ProjectsIdForkForkedFromId({
"id": "",
"forked_from_id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - forked_from_id required
string
: The ID of the project it was forked from
- id required
Output
Output schema unknown
getV3ProjectsIdHooks
Get project hooks
gitlab.getV3ProjectsIdHooks({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output ProjectHook
postV3ProjectsIdHooks
Add hook to project
gitlab.postV3ProjectsIdHooks({
"id": "",
"url": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - url required
string
: The URL to send the request to - push_events
boolean
: Trigger hook on push events - issues_events
boolean
: Trigger hook on issues events - merge_requests_events
boolean
: Trigger hook on merge request events - tag_push_events
boolean
: Trigger hook on tag push events - note_events
boolean
: Trigger hook on note(comment) events - build_events
boolean
: Trigger hook on build events - pipeline_events
boolean
: Trigger hook on pipeline events - wiki_page_events
boolean
: Trigger hook on wiki events - enable_ssl_verification
boolean
: Do SSL verification when triggering the hook - token
string
: Secret token to validate received payloads; this will not be returned in the response
- id required
Output
- output ProjectHook
deleteV3ProjectsIdHooksHookId
Deletes project hook
gitlab.deleteV3ProjectsIdHooksHookId({
"id": "",
"hook_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - hook_id required
integer
: The ID of the hook to delete
- id required
Output
- output ProjectHook
getV3ProjectsIdHooksHookId
Get a project hook
gitlab.getV3ProjectsIdHooksHookId({
"id": "",
"hook_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - hook_id required
integer
: The ID of a project hook
- id required
Output
- output ProjectHook
putV3ProjectsIdHooksHookId
Update an existing project hook
gitlab.putV3ProjectsIdHooksHookId({
"id": "",
"hook_id": 0,
"url": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - hook_id required
integer
: The ID of the hook to update - url required
string
: The URL to send the request to - push_events
boolean
: Trigger hook on push events - issues_events
boolean
: Trigger hook on issues events - merge_requests_events
boolean
: Trigger hook on merge request events - tag_push_events
boolean
: Trigger hook on tag push events - note_events
boolean
: Trigger hook on note(comment) events - build_events
boolean
: Trigger hook on build events - pipeline_events
boolean
: Trigger hook on pipeline events - wiki_page_events
boolean
: Trigger hook on wiki events - enable_ssl_verification
boolean
: Do SSL verification when triggering the hook - token
string
: Secret token to validate received payloads; this will not be returned in the response
- id required
Output
- output ProjectHook
getV3ProjectsIdIssues
Get a list of project issues
gitlab.getV3ProjectsIdIssues({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - state
string
(values: opened, closed, all): Return opened, closed, or all issues - iid
integer
: Return the issue having the giveniid
- labels
string
: Comma-separated list of label names - milestone
string
: Return issues for a specific milestone - order_by
string
(values: created_at, updated_at): Return issues ordered bycreated_at
orupdated_at
fields. - sort
string
(values: asc, desc): Return issues sorted inasc
ordesc
order. - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Issue
postV3ProjectsIdIssues
Create a new project issue
gitlab.postV3ProjectsIdIssues({
"id": "",
"title": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - title required
string
: The title of an issue - created_at
string
: Date time when the issue was created. Available only for admins and project owners. - merge_request_for_resolving_discussions
integer
: The IID of a merge request for which to resolve discussions - description
string
: The description of an issue - assignee_id
integer
: The ID of a user to assign issue - milestone_id
integer
: The ID of a milestone to assign issue - labels
string
: Comma-separated list of label names - due_date
string
: Date time string in the format YEAR-MONTH-DAY - confidential
boolean
: Boolean parameter if the issue should be confidential
- id required
Output
- output Issue
deleteV3ProjectsIdIssuesIssueId
Delete a project issue
gitlab.deleteV3ProjectsIdIssuesIssueId({
"id": "",
"issue_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - issue_id required
integer
: The ID of a project issue
- id required
Output
Output schema unknown
getV3ProjectsIdIssuesIssueId
Get a single project issue
gitlab.getV3ProjectsIdIssuesIssueId({
"id": "",
"issue_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - issue_id required
integer
: The ID of a project issue
- id required
Output
- output Issue
putV3ProjectsIdIssuesIssueId
Update an existing issue
gitlab.putV3ProjectsIdIssuesIssueId({
"id": "",
"issue_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - issue_id required
integer
: The ID of a project issue - title
string
: The title of an issue - updated_at
string
: Date time when the issue was updated. Available only for admins and project owners. - state_event
string
(values: reopen, close): State of the issue - description
string
: The description of an issue - assignee_id
integer
: The ID of a user to assign issue - milestone_id
integer
: The ID of a milestone to assign issue - labels
string
: Comma-separated list of label names - due_date
string
: Date time string in the format YEAR-MONTH-DAY - confidential
boolean
: Boolean parameter if the issue should be confidential - created_at
string
- id required
Output
- output Issue
postV3ProjectsIdIssuesIssueIdAddSpentTime
Add spent time for a project issue
gitlab.postV3ProjectsIdIssuesIssueIdAddSpentTime({
"id": "",
"issue_id": 0,
"duration": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - issue_id required
integer
: The ID of a project issue - duration required
string
: The duration to be parsed
- id required
Output
Output schema unknown
getV3ProjectsIdIssuesIssueIdAwardEmoji
This feature was introduced in 8.9
gitlab.getV3ProjectsIdIssuesIssueIdAwardEmoji({
"id": "",
"issue_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - issue_id required
integer
: The ID of an Issue, Merge Request or Snippet - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output AwardEmoji
postV3ProjectsIdIssuesIssueIdAwardEmoji
This feature was introduced in 8.9
gitlab.postV3ProjectsIdIssuesIssueIdAwardEmoji({
"name": "",
"id": 0,
"issue_id": 0
}, context)
Input
- input
object
- name required
string
: The name of a award_emoji (without colons) - id required
integer
- issue_id required
integer
- name required
Output
- output AwardEmoji
deleteV3ProjectsIdIssuesIssueIdAwardEmojiAwardId
This feature was introduced in 8.9
gitlab.deleteV3ProjectsIdIssuesIssueIdAwardEmojiAwardId({
"award_id": 0,
"id": 0,
"issue_id": 0
}, context)
Input
- input
object
- award_id required
integer
: The ID of an award emoji - id required
integer
- issue_id required
integer
- award_id required
Output
- output AwardEmoji
getV3ProjectsIdIssuesIssueIdAwardEmojiAwardId
This feature was introduced in 8.9
gitlab.getV3ProjectsIdIssuesIssueIdAwardEmojiAwardId({
"award_id": 0,
"id": 0,
"issue_id": 0
}, context)
Input
- input
object
- award_id required
integer
: The ID of the award - id required
integer
- issue_id required
integer
- award_id required
Output
- output AwardEmoji
postV3ProjectsIdIssuesIssueIdMove
Move an existing issue
gitlab.postV3ProjectsIdIssuesIssueIdMove({
"id": "",
"issue_id": 0,
"to_project_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - issue_id required
integer
: The ID of a project issue - to_project_id required
integer
: The ID of the new project
- id required
Output
- output Issue
getV3ProjectsIdIssuesIssueIdNotesNoteIdAwardEmoji
This feature was introduced in 8.9
gitlab.getV3ProjectsIdIssuesIssueIdNotesNoteIdAwardEmoji({
"id": 0,
"issue_id": 0,
"note_id": 0
}, context)
Input
- input
object
- page
integer
: Current page number - per_page
integer
: Number of items per page - id required
integer
- issue_id required
integer
- note_id required
integer
- page
Output
- output AwardEmoji
postV3ProjectsIdIssuesIssueIdNotesNoteIdAwardEmoji
This feature was introduced in 8.9
gitlab.postV3ProjectsIdIssuesIssueIdNotesNoteIdAwardEmoji({
"name": "",
"id": 0,
"issue_id": 0,
"note_id": 0
}, context)
Input
- input
object
- name required
string
: The name of a award_emoji (without colons) - id required
integer
- issue_id required
integer
- note_id required
integer
- name required
Output
- output AwardEmoji
deleteV3ProjectsIdIssuesIssueIdNotesNoteIdAwardEmojiAwardId
This feature was introduced in 8.9
gitlab.deleteV3ProjectsIdIssuesIssueIdNotesNoteIdAwardEmojiAwardId({
"award_id": 0,
"id": 0,
"issue_id": 0,
"note_id": 0
}, context)
Input
- input
object
- award_id required
integer
: The ID of an award emoji - id required
integer
- issue_id required
integer
- note_id required
integer
- award_id required
Output
- output AwardEmoji
getV3ProjectsIdIssuesIssueIdNotesNoteIdAwardEmojiAwardId
This feature was introduced in 8.9
gitlab.getV3ProjectsIdIssuesIssueIdNotesNoteIdAwardEmojiAwardId({
"award_id": 0,
"id": 0,
"issue_id": 0,
"note_id": 0
}, context)
Input
- input
object
- award_id required
integer
: The ID of the award - id required
integer
- issue_id required
integer
- note_id required
integer
- award_id required
Output
- output AwardEmoji
postV3ProjectsIdIssuesIssueIdResetSpentTime
Reset spent time for a project issue
gitlab.postV3ProjectsIdIssuesIssueIdResetSpentTime({
"id": "",
"issue_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - issue_id required
integer
: The ID of a project issue
- id required
Output
Output schema unknown
postV3ProjectsIdIssuesIssueIdResetTimeEstimate
Reset the time estimate for a project issue
gitlab.postV3ProjectsIdIssuesIssueIdResetTimeEstimate({
"id": "",
"issue_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - issue_id required
integer
: The ID of a project issue
- id required
Output
Output schema unknown
postV3ProjectsIdIssuesIssueIdTimeEstimate
Set a time estimate for a project issue
gitlab.postV3ProjectsIdIssuesIssueIdTimeEstimate({
"id": "",
"issue_id": 0,
"duration": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - issue_id required
integer
: The ID of a project issue - duration required
string
: The duration to be parsed
- id required
Output
Output schema unknown
getV3ProjectsIdIssuesIssueIdTimeStats
Show time stats for a project issue
gitlab.getV3ProjectsIdIssuesIssueIdTimeStats({
"id": "",
"issue_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - issue_id required
integer
: The ID of a project issue
- id required
Output
Output schema unknown
postV3ProjectsIdIssuesIssueIdTodo
Create a todo on an issuable
gitlab.postV3ProjectsIdIssuesIssueIdTodo({
"id": "",
"issue_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - issue_id required
integer
: The ID of an issuable
- id required
Output
- output Todo
getV3ProjectsIdIssuesNoteableIdNotes
Get a list of project +noteable+ notes
gitlab.getV3ProjectsIdIssuesNoteableIdNotes({
"id": "",
"noteable_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - noteable_id required
integer
: The ID of the noteable - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Note
postV3ProjectsIdIssuesNoteableIdNotes
Create a new +noteable+ note
gitlab.postV3ProjectsIdIssuesNoteableIdNotes({
"id": "",
"noteable_id": 0,
"body": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - noteable_id required
integer
: The ID of the noteable - body required
string
: The content of a note - created_at
string
: The creation date of the note
- id required
Output
- output Note
deleteV3ProjectsIdIssuesNoteableIdNotesNoteId
Delete a +noteable+ note
gitlab.deleteV3ProjectsIdIssuesNoteableIdNotesNoteId({
"id": "",
"noteable_id": 0,
"note_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - noteable_id required
integer
: The ID of the noteable - note_id required
integer
: The ID of a note
- id required
Output
- output Note
getV3ProjectsIdIssuesNoteableIdNotesNoteId
Get a single +noteable+ note
gitlab.getV3ProjectsIdIssuesNoteableIdNotesNoteId({
"id": "",
"note_id": 0,
"noteable_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - note_id required
integer
: The ID of a note - noteable_id required
integer
: The ID of the noteable
- id required
Output
- output Note
putV3ProjectsIdIssuesNoteableIdNotesNoteId
Update an existing +noteable+ note
gitlab.putV3ProjectsIdIssuesNoteableIdNotesNoteId({
"id": "",
"noteable_id": 0,
"note_id": 0,
"body": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - noteable_id required
integer
: The ID of the noteable - note_id required
integer
: The ID of a note - body required
string
: The content of a note
- id required
Output
- output Note
deleteV3ProjectsIdIssuesSubscribableIdSubscription
Unsubscribe from a resource
gitlab.deleteV3ProjectsIdIssuesSubscribableIdSubscription({
"id": "",
"subscribable_id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - subscribable_id required
string
: The ID of a resource
- id required
Output
- output Issue
postV3ProjectsIdIssuesSubscribableIdSubscription
Subscribe to a resource
gitlab.postV3ProjectsIdIssuesSubscribableIdSubscription({
"id": "",
"subscribable_id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - subscribable_id required
string
: The ID of a resource
- id required
Output
- output Issue
getV3ProjectsIdKeys
Get a specific project's deploy keys
gitlab.getV3ProjectsIdKeys({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of the project
- id required
Output
- output SSHKey
postV3ProjectsIdKeys
Add new deploy key to currently authenticated user
gitlab.postV3ProjectsIdKeys({
"id": "",
"key": "",
"title": ""
}, context)
Input
- input
object
- id required
string
: The ID of the project - key required
string
: The new deploy key - title required
string
: The name of the deploy key
- id required
Output
- output SSHKey
deleteV3ProjectsIdKeysKeyId
Delete deploy key for a project
gitlab.deleteV3ProjectsIdKeysKeyId({
"id": "",
"key_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of the project - key_id required
integer
: The ID of the deploy key
- id required
Output
- output SSHKey
getV3ProjectsIdKeysKeyId
Get single deploy key
gitlab.getV3ProjectsIdKeysKeyId({
"id": "",
"key_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of the project - key_id required
integer
: The ID of the deploy key
- id required
Output
- output SSHKey
deleteV3ProjectsIdKeysKeyIdDisable
This feature was added in GitLab 8.11
gitlab.deleteV3ProjectsIdKeysKeyIdDisable({
"id": "",
"key_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of the project - key_id required
integer
: The ID of the deploy key
- id required
Output
- output SSHKey
postV3ProjectsIdKeysKeyIdEnable
This feature was added in GitLab 8.11
gitlab.postV3ProjectsIdKeysKeyIdEnable({
"id": "",
"key_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of the project - key_id required
integer
: The ID of the deploy key
- id required
Output
- output SSHKey
deleteV3ProjectsIdLabels
Delete an existing label
gitlab.deleteV3ProjectsIdLabels({
"id": "",
"name": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - name required
string
: The name of the label to be deleted
- id required
Output
- output Label
getV3ProjectsIdLabels
Get all labels of the project
gitlab.getV3ProjectsIdLabels({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project
- id required
Output
- output Label
postV3ProjectsIdLabels
Create a new label
gitlab.postV3ProjectsIdLabels({
"id": "",
"name": "",
"color": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - name required
string
: The name of the label to be created - color required
string
: The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) - description
string
: The description of label to be created - priority
integer
: The priority of the label
- id required
Output
- output Label
putV3ProjectsIdLabels
Update an existing label. At least one optional parameter is required.
gitlab.putV3ProjectsIdLabels({
"id": "",
"name": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - name required
string
: The name of the label to be updated - new_name
string
: The new name of the label - color
string
: The new color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) - description
string
: The new description of label - priority
integer
: The priority of the label
- id required
Output
- output Label
deleteV3ProjectsIdLabelsSubscribableIdSubscription
Unsubscribe from a resource
gitlab.deleteV3ProjectsIdLabelsSubscribableIdSubscription({
"id": "",
"subscribable_id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - subscribable_id required
string
: The ID of a resource
- id required
Output
- output Label
postV3ProjectsIdLabelsSubscribableIdSubscription
Subscribe to a resource
gitlab.postV3ProjectsIdLabelsSubscribableIdSubscription({
"id": "",
"subscribable_id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - subscribable_id required
string
: The ID of a resource
- id required
Output
- output Label
getV3ProjectsIdMembers
Gets a list of group or project members viewable by the authenticated user.
gitlab.getV3ProjectsIdMembers({
"id": ""
}, context)
Input
- input
object
- id required
string
: The project ID - query
string
: A query string to search for members - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Member
postV3ProjectsIdMembers
Adds a member to a group or project.
gitlab.postV3ProjectsIdMembers({
"id": "",
"user_id": 0,
"access_level": 0
}, context)
Input
- input
object
- id required
string
: The project ID - user_id required
integer
: The user ID of the new member - access_level required
integer
: A valid access level (defaults:30
, developer access level) - expires_at
string
: Date string in the format YEAR-MONTH-DAY
- id required
Output
- output Member
deleteV3ProjectsIdMembersUserId
Removes a user from a group or project.
gitlab.deleteV3ProjectsIdMembersUserId({
"id": "",
"user_id": 0
}, context)
Input
- input
object
- id required
string
: The project ID - user_id required
integer
: The user ID of the member
- id required
Output
Output schema unknown
getV3ProjectsIdMembersUserId
Gets a member of a group or project.
gitlab.getV3ProjectsIdMembersUserId({
"id": "",
"user_id": 0
}, context)
Input
- input
object
- id required
string
: The project ID - user_id required
integer
: The user ID of the member
- id required
Output
- output Member
putV3ProjectsIdMembersUserId
Updates a member of a group or project.
gitlab.putV3ProjectsIdMembersUserId({
"id": "",
"user_id": 0,
"access_level": 0
}, context)
Input
- input
object
- id required
string
: The project ID - user_id required
integer
: The user ID of the new member - access_level required
integer
: A valid access level - expires_at
string
: Date string in the format YEAR-MONTH-DAY
- id required
Output
- output Member
getV3ProjectsIdMergeRequestMergeRequestId
This endpoint is deprecated and will be removed in GitLab 9.0.
gitlab.getV3ProjectsIdMergeRequestMergeRequestId({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
: The ID of a merge request
- id required
Output
- output MergeRequest
putV3ProjectsIdMergeRequestMergeRequestId
Update a merge request
gitlab.putV3ProjectsIdMergeRequestMergeRequestId({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - title
string
: The title of the merge request - target_branch
string
: The target branch - state_event
string
(values: close, reopen, merge): Status of the merge request - description
string
: The description of the merge request - assignee_id
integer
: The ID of a user to assign the merge request - milestone_id
integer
: The ID of a milestone to assign the merge request - labels
string
: Comma-separated list of label names - remove_source_branch
boolean
: Remove source branch when merging - merge_request_id required
integer
- id required
Output
- output MergeRequest
postV3ProjectsIdMergeRequestMergeRequestIdCancelMergeWhenBuildSucceeds
Cancel merge if "Merge When Pipeline Succeeds" is enabled
gitlab.postV3ProjectsIdMergeRequestMergeRequestIdCancelMergeWhenBuildSucceeds({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
- id required
Output
- output MergeRequest
getV3ProjectsIdMergeRequestMergeRequestIdChanges
Show the merge request changes
gitlab.getV3ProjectsIdMergeRequestMergeRequestIdChanges({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
- id required
Output
- output MergeRequestChanges
getV3ProjectsIdMergeRequestMergeRequestIdClosesIssues
List issues that will be closed on merge
gitlab.getV3ProjectsIdMergeRequestMergeRequestIdClosesIssues({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - page
integer
: Current page number - per_page
integer
: Number of items per page - merge_request_id required
integer
- id required
Output
- output MRNote
getV3ProjectsIdMergeRequestMergeRequestIdComments
Duplicate. DEPRECATED and WILL BE REMOVED in 9.0
gitlab.getV3ProjectsIdMergeRequestMergeRequestIdComments({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - page
integer
: Current page number - per_page
integer
: Number of items per page - merge_request_id required
integer
- id required
Output
- output MRNote
postV3ProjectsIdMergeRequestMergeRequestIdComments
Duplicate. DEPRECATED and WILL BE REMOVED in 9.0
gitlab.postV3ProjectsIdMergeRequestMergeRequestIdComments({
"id": "",
"note": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - note required
string
: The text of the comment - merge_request_id required
integer
- id required
Output
- output MRNote
getV3ProjectsIdMergeRequestMergeRequestIdCommits
Get the commits of a merge request
gitlab.getV3ProjectsIdMergeRequestMergeRequestIdCommits({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
- id required
Output
- output RepoCommit
putV3ProjectsIdMergeRequestMergeRequestIdMerge
Merge a merge request
gitlab.putV3ProjectsIdMergeRequestMergeRequestIdMerge({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_commit_message
string
: Custom merge commit message - should_remove_source_branch
boolean
: When true, the source branch will be deleted if possible - merge_when_build_succeeds
boolean
: When true, this merge request will be merged when the pipeline succeeds - sha
string
: When present, must have the HEAD SHA of the source branch - merge_request_id required
integer
- id required
Output
- output MergeRequest
deleteV3ProjectsIdMergeRequestSubscribableIdSubscription
Unsubscribe from a resource
gitlab.deleteV3ProjectsIdMergeRequestSubscribableIdSubscription({
"id": "",
"subscribable_id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - subscribable_id required
string
: The ID of a resource
- id required
Output
- output MergeRequest
postV3ProjectsIdMergeRequestSubscribableIdSubscription
Subscribe to a resource
gitlab.postV3ProjectsIdMergeRequestSubscribableIdSubscription({
"id": "",
"subscribable_id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - subscribable_id required
string
: The ID of a resource
- id required
Output
- output MergeRequest
getV3ProjectsIdMergeRequests
List merge requests
gitlab.getV3ProjectsIdMergeRequests({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - state
string
(values: opened, closed, merged, all): Return opened, closed, merged, or all merge requests - order_by
string
(values: created_at, updated_at): Return merge requests ordered bycreated_at
orupdated_at
fields. - sort
string
(values: asc, desc): Return merge requests sorted inasc
ordesc
order. - iid
array
: The IID of the merge requests - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output MergeRequest
postV3ProjectsIdMergeRequests
Create a merge request
gitlab.postV3ProjectsIdMergeRequests({
"id": "",
"title": "",
"source_branch": "",
"target_branch": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - title required
string
: The title of the merge request - source_branch required
string
: The source branch - target_branch required
string
: The target branch - target_project_id
integer
: The target project of the merge request defaults to the :id of the project - description
string
: The description of the merge request - assignee_id
integer
: The ID of a user to assign the merge request - milestone_id
integer
: The ID of a milestone to assign the merge request - labels
string
: Comma-separated list of label names - remove_source_branch
boolean
: Remove source branch when merging
- id required
Output
- output MergeRequest
deleteV3ProjectsIdMergeRequestsMergeRequestId
Delete a merge request
gitlab.deleteV3ProjectsIdMergeRequestsMergeRequestId({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
: The ID of a merge request
- id required
Output
Output schema unknown
getV3ProjectsIdMergeRequestsMergeRequestId
Get a single merge request
gitlab.getV3ProjectsIdMergeRequestsMergeRequestId({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
- id required
Output
- output MergeRequest
putV3ProjectsIdMergeRequestsMergeRequestId
Update a merge request
gitlab.putV3ProjectsIdMergeRequestsMergeRequestId({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - title
string
: The title of the merge request - target_branch
string
: The target branch - state_event
string
(values: close, reopen, merge): Status of the merge request - description
string
: The description of the merge request - assignee_id
integer
: The ID of a user to assign the merge request - milestone_id
integer
: The ID of a milestone to assign the merge request - labels
string
: Comma-separated list of label names - remove_source_branch
boolean
: Remove source branch when merging - merge_request_id required
integer
- id required
Output
- output MergeRequest
postV3ProjectsIdMergeRequestsMergeRequestIdAddSpentTime
Add spent time for a project merge_request
gitlab.postV3ProjectsIdMergeRequestsMergeRequestIdAddSpentTime({
"id": "",
"merge_request_id": 0,
"duration": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
: The ID of a project merge_request - duration required
string
: The duration to be parsed
- id required
Output
Output schema unknown
getV3ProjectsIdMergeRequestsMergeRequestIdAwardEmoji
This feature was introduced in 8.9
gitlab.getV3ProjectsIdMergeRequestsMergeRequestIdAwardEmoji({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
: The ID of an Issue, Merge Request or Snippet - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output AwardEmoji
postV3ProjectsIdMergeRequestsMergeRequestIdAwardEmoji
This feature was introduced in 8.9
gitlab.postV3ProjectsIdMergeRequestsMergeRequestIdAwardEmoji({
"name": "",
"id": 0,
"merge_request_id": 0
}, context)
Input
- input
object
- name required
string
: The name of a award_emoji (without colons) - id required
integer
- merge_request_id required
integer
- name required
Output
- output AwardEmoji
deleteV3ProjectsIdMergeRequestsMergeRequestIdAwardEmojiAwardId
This feature was introduced in 8.9
gitlab.deleteV3ProjectsIdMergeRequestsMergeRequestIdAwardEmojiAwardId({
"award_id": 0,
"id": 0,
"merge_request_id": 0
}, context)
Input
- input
object
- award_id required
integer
: The ID of an award emoji - id required
integer
- merge_request_id required
integer
- award_id required
Output
- output AwardEmoji
getV3ProjectsIdMergeRequestsMergeRequestIdAwardEmojiAwardId
This feature was introduced in 8.9
gitlab.getV3ProjectsIdMergeRequestsMergeRequestIdAwardEmojiAwardId({
"award_id": 0,
"id": 0,
"merge_request_id": 0
}, context)
Input
- input
object
- award_id required
integer
: The ID of the award - id required
integer
- merge_request_id required
integer
- award_id required
Output
- output AwardEmoji
postV3ProjectsIdMergeRequestsMergeRequestIdCancelMergeWhenBuildSucceeds
Cancel merge if "Merge When Pipeline Succeeds" is enabled
gitlab.postV3ProjectsIdMergeRequestsMergeRequestIdCancelMergeWhenBuildSucceeds({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
- id required
Output
- output MergeRequest
getV3ProjectsIdMergeRequestsMergeRequestIdChanges
Show the merge request changes
gitlab.getV3ProjectsIdMergeRequestsMergeRequestIdChanges({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
- id required
Output
- output MergeRequestChanges
getV3ProjectsIdMergeRequestsMergeRequestIdClosesIssues
List issues that will be closed on merge
gitlab.getV3ProjectsIdMergeRequestsMergeRequestIdClosesIssues({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - page
integer
: Current page number - per_page
integer
: Number of items per page - merge_request_id required
integer
- id required
Output
- output MRNote
getV3ProjectsIdMergeRequestsMergeRequestIdComments
Duplicate. DEPRECATED and WILL BE REMOVED in 9.0
gitlab.getV3ProjectsIdMergeRequestsMergeRequestIdComments({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - page
integer
: Current page number - per_page
integer
: Number of items per page - merge_request_id required
integer
- id required
Output
- output MRNote
postV3ProjectsIdMergeRequestsMergeRequestIdComments
Duplicate. DEPRECATED and WILL BE REMOVED in 9.0
gitlab.postV3ProjectsIdMergeRequestsMergeRequestIdComments({
"id": "",
"note": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - note required
string
: The text of the comment - merge_request_id required
integer
- id required
Output
- output MRNote
getV3ProjectsIdMergeRequestsMergeRequestIdCommits
Get the commits of a merge request
gitlab.getV3ProjectsIdMergeRequestsMergeRequestIdCommits({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
- id required
Output
- output RepoCommit
putV3ProjectsIdMergeRequestsMergeRequestIdMerge
Merge a merge request
gitlab.putV3ProjectsIdMergeRequestsMergeRequestIdMerge({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_commit_message
string
: Custom merge commit message - should_remove_source_branch
boolean
: When true, the source branch will be deleted if possible - merge_when_build_succeeds
boolean
: When true, this merge request will be merged when the pipeline succeeds - sha
string
: When present, must have the HEAD SHA of the source branch - merge_request_id required
integer
- id required
Output
- output MergeRequest
getV3ProjectsIdMergeRequestsMergeRequestIdNotesNoteIdAwardEmoji
This feature was introduced in 8.9
gitlab.getV3ProjectsIdMergeRequestsMergeRequestIdNotesNoteIdAwardEmoji({
"id": 0,
"merge_request_id": 0,
"note_id": 0
}, context)
Input
- input
object
- page
integer
: Current page number - per_page
integer
: Number of items per page - id required
integer
- merge_request_id required
integer
- note_id required
integer
- page
Output
- output AwardEmoji
postV3ProjectsIdMergeRequestsMergeRequestIdNotesNoteIdAwardEmoji
This feature was introduced in 8.9
gitlab.postV3ProjectsIdMergeRequestsMergeRequestIdNotesNoteIdAwardEmoji({
"name": "",
"id": 0,
"merge_request_id": 0,
"note_id": 0
}, context)
Input
- input
object
- name required
string
: The name of a award_emoji (without colons) - id required
integer
- merge_request_id required
integer
- note_id required
integer
- name required
Output
- output AwardEmoji
deleteV3ProjectsIdMergeRequestsMergeRequestIdNotesNoteIdAwardEmojiAwardId
This feature was introduced in 8.9
gitlab.deleteV3ProjectsIdMergeRequestsMergeRequestIdNotesNoteIdAwardEmojiAwardId({
"award_id": 0,
"id": 0,
"merge_request_id": 0,
"note_id": 0
}, context)
Input
- input
object
- award_id required
integer
: The ID of an award emoji - id required
integer
- merge_request_id required
integer
- note_id required
integer
- award_id required
Output
- output AwardEmoji
getV3ProjectsIdMergeRequestsMergeRequestIdNotesNoteIdAwardEmojiAwardId
This feature was introduced in 8.9
gitlab.getV3ProjectsIdMergeRequestsMergeRequestIdNotesNoteIdAwardEmojiAwardId({
"award_id": 0,
"id": 0,
"merge_request_id": 0,
"note_id": 0
}, context)
Input
- input
object
- award_id required
integer
: The ID of the award - id required
integer
- merge_request_id required
integer
- note_id required
integer
- award_id required
Output
- output AwardEmoji
postV3ProjectsIdMergeRequestsMergeRequestIdResetSpentTime
Reset spent time for a project merge_request
gitlab.postV3ProjectsIdMergeRequestsMergeRequestIdResetSpentTime({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
: The ID of a project merge_request
- id required
Output
Output schema unknown
postV3ProjectsIdMergeRequestsMergeRequestIdResetTimeEstimate
Reset the time estimate for a project merge_request
gitlab.postV3ProjectsIdMergeRequestsMergeRequestIdResetTimeEstimate({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
: The ID of a project merge_request
- id required
Output
Output schema unknown
postV3ProjectsIdMergeRequestsMergeRequestIdTimeEstimate
Set a time estimate for a project merge_request
gitlab.postV3ProjectsIdMergeRequestsMergeRequestIdTimeEstimate({
"id": "",
"merge_request_id": 0,
"duration": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
: The ID of a project merge_request - duration required
string
: The duration to be parsed
- id required
Output
Output schema unknown
getV3ProjectsIdMergeRequestsMergeRequestIdTimeStats
Show time stats for a project merge_request
gitlab.getV3ProjectsIdMergeRequestsMergeRequestIdTimeStats({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
: The ID of a project merge_request
- id required
Output
Output schema unknown
postV3ProjectsIdMergeRequestsMergeRequestIdTodo
Create a todo on an issuable
gitlab.postV3ProjectsIdMergeRequestsMergeRequestIdTodo({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
: The ID of an issuable
- id required
Output
- output Todo
getV3ProjectsIdMergeRequestsMergeRequestIdVersions
This feature was introduced in GitLab 8.12.
gitlab.getV3ProjectsIdMergeRequestsMergeRequestIdVersions({
"id": "",
"merge_request_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
: The ID of a merge request
- id required
Output
- output MergeRequestDiff
getV3ProjectsIdMergeRequestsMergeRequestIdVersionsVersionId
This feature was introduced in GitLab 8.12.
gitlab.getV3ProjectsIdMergeRequestsMergeRequestIdVersionsVersionId({
"id": "",
"merge_request_id": 0,
"version_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - merge_request_id required
integer
: The ID of a merge request - version_id required
integer
: The ID of a merge request diff version
- id required
Output
- output MergeRequestDiffFull
getV3ProjectsIdMergeRequestsNoteableIdNotes
Get a list of project +noteable+ notes
gitlab.getV3ProjectsIdMergeRequestsNoteableIdNotes({
"id": "",
"noteable_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - noteable_id required
integer
: The ID of the noteable - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Note
postV3ProjectsIdMergeRequestsNoteableIdNotes
Create a new +noteable+ note
gitlab.postV3ProjectsIdMergeRequestsNoteableIdNotes({
"id": "",
"noteable_id": 0,
"body": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - noteable_id required
integer
: The ID of the noteable - body required
string
: The content of a note - created_at
string
: The creation date of the note
- id required
Output
- output Note
deleteV3ProjectsIdMergeRequestsNoteableIdNotesNoteId
Delete a +noteable+ note
gitlab.deleteV3ProjectsIdMergeRequestsNoteableIdNotesNoteId({
"id": "",
"noteable_id": 0,
"note_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - noteable_id required
integer
: The ID of the noteable - note_id required
integer
: The ID of a note
- id required
Output
- output Note
getV3ProjectsIdMergeRequestsNoteableIdNotesNoteId
Get a single +noteable+ note
gitlab.getV3ProjectsIdMergeRequestsNoteableIdNotesNoteId({
"id": "",
"note_id": 0,
"noteable_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - note_id required
integer
: The ID of a note - noteable_id required
integer
: The ID of the noteable
- id required
Output
- output Note
putV3ProjectsIdMergeRequestsNoteableIdNotesNoteId
Update an existing +noteable+ note
gitlab.putV3ProjectsIdMergeRequestsNoteableIdNotesNoteId({
"id": "",
"noteable_id": 0,
"note_id": 0,
"body": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - noteable_id required
integer
: The ID of the noteable - note_id required
integer
: The ID of a note - body required
string
: The content of a note
- id required
Output
- output Note
deleteV3ProjectsIdMergeRequestsSubscribableIdSubscription
Unsubscribe from a resource
gitlab.deleteV3ProjectsIdMergeRequestsSubscribableIdSubscription({
"id": "",
"subscribable_id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - subscribable_id required
string
: The ID of a resource
- id required
Output
- output MergeRequest
postV3ProjectsIdMergeRequestsSubscribableIdSubscription
Subscribe to a resource
gitlab.postV3ProjectsIdMergeRequestsSubscribableIdSubscription({
"id": "",
"subscribable_id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - subscribable_id required
string
: The ID of a resource
- id required
Output
- output MergeRequest
getV3ProjectsIdMilestones
Get a list of project milestones
gitlab.getV3ProjectsIdMilestones({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - state
string
(values: active, closed, all): Return "active", "closed", or "all" milestones - iid
array
: The IID of the milestone - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Milestone
postV3ProjectsIdMilestones
Create a new project milestone
gitlab.postV3ProjectsIdMilestones({
"id": "",
"title": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - title required
string
: The title of the milestone - description
string
: The description of the milestone - due_date
string
: The due date of the milestone. The ISO 8601 date format (%Y-%m-%d) - start_date
string
: The start date of the milestone. The ISO 8601 date format (%Y-%m-%d)
- id required
Output
- output Milestone
getV3ProjectsIdMilestonesMilestoneId
Get a single project milestone
gitlab.getV3ProjectsIdMilestonesMilestoneId({
"id": "",
"milestone_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - milestone_id required
integer
: The ID of a project milestone
- id required
Output
- output Milestone
putV3ProjectsIdMilestonesMilestoneId
Update an existing project milestone
gitlab.putV3ProjectsIdMilestonesMilestoneId({
"id": "",
"milestone_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - milestone_id required
integer
: The ID of a project milestone - title
string
: The title of the milestone - state_event
string
(values: close, activate): The state event of the milestone - description
string
: The description of the milestone - due_date
string
: The due date of the milestone. The ISO 8601 date format (%Y-%m-%d) - start_date
string
: The start date of the milestone. The ISO 8601 date format (%Y-%m-%d)
- id required
Output
- output Milestone
getV3ProjectsIdMilestonesMilestoneIdIssues
Get all issues for a single project milestone
gitlab.getV3ProjectsIdMilestonesMilestoneIdIssues({
"id": "",
"milestone_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - milestone_id required
integer
: The ID of a project milestone - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Issue
getV3ProjectsIdNotificationSettings
This feature was introduced in GitLab 8.12
gitlab.getV3ProjectsIdNotificationSettings({
"id": ""
}, context)
Input
- input
object
- id required
string
: The group ID or project ID or project NAMESPACE/PROJECT_NAME
- id required
Output
- output NotificationSetting
putV3ProjectsIdNotificationSettings
This feature was introduced in GitLab 8.12
gitlab.putV3ProjectsIdNotificationSettings({
"id": ""
}, context)
Input
- input
object
- id required
string
: The group ID or project ID or project NAMESPACE/PROJECT_NAME - level
string
: The project 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
- id required
Output
- output NotificationSetting
postV3ProjectsIdPipeline
This feature was introduced in GitLab 8.14
gitlab.postV3ProjectsIdPipeline({
"id": "",
"ref": ""
}, context)
Input
- input
object
- id required
string
: The project ID - ref required
string
: Reference
- id required
Output
- output Pipeline
getV3ProjectsIdPipelines
This feature was introduced in GitLab 8.11.
gitlab.getV3ProjectsIdPipelines({
"id": ""
}, context)
Input
- input
object
- id required
string
: The project ID - page
integer
: Current page number - per_page
integer
: Number of items per page - scope
string
(values: running, branches, tags): Either running, branches, or tags
- id required
Output
- output Pipeline
getV3ProjectsIdPipelinesPipelineId
This feature was introduced in GitLab 8.11
gitlab.getV3ProjectsIdPipelinesPipelineId({
"id": "",
"pipeline_id": 0
}, context)
Input
- input
object
- id required
string
: The project ID - pipeline_id required
integer
: The pipeline ID
- id required
Output
- output Pipeline
postV3ProjectsIdPipelinesPipelineIdCancel
This feature was introduced in GitLab 8.11.
gitlab.postV3ProjectsIdPipelinesPipelineIdCancel({
"id": "",
"pipeline_id": 0
}, context)
Input
- input
object
- id required
string
: The project ID - pipeline_id required
integer
: The pipeline ID
- id required
Output
- output Pipeline
postV3ProjectsIdPipelinesPipelineIdRetry
This feature was introduced in GitLab 8.11.
gitlab.postV3ProjectsIdPipelinesPipelineIdRetry({
"id": "",
"pipeline_id": 0
}, context)
Input
- input
object
- id required
string
: The project ID - pipeline_id required
integer
: The pipeline ID
- id required
Output
- output Pipeline
getV3ProjectsIdRepositoryArchive
Get an archive of the repository
gitlab.getV3ProjectsIdRepositoryArchive({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - sha
string
: The commit sha of the archive to be downloaded - format
string
: The archive format
- id required
Output
Output schema unknown
getV3ProjectsIdRepositoryBlobsSha
Get a raw file contents
gitlab.getV3ProjectsIdRepositoryBlobsSha({
"id": "",
"sha": "",
"filepath": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - sha required
string
: The commit, branch name, or tag name - filepath required
string
: The path to the file to display
- id required
Output
Output schema unknown
getV3ProjectsIdRepositoryBranches
Get a project repository branches
gitlab.getV3ProjectsIdRepositoryBranches({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project
- id required
Output
- output RepoBranch
postV3ProjectsIdRepositoryBranches
Create branch
gitlab.postV3ProjectsIdRepositoryBranches({
"id": "",
"branch_name": "",
"ref": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - branch_name required
string
: The name of the branch - ref required
string
: Create branch from commit sha or existing branch
- id required
Output
- output RepoBranch
deleteV3ProjectsIdRepositoryBranchesBranch
Delete a branch
gitlab.deleteV3ProjectsIdRepositoryBranchesBranch({
"id": "",
"branch": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - branch required
string
: The name of the branch
- id required
Output
Output schema unknown
getV3ProjectsIdRepositoryBranchesBranch
Get a single branch
gitlab.getV3ProjectsIdRepositoryBranchesBranch({
"id": "",
"branch": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - branch required
string
: The name of the branch
- id required
Output
- output RepoBranch
putV3ProjectsIdRepositoryBranchesBranchProtect
Protect a single branch
gitlab.putV3ProjectsIdRepositoryBranchesBranchProtect({
"id": "",
"branch": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - branch required
string
: The name of the branch - developers_can_push
boolean
: Flag if developers can push to that branch - developers_can_merge
boolean
: Flag if developers can merge to that branch
- id required
Output
- output RepoBranch
putV3ProjectsIdRepositoryBranchesBranchUnprotect
Unprotect a single branch
gitlab.putV3ProjectsIdRepositoryBranchesBranchUnprotect({
"id": "",
"branch": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - branch required
string
: The name of the branch
- id required
Output
- output RepoBranch
getV3ProjectsIdRepositoryCommits
Get a project repository commits
gitlab.getV3ProjectsIdRepositoryCommits({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - ref_name
string
: The name of a repository branch or tag, if not given the default branch is used - since
string
: Only commits after or in this date will be returned - until
string
: Only commits before or in this date will be returned - page
integer
: The page for pagination - per_page
integer
: The number of results per page - path
string
: The file path
- id required
Output
- output RepoCommit
postV3ProjectsIdRepositoryCommits
This feature was introduced in GitLab 8.13
gitlab.postV3ProjectsIdRepositoryCommits({
"id": "",
"branch_name": "",
"commit_message": "",
"actions": []
}, context)
Input
- input
object
- id required
string
: The ID of a project - branch_name required
string
: The name of branch - commit_message required
string
: Commit message - actions required
array
: Actions to perform in commit - author_email
string
: Author email for commit - author_name
string
: Author name for commit
- id required
Output
- output RepoCommitDetail
getV3ProjectsIdRepositoryCommitsSha
Get a specific commit of a project
gitlab.getV3ProjectsIdRepositoryCommitsSha({
"id": "",
"sha": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - sha required
string
: A commit sha, or the name of a branch or tag
- id required
Output
- output RepoCommitDetail
getV3ProjectsIdRepositoryCommitsShaBlob
Get a raw file contents
gitlab.getV3ProjectsIdRepositoryCommitsShaBlob({
"id": "",
"sha": "",
"filepath": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - sha required
string
: The commit, branch name, or tag name - filepath required
string
: The path to the file to display
- id required
Output
Output schema unknown
getV3ProjectsIdRepositoryCommitsShaBuilds
Get builds for a specific commit of a project
gitlab.getV3ProjectsIdRepositoryCommitsShaBuilds({
"id": "",
"sha": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - sha required
string
: The SHA id of a commit - scope
string
(values: pending, running, failed, success, canceled): The scope of builds to show - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Build
postV3ProjectsIdRepositoryCommitsShaCherryPick
This feature was introduced in GitLab 8.15
gitlab.postV3ProjectsIdRepositoryCommitsShaCherryPick({
"id": "",
"sha": "",
"branch": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - sha required
string
: A commit sha to be cherry picked - branch required
string
: The name of the branch
- id required
Output
- output RepoCommit
getV3ProjectsIdRepositoryCommitsShaComments
Get a commit's comments
gitlab.getV3ProjectsIdRepositoryCommitsShaComments({
"id": "",
"sha": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - page
integer
: Current page number - per_page
integer
: Number of items per page - sha required
string
: A commit sha, or the name of a branch or tag
- id required
Output
- output CommitNote
postV3ProjectsIdRepositoryCommitsShaComments
Post comment to commit
gitlab.postV3ProjectsIdRepositoryCommitsShaComments({
"id": "",
"sha": "",
"note": "",
"line": 0,
"line_type": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - sha required
string
: The commit's SHA - note required
string
: The text of the comment - path
string
: The file path - line required
integer
: The line number - line_type required
string
(values: new, old): The type of the line
- id required
Output
- output CommitNote
getV3ProjectsIdRepositoryCommitsShaDiff
Get the diff for a specific commit of a project
gitlab.getV3ProjectsIdRepositoryCommitsShaDiff({
"id": "",
"sha": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - sha required
string
: A commit sha, or the name of a branch or tag
- id required
Output
Output schema unknown
getV3ProjectsIdRepositoryCommitsShaStatuses
Get a commit's statuses
gitlab.getV3ProjectsIdRepositoryCommitsShaStatuses({
"id": "",
"sha": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - sha required
string
: The commit hash - ref
string
: The ref - stage
string
: The stage - name
string
: The name - all
string
: Show all statuses, default: false - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output CommitStatus
getV3ProjectsIdRepositoryCompare
Compare two branches, tags, or commits
gitlab.getV3ProjectsIdRepositoryCompare({
"id": "",
"from": "",
"to": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - from required
string
: The commit, branch name, or tag name to start comparison - to required
string
: The commit, branch name, or tag name to stop comparison
- id required
Output
- output Compare
getV3ProjectsIdRepositoryContributors
Get repository contributors
gitlab.getV3ProjectsIdRepositoryContributors({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project
- id required
Output
- output Contributor
deleteV3ProjectsIdRepositoryFiles
Delete an existing file in repository
gitlab.deleteV3ProjectsIdRepositoryFiles({
"id": "",
"file_path": "",
"branch_name": "",
"commit_message": ""
}, context)
Input
- input
object
- id required
string
: The project ID - file_path required
string
: The path to new file. Ex. lib/class.rb - branch_name required
string
: The name of branch - commit_message required
string
: Commit Message - author_email
string
: The email of the author - author_name
string
: The name of the author
- id required
Output
Output schema unknown
getV3ProjectsIdRepositoryFiles
Get a file from repository
gitlab.getV3ProjectsIdRepositoryFiles({
"id": "",
"file_path": "",
"ref": ""
}, context)
Input
- input
object
- id required
string
: The project ID - file_path required
string
: The path to the file. Ex. lib/class.rb - ref required
string
: The name of branch, tag, or commit
- id required
Output
Output schema unknown
postV3ProjectsIdRepositoryFiles
Create new file in repository
gitlab.postV3ProjectsIdRepositoryFiles({
"id": "",
"file_path": "",
"branch_name": "",
"commit_message": "",
"content": ""
}, context)
Input
- input
object
- id required
string
: The project ID - file_path required
string
: The path to new file. Ex. lib/class.rb - branch_name required
string
: The name of branch - commit_message required
string
: Commit Message - author_email
string
: The email of the author - author_name
string
: The name of the author - content required
string
: File content - encoding
string
(values: base64): File encoding
- id required
Output
Output schema unknown
putV3ProjectsIdRepositoryFiles
Update existing file in repository
gitlab.putV3ProjectsIdRepositoryFiles({
"id": "",
"file_path": "",
"branch_name": "",
"commit_message": "",
"content": ""
}, context)
Input
- input
object
- id required
string
: The project ID - file_path required
string
: The path to new file. Ex. lib/class.rb - branch_name required
string
: The name of branch - commit_message required
string
: Commit Message - author_email
string
: The email of the author - author_name
string
: The name of the author - content required
string
: File content - encoding
string
(values: base64): File encoding
- id required
Output
Output schema unknown
deleteV3ProjectsIdRepositoryMergedBranches
gitlab.deleteV3ProjectsIdRepositoryMergedBranches({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project
- id required
Output
Output schema unknown
getV3ProjectsIdRepositoryRawBlobsSha
Get a raw blob contents by blob sha
gitlab.getV3ProjectsIdRepositoryRawBlobsSha({
"id": "",
"sha": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - sha required
string
: The commit, branch name, or tag name
- id required
Output
Output schema unknown
getV3ProjectsIdRepositoryTags
Get a project repository tags
gitlab.getV3ProjectsIdRepositoryTags({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project
- id required
Output
- output RepoTag
postV3ProjectsIdRepositoryTags
Create a new repository tag
gitlab.postV3ProjectsIdRepositoryTags({
"id": "",
"tag_name": "",
"ref": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - tag_name required
string
: The name of the tag - ref required
string
: The commit sha or branch name - message
string
: Specifying a message creates an annotated tag - release_description
string
: Specifying release notes stored in the GitLab database
- id required
Output
- output RepoTag
deleteV3ProjectsIdRepositoryTagsTagName
Delete a repository tag
gitlab.deleteV3ProjectsIdRepositoryTagsTagName({
"id": "",
"tag_name": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - tag_name required
string
: The name of the tag
- id required
Output
Output schema unknown
getV3ProjectsIdRepositoryTagsTagName
Get a single repository tag
gitlab.getV3ProjectsIdRepositoryTagsTagName({
"id": "",
"tag_name": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - tag_name required
string
: The name of the tag
- id required
Output
- output RepoTag
postV3ProjectsIdRepositoryTagsTagNameRelease
Add a release note to a tag
gitlab.postV3ProjectsIdRepositoryTagsTagNameRelease({
"id": "",
"tag_name": "",
"description": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - tag_name required
string
: The name of the tag - description required
string
: Release notes with markdown support
- id required
Output
- output Release
putV3ProjectsIdRepositoryTagsTagNameRelease
Update a tag's release note
gitlab.putV3ProjectsIdRepositoryTagsTagNameRelease({
"id": "",
"tag_name": "",
"description": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - tag_name required
string
: The name of the tag - description required
string
: Release notes with markdown support
- id required
Output
- output Release
getV3ProjectsIdRepositoryTree
Get a project repository tree
gitlab.getV3ProjectsIdRepositoryTree({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - ref_name
string
: The name of a repository branch or tag, if not given the default branch is used - path
string
: The path of the tree - recursive
boolean
: Used to get a recursive tree
- id required
Output
- output RepoTreeObject
getV3ProjectsIdRunners
Get runners available for project
gitlab.getV3ProjectsIdRunners({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - scope
string
(values: active, paused, online, specific, shared): The scope of specific runners to show - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Runner
postV3ProjectsIdRunners
Enable a runner for a project
gitlab.postV3ProjectsIdRunners({
"id": "",
"runner_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - runner_id required
integer
: The ID of the runner
- id required
Output
- output Runner
deleteV3ProjectsIdRunnersRunnerId
Disable project's runner
gitlab.deleteV3ProjectsIdRunnersRunnerId({
"id": "",
"runner_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - runner_id required
integer
: The ID of the runner
- id required
Output
- output Runner
putV3ProjectsIdServicesAsana
Set asana service for project
gitlab.putV3ProjectsIdServicesAsana({
"api_key": "",
"id": 0
}, context)
Input
- input
object
- api_key required
string
: User API token - restrict_to_branch
string
: Comma-separated list of branches which will be automatically inspected. Leave blank to include all branches - push_events
string
: Event will be triggered by a push to the repository - id required
integer
- api_key required
Output
Output schema unknown
putV3ProjectsIdServicesAssembla
Set assembla service for project
gitlab.putV3ProjectsIdServicesAssembla({
"token": "",
"id": 0
}, context)
Input
- input
object
- token required
string
: The authentication token - subdomain
string
: Subdomain setting - push_events
string
: Event will be triggered by a push to the repository - id required
integer
- token required
Output
Output schema unknown
putV3ProjectsIdServicesBamboo
Set bamboo service for project
gitlab.putV3ProjectsIdServicesBamboo({
"bamboo_url": "",
"build_key": "",
"username": "",
"password": "",
"id": 0
}, context)
Input
- input
object
- bamboo_url required
string
: Bamboo root URL like https://bamboo.example.com - build_key required
string
: Bamboo build plan key like - username required
string
: A user with API access, if applicable - password required
string
: Passord of the user - push_events
string
: Event will be triggered by a push to the repository - id required
integer
- bamboo_url required
Output
Output schema unknown
putV3ProjectsIdServicesBugzilla
Set bugzilla service for project
gitlab.putV3ProjectsIdServicesBugzilla({
"new_issue_url": "",
"issues_url": "",
"project_url": "",
"id": 0
}, context)
Input
- input
object
- new_issue_url required
string
: New issue URL - issues_url required
string
: Issues URL - project_url required
string
: Project URL - description
string
: Description - title
string
: Title - push_events
string
: Event will be triggered by a push to the repository - id required
integer
- new_issue_url required
Output
Output schema unknown
putV3ProjectsIdServicesBuildkite
Set buildkite service for project
gitlab.putV3ProjectsIdServicesBuildkite({
"token": "",
"project_url": "",
"id": 0
}, context)
Input
- input
object
- token required
string
: Buildkite project GitLab token - project_url required
string
: The buildkite project URL - enable_ssl_verification
boolean
: Enable SSL verification for communication - push_events
string
: Event will be triggered by a push to the repository - id required
integer
- token required
Output
Output schema unknown
putV3ProjectsIdServicesBuildsEmail
Set builds-email service for project
gitlab.putV3ProjectsIdServicesBuildsEmail({
"recipients": "",
"id": 0
}, context)
Input
- input
object
- recipients required
string
: Comma-separated list of recipient email addresses - add_pusher
boolean
: Add pusher to recipients list - notify_only_broken_builds
boolean
: Notify only broken builds - build_events
string
: Event will be triggered when a build status changes - id required
integer
- recipients required
Output
Output schema unknown
putV3ProjectsIdServicesCampfire
Set campfire service for project
gitlab.putV3ProjectsIdServicesCampfire({
"token": "",
"id": 0
}, context)
Input
- input
object
- token required
string
: Campfire token - subdomain
string
: Campfire subdomain - room
string
: Campfire room - push_events
string
: Event will be triggered by a push to the repository - id required
integer
- token required
Output
Output schema unknown
putV3ProjectsIdServicesCustomIssueTracker
Set custom-issue-tracker service for project
gitlab.putV3ProjectsIdServicesCustomIssueTracker({
"new_issue_url": "",
"issues_url": "",
"project_url": "",
"id": 0
}, context)
Input
- input
object
- new_issue_url required
string
: New issue URL - issues_url required
string
: Issues URL - project_url required
string
: Project URL - description
string
: Description - title
string
: Title - push_events
string
: Event will be triggered by a push to the repository - id required
integer
- new_issue_url required
Output
Output schema unknown
putV3ProjectsIdServicesDroneCi
Set drone-ci service for project
gitlab.putV3ProjectsIdServicesDroneCi({
"token": "",
"drone_url": "",
"id": 0
}, context)
Input
- input
object
- token required
string
: Drone CI token - drone_url required
string
: Drone CI URL - enable_ssl_verification
boolean
: Enable SSL verification for communication - push_events
string
: Event will be triggered by a push to the repository - merge_request_events
string
: Event will be triggered when a merge request is created/updated/merged - tag_push_events
string
: Event will be triggered when a new tag is pushed to the repository - id required
integer
- token required
Output
Output schema unknown
putV3ProjectsIdServicesEmailsOnPush
Set emails-on-push service for project
gitlab.putV3ProjectsIdServicesEmailsOnPush({
"recipients": "",
"id": 0
}, context)
Input
- input
object
- recipients required
string
: Comma-separated list of recipient email addresses - disable_diffs
boolean
: Disable code diffs - send_from_committer_email
boolean
: Send from committer - push_events
string
: Event will be triggered by a push to the repository - tag_push_events
string
: Event will be triggered when a new tag is pushed to the repository - id required
integer
- recipients required
Output
Output schema unknown
putV3ProjectsIdServicesExternalWiki
Set external-wiki service for project
gitlab.putV3ProjectsIdServicesExternalWiki({
"external_wiki_url": "",
"id": 0
}, context)
Input
- input
object
- external_wiki_url required
string
: The URL of the external Wiki - id required
integer
- external_wiki_url required
Output
Output schema unknown
putV3ProjectsIdServicesFlowdock
Set flowdock service for project
gitlab.putV3ProjectsIdServicesFlowdock({
"token": "",
"id": 0
}, context)
Input
- input
object
- token required
string
: Flowdock token - push_events
string
: Event will be triggered by a push to the repository - id required
integer
- token required
Output
Output schema unknown
putV3ProjectsIdServicesGemnasium
Set gemnasium service for project
gitlab.putV3ProjectsIdServicesGemnasium({
"api_key": "",
"token": "",
"id": 0
}, context)
Input
- input
object
- api_key required
string
: Your personal API key on gemnasium.com - token required
string
: The project's slug on gemnasium.com - push_events
string
: Event will be triggered by a push to the repository - id required
integer
- api_key required
Output
Output schema unknown
putV3ProjectsIdServicesHipchat
Set hipchat service for project
gitlab.putV3ProjectsIdServicesHipchat({
"token": "",
"id": 0
}, context)
Input
- input
object
- token required
string
: The room token - room
string
: The room name or ID - color
string
: The room color - notify
boolean
: Enable notifications - api_version
string
: Leave blank for default (v2) - server
string
: Leave blank for default. https://hipchat.example.com - push_events
string
: Event will be triggered by a push to the repository - issue_events
string
: Event will be triggered when an issue is created/updated/closed - confidential_issue_events
string
: Event will be triggered when a confidential issue is created/updated/closed - merge_request_events
string
: Event will be triggered when a merge request is created/updated/merged - note_events
string
: Event will be triggered when someone adds a comment - tag_push_events
string
: Event will be triggered when a new tag is pushed to the repository - build_events
string
: Event will be triggered when a build status changes - id required
integer
- token required
Output
Output schema unknown
putV3ProjectsIdServicesIrker
Set irker service for project
gitlab.putV3ProjectsIdServicesIrker({
"recipients": "",
"id": 0
}, context)
Input
- input
object
- recipients required
string
: Recipients/channels separated by whitespaces - default_irc_uri
string
: Default: irc://irc.network.net:6697 - server_host
string
: Server host. Default localhost - server_port
integer
: Server port. Default 6659 - colorize_messages
boolean
: Colorize messages - push_events
string
: Event will be triggered by a push to the repository - id required
integer
- recipients required
Output
Output schema unknown
putV3ProjectsIdServicesJira
Set jira service for project
gitlab.putV3ProjectsIdServicesJira({
"url": "",
"project_key": "",
"id": 0
}, context)
Input
- input
object
- url required
string
: The URL to the JIRA project which is being linked to this GitLab project, e.g., https://jira.example.com - project_key required
string
: The short identifier for your JIRA project, all uppercase, e.g., PROJ - username
string
: The username of the user created to be used with GitLab/JIRA - password
string
: The password of the user created to be used with GitLab/JIRA - jira_issue_transition_id
integer
: The ID of a transition that moves issues to a closed state. You can find this number under the JIRA workflow administration (Administration > Issues > Workflows) by selecting View under Operations of the desired workflow of your project. The ID of each state can be found inside the parenthesis of each transition name under the Transitions (id) column ([see screenshot][trans]). By default, this ID is set to2
- commit_events
string
: Event will be triggered when a commit is created/updated - merge_request_events
string
: Event will be triggered when a merge request is created/updated/merged - id required
integer
- url required
Output
Output schema unknown
putV3ProjectsIdServicesKubernetes
Set kubernetes service for project
gitlab.putV3ProjectsIdServicesKubernetes({
"namespace": "",
"api_url": "",
"token": "",
"id": 0
}, context)
Input
- input
object
- namespace required
string
: The Kubernetes namespace to use - api_url required
string
: The URL to the Kubernetes cluster API, e.g., https://kubernetes.example.com - token required
string
: The service token to authenticate against the Kubernetes cluster with - ca_pem
string
: A custom certificate authority bundle to verify the Kubernetes cluster with (PEM format) - id required
integer
- namespace required
Output
Output schema unknown
putV3ProjectsIdServicesMattermost
Set mattermost service for project
gitlab.putV3ProjectsIdServicesMattermost({
"webhook": "",
"id": 0
}, context)
Input
- input
object
- webhook required
string
: The Mattermost webhook. e.g. http://mattermost_host/hooks/... - push_events
string
: Event will be triggered by a push to the repository - issue_events
string
: Event will be triggered when an issue is created/updated/closed - confidential_issue_events
string
: Event will be triggered when a confidential issue is created/updated/closed - merge_request_events
string
: Event will be triggered when a merge request is created/updated/merged - note_events
string
: Event will be triggered when someone adds a comment - tag_push_events
string
: Event will be triggered when a new tag is pushed to the repository - build_events
string
: Event will be triggered when a build status changes - pipeline_events
string
- wiki_page_events
string
: Event will be triggered when a wiki page is created/updated - id required
integer
- webhook required
Output
Output schema unknown
putV3ProjectsIdServicesMattermostSlashCommands
Set mattermost-slash-commands service for project
gitlab.putV3ProjectsIdServicesMattermostSlashCommands({
"token": "",
"id": 0
}, context)
Input
- input
object
- token required
string
: The Mattermost token - id required
integer
- token required
Output
Output schema unknown
postV3ProjectsIdServicesMattermostSlashCommandsTrigger
Added in GitLab 8.13
gitlab.postV3ProjectsIdServicesMattermostSlashCommandsTrigger({
"id": "",
"token": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - token required
string
: The Mattermost token
- id required
Output
Output schema unknown
putV3ProjectsIdServicesPipelinesEmail
Set pipelines-email service for project
gitlab.putV3ProjectsIdServicesPipelinesEmail({
"recipients": "",
"id": 0
}, context)
Input
- input
object
- recipients required
string
: Comma-separated list of recipient email addresses - notify_only_broken_builds
boolean
: Notify only broken builds - pipeline_events
string
- id required
integer
- recipients required
Output
Output schema unknown
putV3ProjectsIdServicesPivotaltracker
Set pivotaltracker service for project
gitlab.putV3ProjectsIdServicesPivotaltracker({
"token": "",
"id": 0
}, context)
Input
- input
object
- token required
string
: The Pivotaltracker token - restrict_to_branch
string
: Comma-separated list of branches which will be automatically inspected. Leave blank to include all branches. - push_events
string
: Event will be triggered by a push to the repository - id required
integer
- token required
Output
Output schema unknown
putV3ProjectsIdServicesPushover
Set pushover service for project
gitlab.putV3ProjectsIdServicesPushover({
"api_key": "",
"user_key": "",
"priority": "",
"device": "",
"sound": "",
"id": 0
}, context)
Input
- input
object
- api_key required
string
: The application key - user_key required
string
: The user key - priority required
string
: The priority - device required
string
: Leave blank for all active devices - sound required
string
: The sound of the notification - push_events
string
: Event will be triggered by a push to the repository - id required
integer
- api_key required
Output
Output schema unknown
putV3ProjectsIdServicesRedmine
Set redmine service for project
gitlab.putV3ProjectsIdServicesRedmine({
"new_issue_url": "",
"project_url": "",
"issues_url": "",
"id": 0
}, context)
Input
- input
object
- new_issue_url required
string
: The new issue URL - project_url required
string
: The project URL - issues_url required
string
: The issues URL - description
string
: The description of the tracker - push_events
string
: Event will be triggered by a push to the repository - id required
integer
- new_issue_url required
Output
Output schema unknown
putV3ProjectsIdServicesSlack
Set slack service for project
gitlab.putV3ProjectsIdServicesSlack({
"webhook": "",
"id": 0
}, context)
Input
- input
object
- webhook required
string
: The Slack webhook. e.g. https://hooks.slack.com/services/... - new_issue_url
string
: The user name - channel
string
: The channel name - push_events
string
: Event will be triggered by a push to the repository - issue_events
string
: Event will be triggered when an issue is created/updated/closed - confidential_issue_events
string
: Event will be triggered when a confidential issue is created/updated/closed - merge_request_events
string
: Event will be triggered when a merge request is created/updated/merged - note_events
string
: Event will be triggered when someone adds a comment - tag_push_events
string
: Event will be triggered when a new tag is pushed to the repository - build_events
string
: Event will be triggered when a build status changes - pipeline_events
string
- wiki_page_events
string
: Event will be triggered when a wiki page is created/updated - id required
integer
- webhook required
Output
Output schema unknown
putV3ProjectsIdServicesSlackSlashCommands
Set slack-slash-commands service for project
gitlab.putV3ProjectsIdServicesSlackSlashCommands({
"token": "",
"id": 0
}, context)
Input
- input
object
- token required
string
: The Slack token - id required
integer
- token required
Output
Output schema unknown
postV3ProjectsIdServicesSlackSlashCommandsTrigger
Added in GitLab 8.13
gitlab.postV3ProjectsIdServicesSlackSlashCommandsTrigger({
"id": "",
"token": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - token required
string
: The Slack token
- id required
Output
Output schema unknown
putV3ProjectsIdServicesTeamcity
Set teamcity service for project
gitlab.putV3ProjectsIdServicesTeamcity({
"teamcity_url": "",
"build_type": "",
"username": "",
"password": "",
"id": 0
}, context)
Input
- input
object
- teamcity_url required
string
: TeamCity root URL like https://teamcity.example.com - build_type required
string
: Build configuration ID - username required
string
: A user with permissions to trigger a manual build - password required
string
: The password of the user - push_events
string
: Event will be triggered by a push to the repository - id required
integer
- teamcity_url required
Output
Output schema unknown
deleteV3ProjectsIdServicesServiceSlug
Delete a service for project
gitlab.deleteV3ProjectsIdServicesServiceSlug({
"service_slug": "",
"id": 0
}, context)
Input
- input
object
- service_slug required
string
(values: asana, assembla, bamboo, bugzilla, buildkite, builds-email, campfire, custom-issue-tracker, drone-ci, emails-on-push, external-wiki, flowdock, gemnasium, hipchat, irker, jira, kubernetes, mattermost-slash-commands, slack-slash-commands, pipelines-email, pivotaltracker, pushover, redmine, slack, mattermost, teamcity): The name of the service - id required
integer
- service_slug required
Output
Output schema unknown
getV3ProjectsIdServicesServiceSlug
Get the service settings for project
gitlab.getV3ProjectsIdServicesServiceSlug({
"service_slug": "",
"id": 0
}, context)
Input
- input
object
- service_slug required
string
(values: asana, assembla, bamboo, bugzilla, buildkite, builds-email, campfire, custom-issue-tracker, drone-ci, emails-on-push, external-wiki, flowdock, gemnasium, hipchat, irker, jira, kubernetes, mattermost-slash-commands, slack-slash-commands, pipelines-email, pivotaltracker, pushover, redmine, slack, mattermost, teamcity): The name of the service - id required
integer
- service_slug required
Output
- output ProjectService
postV3ProjectsIdShare
Share the project with a group
gitlab.postV3ProjectsIdShare({
"id": "",
"group_id": 0,
"group_access": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - group_id required
integer
: The ID of a group - group_access required
integer
(values: 10, 20, 30, 40): The group access level - expires_at
string
: Share expiration date
- id required
Output
- output ProjectGroupLink
deleteV3ProjectsIdShareGroupId
gitlab.deleteV3ProjectsIdShareGroupId({
"id": "",
"group_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - group_id required
integer
: The ID of the group
- id required
Output
Output schema unknown
getV3ProjectsIdSnippets
Get all project snippets
gitlab.getV3ProjectsIdSnippets({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output ProjectSnippet
postV3ProjectsIdSnippets
Create a new project snippet
gitlab.postV3ProjectsIdSnippets({
"id": "",
"title": "",
"file_name": "",
"code": "",
"visibility_level": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - title required
string
: The title of the snippet - file_name required
string
: The file name of the snippet - code required
string
: The content of the snippet - visibility_level required
integer
(values: 0, 10, 20): The visibility level of the snippet
- id required
Output
- output ProjectSnippet
getV3ProjectsIdSnippetsNoteableIdNotes
Get a list of project +noteable+ notes
gitlab.getV3ProjectsIdSnippetsNoteableIdNotes({
"id": "",
"noteable_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - noteable_id required
integer
: The ID of the noteable - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Note
postV3ProjectsIdSnippetsNoteableIdNotes
Create a new +noteable+ note
gitlab.postV3ProjectsIdSnippetsNoteableIdNotes({
"id": "",
"noteable_id": 0,
"body": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - noteable_id required
integer
: The ID of the noteable - body required
string
: The content of a note - created_at
string
: The creation date of the note
- id required
Output
- output Note
deleteV3ProjectsIdSnippetsNoteableIdNotesNoteId
Delete a +noteable+ note
gitlab.deleteV3ProjectsIdSnippetsNoteableIdNotesNoteId({
"id": "",
"noteable_id": 0,
"note_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - noteable_id required
integer
: The ID of the noteable - note_id required
integer
: The ID of a note
- id required
Output
- output Note
getV3ProjectsIdSnippetsNoteableIdNotesNoteId
Get a single +noteable+ note
gitlab.getV3ProjectsIdSnippetsNoteableIdNotesNoteId({
"id": "",
"note_id": 0,
"noteable_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - note_id required
integer
: The ID of a note - noteable_id required
integer
: The ID of the noteable
- id required
Output
- output Note
putV3ProjectsIdSnippetsNoteableIdNotesNoteId
Update an existing +noteable+ note
gitlab.putV3ProjectsIdSnippetsNoteableIdNotesNoteId({
"id": "",
"noteable_id": 0,
"note_id": 0,
"body": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - noteable_id required
integer
: The ID of the noteable - note_id required
integer
: The ID of a note - body required
string
: The content of a note
- id required
Output
- output Note
deleteV3ProjectsIdSnippetsSnippetId
Delete a project snippet
gitlab.deleteV3ProjectsIdSnippetsSnippetId({
"id": "",
"snippet_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - snippet_id required
integer
: The ID of a project snippet
- id required
Output
Output schema unknown
getV3ProjectsIdSnippetsSnippetId
Get a single project snippet
gitlab.getV3ProjectsIdSnippetsSnippetId({
"id": "",
"snippet_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - snippet_id required
integer
: The ID of a project snippet
- id required
Output
- output ProjectSnippet
putV3ProjectsIdSnippetsSnippetId
Update an existing project snippet
gitlab.putV3ProjectsIdSnippetsSnippetId({
"id": "",
"snippet_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - snippet_id required
integer
: The ID of a project snippet - title
string
: The title of the snippet - file_name
string
: The file name of the snippet - code
string
: The content of the snippet - visibility_level
integer
(values: 0, 10, 20): The visibility level of the snippet
- id required
Output
- output ProjectSnippet
getV3ProjectsIdSnippetsSnippetIdAwardEmoji
This feature was introduced in 8.9
gitlab.getV3ProjectsIdSnippetsSnippetIdAwardEmoji({
"id": "",
"snippet_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - snippet_id required
integer
: The ID of an Issue, Merge Request or Snippet - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output AwardEmoji
postV3ProjectsIdSnippetsSnippetIdAwardEmoji
This feature was introduced in 8.9
gitlab.postV3ProjectsIdSnippetsSnippetIdAwardEmoji({
"name": "",
"id": 0,
"snippet_id": 0
}, context)
Input
- input
object
- name required
string
: The name of a award_emoji (without colons) - id required
integer
- snippet_id required
integer
- name required
Output
- output AwardEmoji
deleteV3ProjectsIdSnippetsSnippetIdAwardEmojiAwardId
This feature was introduced in 8.9
gitlab.deleteV3ProjectsIdSnippetsSnippetIdAwardEmojiAwardId({
"award_id": 0,
"id": 0,
"snippet_id": 0
}, context)
Input
- input
object
- award_id required
integer
: The ID of an award emoji - id required
integer
- snippet_id required
integer
- award_id required
Output
- output AwardEmoji
getV3ProjectsIdSnippetsSnippetIdAwardEmojiAwardId
This feature was introduced in 8.9
gitlab.getV3ProjectsIdSnippetsSnippetIdAwardEmojiAwardId({
"award_id": 0,
"id": 0,
"snippet_id": 0
}, context)
Input
- input
object
- award_id required
integer
: The ID of the award - id required
integer
- snippet_id required
integer
- award_id required
Output
- output AwardEmoji
getV3ProjectsIdSnippetsSnippetIdNotesNoteIdAwardEmoji
This feature was introduced in 8.9
gitlab.getV3ProjectsIdSnippetsSnippetIdNotesNoteIdAwardEmoji({
"id": 0,
"snippet_id": 0,
"note_id": 0
}, context)
Input
- input
object
- page
integer
: Current page number - per_page
integer
: Number of items per page - id required
integer
- snippet_id required
integer
- note_id required
integer
- page
Output
- output AwardEmoji
postV3ProjectsIdSnippetsSnippetIdNotesNoteIdAwardEmoji
This feature was introduced in 8.9
gitlab.postV3ProjectsIdSnippetsSnippetIdNotesNoteIdAwardEmoji({
"name": "",
"id": 0,
"snippet_id": 0,
"note_id": 0
}, context)
Input
- input
object
- name required
string
: The name of a award_emoji (without colons) - id required
integer
- snippet_id required
integer
- note_id required
integer
- name required
Output
- output AwardEmoji
deleteV3ProjectsIdSnippetsSnippetIdNotesNoteIdAwardEmojiAwardId
This feature was introduced in 8.9
gitlab.deleteV3ProjectsIdSnippetsSnippetIdNotesNoteIdAwardEmojiAwardId({
"award_id": 0,
"id": 0,
"snippet_id": 0,
"note_id": 0
}, context)
Input
- input
object
- award_id required
integer
: The ID of an award emoji - id required
integer
- snippet_id required
integer
- note_id required
integer
- award_id required
Output
- output AwardEmoji
getV3ProjectsIdSnippetsSnippetIdNotesNoteIdAwardEmojiAwardId
This feature was introduced in 8.9
gitlab.getV3ProjectsIdSnippetsSnippetIdNotesNoteIdAwardEmojiAwardId({
"award_id": 0,
"id": 0,
"snippet_id": 0,
"note_id": 0
}, context)
Input
- input
object
- award_id required
integer
: The ID of the award - id required
integer
- snippet_id required
integer
- note_id required
integer
- award_id required
Output
- output AwardEmoji
getV3ProjectsIdSnippetsSnippetIdRaw
Get a raw project snippet
gitlab.getV3ProjectsIdSnippetsSnippetIdRaw({
"id": "",
"snippet_id": 0
}, context)
Input
- input
object
- id required
string
: The ID of a project - snippet_id required
integer
: The ID of a project snippet
- id required
Output
Output schema unknown
deleteV3ProjectsIdStar
Unstar a project
gitlab.deleteV3ProjectsIdStar({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project
- id required
Output
- output Project
postV3ProjectsIdStar
Star a project
gitlab.postV3ProjectsIdStar({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project
- id required
Output
- output Project
postV3ProjectsIdStatusesSha
Post status to a commit
gitlab.postV3ProjectsIdStatusesSha({
"id": "",
"sha": "",
"state": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - sha required
string
: The commit hash - state required
string
(values: pending, running, success, failed, canceled): The state of the status - ref
string
: The ref - target_url
string
: The target URL to associate with this status - description
string
: A short description of the status - name
string
: A string label to differentiate this status from the status of other systems. Default: "default" - context
string
: A string label to differentiate this status from the status of other systems. Default: "default"
- id required
Output
- output CommitStatus
getV3ProjectsIdTriggers
Get triggers list
gitlab.getV3ProjectsIdTriggers({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Trigger
postV3ProjectsIdTriggers
Create a trigger
gitlab.postV3ProjectsIdTriggers({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project
- id required
Output
- output Trigger
deleteV3ProjectsIdTriggersToken
Delete a trigger
gitlab.deleteV3ProjectsIdTriggersToken({
"id": "",
"token": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - token required
string
: The unique token of trigger
- id required
Output
- output Trigger
getV3ProjectsIdTriggersToken
Get specific trigger of a project
gitlab.getV3ProjectsIdTriggersToken({
"id": "",
"token": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - token required
string
: The unique token of trigger
- id required
Output
- output Trigger
postV3ProjectsIdUnarchive
Unarchive a project
gitlab.postV3ProjectsIdUnarchive({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project
- id required
Output
- output Project
postV3ProjectsIdUploads
Upload a file
gitlab.postV3ProjectsIdUploads({
"id": "",
"file": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - file required
string
,object
: The file to be uploaded- content
string
- encoding
string
(values: ascii, utf8, utf16le, base64, binary, hex) - contentType
string
- filename
string
- content
- id required
Output
Output schema unknown
getV3ProjectsIdUsers
Get the users list of a project
gitlab.getV3ProjectsIdUsers({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - search
string
: Return list of users matching the search criteria - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output UserBasic
getV3ProjectsIdVariables
Get project variables
gitlab.getV3ProjectsIdVariables({
"id": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Variable
postV3ProjectsIdVariables
Create a new variable in a project
gitlab.postV3ProjectsIdVariables({
"id": "",
"key": "",
"value": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - key required
string
: The key of the variable - value required
string
: The value of the variable
- id required
Output
- output Variable
deleteV3ProjectsIdVariablesKey
Delete an existing variable from a project
gitlab.deleteV3ProjectsIdVariablesKey({
"id": "",
"key": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - key required
string
: The key of the variable
- id required
Output
- output Variable
getV3ProjectsIdVariablesKey
Get a specific variable from a project
gitlab.getV3ProjectsIdVariablesKey({
"id": "",
"key": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - key required
string
: The key of the variable
- id required
Output
- output Variable
putV3ProjectsIdVariablesKey
Update an existing variable from a project
gitlab.putV3ProjectsIdVariablesKey({
"id": "",
"key": ""
}, context)
Input
- input
object
- id required
string
: The ID of a project - key required
string
: The key of the variable - value
string
: The value of the variable
- id required
Output
- output Variable
getV3Runners
Get runners available for user
gitlab.getV3Runners({}, context)
Input
- input
object
- scope
string
(values: active, paused, online): The scope of specific runners to show - page
integer
: Current page number - per_page
integer
: Number of items per page
- scope
Output
- output Runner
getV3RunnersAll
Get all runners - shared and specific
gitlab.getV3RunnersAll({}, context)
Input
- input
object
- scope
string
(values: active, paused, online, specific, shared): The scope of specific runners to show - page
integer
: Current page number - per_page
integer
: Number of items per page
- scope
Output
- output Runner
deleteV3RunnersId
Remove a runner
gitlab.deleteV3RunnersId({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the runner
- id required
Output
- output Runner
getV3RunnersId
Get runner's details
gitlab.getV3RunnersId({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the runner
- id required
Output
- output RunnerDetails
putV3RunnersId
Update runner's details
gitlab.putV3RunnersId({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the runner - description
string
: The description of the runner - active
boolean
: The state of a runner - tag_list
array
: The list of tags for a runner - run_untagged
boolean
: Flag indicating the runner can execute untagged jobs - locked
boolean
: Flag indicating the runner is locked
- id required
Output
- output RunnerDetails
postV3Session
Login to get token
gitlab.postV3Session({
"password": ""
}, context)
Input
- input
object
- login
string
: The username - email
string
: The email of the user - password required
string
: The password of the user
- login
Output
- output UserWithPrivateToken
getV3SidekiqCompoundMetrics
Get the Sidekiq Compound metrics. Includes queue, process, and job statistics
gitlab.getV3SidekiqCompoundMetrics(null, context)
Input
This action has no parameters
Output
Output schema unknown
getV3SidekiqJobStats
Get the Sidekiq job statistics
gitlab.getV3SidekiqJobStats(null, context)
Input
This action has no parameters
Output
Output schema unknown
getV3SidekiqProcessMetrics
Get the Sidekiq process metrics
gitlab.getV3SidekiqProcessMetrics(null, context)
Input
This action has no parameters
Output
Output schema unknown
getV3SidekiqQueueMetrics
Get the Sidekiq queue metrics
gitlab.getV3SidekiqQueueMetrics(null, context)
Input
This action has no parameters
Output
Output schema unknown
getV3Snippets
This feature was introduced in GitLab 8.15.
gitlab.getV3Snippets({}, context)
Input
- input
object
- page
integer
: Current page number - per_page
integer
: Number of items per page
- page
Output
- output PersonalSnippet
postV3Snippets
This feature was introduced in GitLab 8.15.
gitlab.postV3Snippets({
"title": "",
"file_name": "",
"content": ""
}, context)
Input
- input
object
- title required
string
: The title of a snippet - file_name required
string
: The name of a snippet file - content required
string
: The content of a snippet - visibility_level
integer
(values: 0, 10, 20): The visibility level of the snippet
- title required
Output
- output PersonalSnippet
getV3SnippetsPublic
This feature was introduced in GitLab 8.15.
gitlab.getV3SnippetsPublic({}, context)
Input
- input
object
- page
integer
: Current page number - per_page
integer
: Number of items per page
- page
Output
- output PersonalSnippet
deleteV3SnippetsId
This feature was introduced in GitLab 8.15.
gitlab.deleteV3SnippetsId({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of a snippet
- id required
Output
- output PersonalSnippet
getV3SnippetsId
This feature was introduced in GitLab 8.15.
gitlab.getV3SnippetsId({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of a snippet
- id required
Output
- output PersonalSnippet
putV3SnippetsId
This feature was introduced in GitLab 8.15.
gitlab.putV3SnippetsId({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of a snippet - title
string
: The title of a snippet - file_name
string
: The name of a snippet file - content
string
: The content of a snippet - visibility_level
integer
(values: 0, 10, 20): The visibility level of the snippet
- id required
Output
- output PersonalSnippet
getV3SnippetsIdRaw
This feature was introduced in GitLab 8.15.
gitlab.getV3SnippetsIdRaw({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of a snippet
- id required
Output
Output schema unknown
getV3TemplatesDockerfiles
This feature was introduced in GitLab 8.15.
gitlab.getV3TemplatesDockerfiles(null, context)
Input
This action has no parameters
Output
- output TemplatesList
getV3TemplatesDockerfilesName
This feature was introduced in GitLab 8.15.
gitlab.getV3TemplatesDockerfilesName({
"name": ""
}, context)
Input
- input
object
- name required
string
: The name of the template
- name required
Output
- output Template
getV3TemplatesGitignores
This feature was introduced in GitLab 8.8.
gitlab.getV3TemplatesGitignores(null, context)
Input
This action has no parameters
Output
- output TemplatesList
getV3TemplatesGitignoresName
This feature was introduced in GitLab 8.8.
gitlab.getV3TemplatesGitignoresName({
"name": ""
}, context)
Input
- input
object
- name required
string
: The name of the template
- name required
Output
- output Template
getV3TemplatesGitlabCiYmls
This feature was introduced in GitLab 8.9.
gitlab.getV3TemplatesGitlabCiYmls(null, context)
Input
This action has no parameters
Output
- output TemplatesList
getV3TemplatesGitlabCiYmlsName
This feature was introduced in GitLab 8.9.
gitlab.getV3TemplatesGitlabCiYmlsName({
"name": ""
}, context)
Input
- input
object
- name required
string
: The name of the template
- name required
Output
- output Template
getV3TemplatesLicenses
This feature was introduced in GitLab 8.7.
gitlab.getV3TemplatesLicenses({}, context)
Input
- input
object
- popular
boolean
: If passed, returns only popular licenses
- popular
Output
- output RepoLicense
getV3TemplatesLicensesName
This feature was introduced in GitLab 8.7.
gitlab.getV3TemplatesLicensesName({
"name": ""
}, context)
Input
- input
object
- name required
string
: The name of the template
- name required
Output
- output RepoLicense
deleteV3Todos
Mark all todos as done
gitlab.deleteV3Todos(null, context)
Input
This action has no parameters
Output
Output schema unknown
getV3Todos
Get a todo list
gitlab.getV3Todos({}, context)
Input
- input
object
- page
integer
: Current page number - per_page
integer
: Number of items per page
- page
Output
- output Todo
deleteV3TodosId
Mark a todo as done
gitlab.deleteV3TodosId({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the todo being marked as done
- id required
Output
- output Todo
getV3User
Get the currently authenticated user
gitlab.getV3User(null, context)
Input
This action has no parameters
Output
- output UserPublic
getV3UserEmails
Get the currently authenticated user's email addresses
gitlab.getV3UserEmails(null, context)
Input
This action has no parameters
Output
- output Email
postV3UserEmails
Add new email address to the currently authenticated user
gitlab.postV3UserEmails({
"email": ""
}, context)
Input
- input
object
- email required
string
: The new email
- email required
Output
- output Email
deleteV3UserEmailsEmailId
Delete an email address from the currently authenticated user
gitlab.deleteV3UserEmailsEmailId({
"email_id": 0
}, context)
Input
- input
object
- email_id required
integer
: The ID of the email
- email_id required
Output
Output schema unknown
getV3UserEmailsEmailId
Get a single email address owned by the currently authenticated user
gitlab.getV3UserEmailsEmailId({
"email_id": 0
}, context)
Input
- input
object
- email_id required
integer
: The ID of the email
- email_id required
Output
- output Email
getV3UserKeys
Get the currently authenticated user's SSH keys
gitlab.getV3UserKeys(null, context)
Input
This action has no parameters
Output
- output SSHKey
postV3UserKeys
Add a new SSH key to the currently authenticated user
gitlab.postV3UserKeys({
"key": "",
"title": ""
}, context)
Input
- input
object
- key required
string
: The new SSH key - title required
string
: The title of the new SSH key
- key required
Output
- output SSHKey
deleteV3UserKeysKeyId
Delete an SSH key from the currently authenticated user
gitlab.deleteV3UserKeysKeyId({
"key_id": 0
}, context)
Input
- input
object
- key_id required
integer
: The ID of the SSH key
- key_id required
Output
- output SSHKey
getV3UserKeysKeyId
Get a single key owned by currently authenticated user
gitlab.getV3UserKeysKeyId({
"key_id": 0
}, context)
Input
- input
object
- key_id required
integer
: The ID of the SSH key
- key_id required
Output
- output SSHKey
getV3Users
Get the list of users
gitlab.getV3Users({}, context)
Input
- input
object
- username
string
: Get a single user with a specific username - search
string
: Search for a username - active
boolean
: Filters only active users - external
boolean
: Filters only external users - blocked
boolean
: Filters only blocked users - page
integer
: Current page number - per_page
integer
: Number of items per page
- username
Output
- output UserBasic
postV3Users
Create a user. Available only for admins.
gitlab.postV3Users({
"email": "",
"password": "",
"name": "",
"username": ""
}, context)
Input
- input
object
- email required
string
: The email of the user - password required
string
: The password of the new user - name required
string
: The name of the user - username required
string
: The username of the user - skype
string
: The Skype username - linkedin
string
: The LinkedIn username - twitter
string
: The Twitter username - website_url
string
: The website of the user - organization
string
: The organization of the user - projects_limit
integer
: The number of projects a user can create - extern_uid
string
: The external authentication provider UID - provider
string
: The external provider - bio
string
: The biography of the user - location
string
: The location of the user - admin
boolean
: Flag indicating the user is an administrator - can_create_group
boolean
: Flag indicating the user can create groups - confirm
boolean
: Flag indicating the account needs to be confirmed - external
boolean
: Flag indicating the user is an external user
- email required
Output
- output UserPublic
deleteV3UsersId
Delete a user. Available only for admins.
gitlab.deleteV3UsersId({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the user
- id required
Output
- output Email
getV3UsersId
Get a single user
gitlab.getV3UsersId({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the user
- id required
Output
- output UserBasic
putV3UsersId
Update a user. Available only for admins.
gitlab.putV3UsersId({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the user - email
string
: The email of the user - password
string
: The password of the new user - name
string
: The name of the user - username
string
: The username of the user - skype
string
: The Skype username - linkedin
string
: The LinkedIn username - twitter
string
: The Twitter username - website_url
string
: The website of the user - organization
string
: The organization of the user - projects_limit
integer
: The number of projects a user can create - extern_uid
string
: The external authentication provider UID - provider
string
: The external provider - bio
string
: The biography of the user - location
string
: The location of the user - admin
boolean
: Flag indicating the user is an administrator - can_create_group
boolean
: Flag indicating the user can create groups - confirm
boolean
: Flag indicating the account needs to be confirmed - external
boolean
: Flag indicating the user is an external user
- id required
Output
- output UserPublic
putV3UsersIdBlock
Block a user. Available only for admins.
gitlab.putV3UsersIdBlock({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the user
- id required
Output
Output schema unknown
getV3UsersIdEmails
Get the emails addresses of a specified user. Available only for admins.
gitlab.getV3UsersIdEmails({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the user
- id required
Output
- output Email
postV3UsersIdEmails
Add an email address to a specified user. Available only for admins.
gitlab.postV3UsersIdEmails({
"id": 0,
"email": ""
}, context)
Input
- input
object
- id required
integer
: The ID of the user - email required
string
: The email of the user
- id required
Output
- output Email
deleteV3UsersIdEmailsEmailId
Delete an email address of a specified user. Available only for admins.
gitlab.deleteV3UsersIdEmailsEmailId({
"id": 0,
"email_id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the user - email_id required
integer
: The ID of the email
- id required
Output
- output Email
getV3UsersIdEvents
This feature was introduced in GitLab 8.13.
gitlab.getV3UsersIdEvents({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the user - page
integer
: Current page number - per_page
integer
: Number of items per page
- id required
Output
- output Event
getV3UsersIdKeys
Get the SSH keys of a specified user. Available only for admins.
gitlab.getV3UsersIdKeys({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the user
- id required
Output
- output SSHKey
postV3UsersIdKeys
Add an SSH key to a specified user. Available only for admins.
gitlab.postV3UsersIdKeys({
"id": 0,
"key": "",
"title": ""
}, context)
Input
- input
object
- id required
integer
: The ID of the user - key required
string
: The new SSH key - title required
string
: The title of the new SSH key
- id required
Output
- output SSHKey
deleteV3UsersIdKeysKeyId
Delete an existing SSH key from a specified user. Available only for admins.
gitlab.deleteV3UsersIdKeysKeyId({
"id": 0,
"key_id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the user - key_id required
integer
: The ID of the SSH key
- id required
Output
- output SSHKey
putV3UsersIdUnblock
Unblock a user. Available only for admins.
gitlab.putV3UsersIdUnblock({
"id": 0
}, context)
Input
- input
object
- id required
integer
: The ID of the user
- id required
Output
Output schema unknown
getV3Version
This feature was introduced in GitLab 8.13.
gitlab.getV3Version(null, context)
Input
This action has no parameters
Output
Output schema unknown
Definitions
AccessRequester
- AccessRequester
object
: This feature was introduced in GitLab 8.11.- avatar_url
string
- id
string
- name
string
- requested_at
string
- state
string
- username
string
- web_url
string
- avatar_url
ApplicationSetting
- ApplicationSetting
object
: Modify application settings- after_sign_out_path
string
- after_sign_up_text
string
- container_registry_token_expire_delay
string
- created_at
string
- default_branch_protection
string
- default_group_visibility
string
- default_project_visibility
string
- default_projects_limit
string
- default_snippet_visibility
string
- domain_blacklist
string
- domain_blacklist_enabled
string
- domain_whitelist
string
- gravatar_enabled
string
- home_page_url
string
- id
string
- koding_enabled
string
- koding_url
string
- max_attachment_size
string
- plantuml_enabled
string
- plantuml_url
string
- repository_storage
string
- repository_storages
string
- restricted_visibility_levels
string
- session_expire_delay
string
- sign_in_text
string
- signin_enabled
string
- signup_enabled
string
- updated_at
string
- user_oauth_applications
string
- after_sign_out_path
AwardEmoji
- AwardEmoji
object
: This feature was introduced in 8.9- awardable_id
string
- awardable_type
string
- created_at
string
- id
string
- name
string
- updated_at
string
- user UserBasic
- awardable_id
BasicProjectDetails
- BasicProjectDetails
object
: Get all projects for admin user- http_url_to_repo
string
- id
string
- name
string
- name_with_namespace
string
- path
string
- path_with_namespace
string
- web_url
string
- http_url_to_repo
Board
- Board
object
: This feature was introduced in 8.13- id
string
- lists List
- id
Build
- Build
object
: This feature was added in GitLab 8.11- artifacts_file BuildArtifactFile
- commit RepoCommit
- coverage
string
- created_at
string
- finished_at
string
- id
string
- name
string
- pipeline PipelineBasic
- ref
string
- runner Runner
- stage
string
- started_at
string
- status
string
- tag
string
- user User
BuildArtifactFile
- BuildArtifactFile
object
- filename
string
- size
string
- filename
CommitNote
- CommitNote
object
: Post comment to commit- author UserBasic
- created_at
string
- line
string
- line_type
string
- note
string
- path
string
CommitStatus
- CommitStatus
object
: Post status to a commit- allow_failure
string
- author UserBasic
- created_at
string
- description
string
- finished_at
string
- id
string
- name
string
- ref
string
- sha
string
- started_at
string
- status
string
- target_url
string
- allow_failure
Compare
- Compare
object
: Compare two branches, tags, or commits- commit RepoCommit
- commits RepoCommit
- compare_same_ref
string
- compare_timeout
string
- diffs RepoDiff
Contributor
- Contributor
object
: Get repository contributors- additions
string
- commits
string
- deletions
string
- email
string
- name
string
- additions
Deployment
- Deployment
object
: This feature was introduced in GitLab 8.11.- created_at
string
- deployable Build
- environment EnvironmentBasic
- id
string
- iid
string
- ref
string
- sha
string
- user UserBasic
- created_at
- Email
object
: Add new email address to the currently authenticated user- email
string
- id
string
- email
Environment
- Environment
object
: This feature was introduced in GitLab 8.11.- external_url
string
- id
string
- name
string
- project Project
- slug
string
- external_url
EnvironmentBasic
- EnvironmentBasic
object
- external_url
string
- id
string
- name
string
- slug
string
- external_url
Event
- Event
object
: This feature was introduced in GitLab 8.13.
GlobalNotificationSetting
- GlobalNotificationSetting
object
: This feature was introduced in GitLab 8.12- events
string
- level
string
- notification_email
string
- events
Group
- Group
object
: Update a group. Available only for users who can administrate groups.- avatar_url
string
- description
string
- id
string
- lfs_enabled
string
- name
string
- path
string
- request_access_enabled
string
- statistics
string
- visibility_level
string
- web_url
string
- avatar_url
GroupDetail
- GroupDetail
object
: Transfer a project to the group namespace. Available only for admin.
Hook
- Hook
object
: Delete a hook- created_at
string
- enable_ssl_verification
string
- id
string
- push_events
string
- tag_push_events
string
- url
string
- created_at
Identity
- Identity
object
- extern_uid
string
- provider
string
- extern_uid
Issue
- Issue
object
: Get currently authenticated user's issues- assignee UserBasic
- author UserBasic
- confidential
string
- created_at
string
- description
string
- downvotes
string
- due_date
string
- id
string
- iid
string
- labels
string
- milestone Milestone
- project_id
string
- state
string
- subscribed
string
- title
string
- updated_at
string
- upvotes
string
- user_notes_count
string
- web_url
string
Label
- Label
object
: Unsubscribe from a resource- closed_issues_count
string
- color
string
- description
string
- id
string
- name
string
- open_issues_count
string
- open_merge_requests_count
string
- priority
string
- subscribed
string
- closed_issues_count
LabelBasic
- LabelBasic
object
- color
string
- description
string
- id
string
- name
string
- color
List
- List
object
: This feature was introduced in 8.13- id
string
- label LabelBasic
- position
string
- id
MRNote
- MRNote
object
: List issues that will be closed on merge- author UserBasic
- note
string
Member
- Member
object
: Updates a member of a group or project.- access_level
string
- avatar_url
string
- expires_at
string
- id
string
- name
string
- state
string
- username
string
- web_url
string
- access_level
MergeRequest
- MergeRequest
object
: Unsubscribe from a resource- assignee UserBasic
- author UserBasic
- created_at
string
- description
string
- downvotes
string
- force_remove_source_branch
string
- id
string
- iid
string
- labels
string
- merge_commit_sha
string
- merge_status
string
- merge_when_build_succeeds
string
- milestone Milestone
- project_id
string
- sha
string
- should_remove_source_branch
string
- source_branch
string
- source_project_id
string
- state
string
- subscribed
string
- target_branch
string
- target_project_id
string
- title
string
- updated_at
string
- upvotes
string
- user_notes_count
string
- web_url
string
- work_in_progress
string
MergeRequestChanges
- MergeRequestChanges
object
: Show the merge request changes- assignee UserBasic
- author UserBasic
- changes RepoDiff
- created_at
string
- description
string
- downvotes
string
- force_remove_source_branch
string
- id
string
- iid
string
- labels
string
- merge_commit_sha
string
- merge_status
string
- merge_when_build_succeeds
string
- milestone Milestone
- project_id
string
- sha
string
- should_remove_source_branch
string
- source_branch
string
- source_project_id
string
- state
string
- subscribed
string
- target_branch
string
- target_project_id
string
- title
string
- updated_at
string
- upvotes
string
- user_notes_count
string
- web_url
string
- work_in_progress
string
MergeRequestDiff
- MergeRequestDiff
object
: This feature was introduced in GitLab 8.12.- base_commit_sha
string
- created_at
string
- head_commit_sha
string
- id
string
- merge_request_id
string
- real_size
string
- start_commit_sha
string
- state
string
- base_commit_sha
MergeRequestDiffFull
- MergeRequestDiffFull
object
: This feature was introduced in GitLab 8.12.- base_commit_sha
string
- commits RepoCommit
- created_at
string
- diffs RepoDiff
- head_commit_sha
string
- id
string
- merge_request_id
string
- real_size
string
- start_commit_sha
string
- state
string
- base_commit_sha
Milestone
- Milestone
object
: Update an existing project milestone- created_at
string
- description
string
- due_date
string
- id
string
- iid
string
- project_id
string
- start_date
string
- state
string
- title
string
- updated_at
string
- created_at
Namespace
- Namespace
object
: Get a namespaces list- id
string
- kind
string
- name
string
- path
string
- id
Note
- Note
object
: Delete a +noteable+ note- attachment
string
- author UserBasic
- body
string
- created_at
string
- downvote?
string
- id
string
- noteable_id
string
- noteable_type
string
- system
string
- updated_at
string
- upvote?
string
- attachment
NotificationSetting
- NotificationSetting
object
: This feature was introduced in GitLab 8.12- events
string
- level
string
- events
PersonalSnippet
- PersonalSnippet
object
: This feature was introduced in GitLab 8.15.- author UserBasic
- created_at
string
- file_name
string
- id
string
- raw_url
string
- title
string
- updated_at
string
- web_url
string
Pipeline
- Pipeline
object
: This feature was introduced in GitLab 8.11.- before_sha
string
- committed_at
string
- coverage
string
- created_at
string
- duration
string
- finished_at
string
- id
string
- ref
string
- sha
string
- started_at
string
- status
string
- tag
string
- updated_at
string
- user UserBasic
- yaml_errors
string
- before_sha
PipelineBasic
- PipelineBasic
object
- id
string
- ref
string
- sha
string
- status
string
- id
Project
- Project
object
: Unstar a project- 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
- 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
- only_allow_merge_if_all_discussions_are_resolved
string
- only_allow_merge_if_build_succeeds
string
- open_issues_count
string
- owner UserBasic
- 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
- tag_list
string
- visibility_level
string
- web_url
string
- wiki_enabled
string
- archived
ProjectGroupLink
- ProjectGroupLink
object
: Share the project with a group- expires_at
string
- group_access
string
- group_id
string
- id
string
- project_id
string
- expires_at
ProjectHook
- ProjectHook
object
: Deletes project hook- build_events
string
- created_at
string
- enable_ssl_verification
string
- id
string
- issues_events
string
- merge_requests_events
string
- note_events
string
- pipeline_events
string
- project_id
string
- push_events
string
- tag_push_events
string
- url
string
- wiki_page_events
string
- build_events
ProjectService
- ProjectService
object
: Get the service settings for project- active
string
- build_events
string
- created_at
string
- id
string
- issues_events
string
- merge_requests_events
string
- note_events
string
- pipeline_events
string
- properties
string
- push_events
string
- tag_push_events
string
- title
string
- updated_at
string
- active
ProjectSnippet
- ProjectSnippet
object
: Update an existing project snippet- author UserBasic
- created_at
string
- expires_at
string
- file_name
string
- id
string
- title
string
- updated_at
string
- web_url
string
ProjectStatistics
- ProjectStatistics
object
- build_artifacts_size
string
- commit_count
string
- lfs_objects_size
string
- repository_size
string
- storage_size
string
- build_artifacts_size
ProjectWithAccess
- ProjectWithAccess
object
: Get a single project- 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
- 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
- only_allow_merge_if_all_discussions_are_resolved
string
- only_allow_merge_if_build_succeeds
string
- open_issues_count
string
- owner UserBasic
- path
string
- path_with_namespace
string
- permissions
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
- tag_list
string
- visibility_level
string
- web_url
string
- wiki_enabled
string
- archived
Release
- Release
object
: Update a tag's release note- description
string
- tag_name
string
- description
RepoBranch
- RepoBranch
object
: Create branch- commit
string
- developers_can_merge
string
- developers_can_push
string
- merged
string
- name
string
- protected
string
- commit
RepoCommit
- RepoCommit
object
: Get the commits of a merge request- author_email
string
- author_name
string
- committer_email
string
- committer_name
string
- created_at
string
- id
string
- message
string
- short_id
string
- title
string
- author_email
RepoCommitDetail
- RepoCommitDetail
object
: Get a specific commit of a project- author_email
string
- author_name
string
- authored_date
string
- committed_date
string
- committer_email
string
- committer_name
string
- created_at
string
- id
string
- message
string
- parent_ids
string
- short_id
string
- stats RepoCommitStats
- status
string
- title
string
- author_email
RepoCommitStats
- RepoCommitStats
object
- additions
string
- deletions
string
- total
string
- additions
RepoDiff
- RepoDiff
object
- a_mode
string
- b_mode
string
- deleted_file
string
- diff
string
- new_file
string
- new_path
string
- old_path
string
- renamed_file
string
- a_mode
RepoLicense
- RepoLicense
object
: This feature was introduced in GitLab 8.7.- conditions
string
- content
string
- description
string
- html_url
string
- key
string
- limitations
string
- name
string
- nickname
string
- permissions
string
- popular
string
- source_url
string
- conditions
RepoTag
- RepoTag
object
: Create a new repository tag- commit
string
- message
string
- name
string
- release Release
- commit
RepoTreeObject
- RepoTreeObject
object
: Get a project repository tree- id
string
- mode
string
- name
string
- path
string
- type
string
- id
Runner
- Runner
object
: Remove a runner- active
string
- description
string
- id
string
- is_shared
string
- name
string
- active
RunnerDetails
- RunnerDetails
object
: Update runner's details- active
string
- architecture
string
- contacted_at
string
- description
string
- id
string
- is_shared
string
- locked
string
- name
string
- platform
string
- projects BasicProjectDetails
- revision
string
- run_untagged
string
- tag_list
string
- token
string
- version
string
- active
SSHKey
- SSHKey
object
: Delete an SSH key from the currently authenticated user- can_push
string
- created_at
string
- id
string
- key
string
- title
string
- can_push
SSHKeyWithUser
- SSHKeyWithUser
object
: Get single ssh key by id. Only available to admin users- can_push
string
- created_at
string
- id
string
- key
string
- title
string
- user UserPublic
- can_push
Template
- Template
object
: This feature was introduced in GitLab 8.15. This endpoint is deprecated and will be removed in GitLab 9.0.- content
string
- name
string
- content
TemplatesList
- TemplatesList
object
: This feature was introduced in GitLab 8.15. This endpoint is deprecated and will be removed in GitLab 9.0.- name
string
- name
Todo
- Todo
object
: Mark a todo as done- action_name
string
- author UserBasic
- body
string
- created_at
string
- id
string
- project BasicProjectDetails
- state
string
- target
string
- target_type
string
- target_url
string
- action_name
Trigger
- Trigger
object
: Delete a trigger- created_at
string
- deleted_at
string
- last_used
string
- token
string
- updated_at
string
- created_at
TriggerRequest
- TriggerRequest
object
: Trigger a GitLab project build- id
string
- variables
string
- id
User
- User
object
- avatar_url
string
- bio
string
- created_at
string
- id
string
- is_admin
string
- linkedin
string
- location
string
- name
string
- organization
string
- skype
string
- state
string
- twitter
string
- username
string
- web_url
string
- website_url
string
- avatar_url
UserBasic
- UserBasic
object
: Get a single user- avatar_url
string
- id
string
- name
string
- state
string
- username
string
- web_url
string
- avatar_url
UserPublic
- UserPublic
object
: Get the currently authenticated user- 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
- 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
- avatar_url
UserWithPrivateToken
- UserWithPrivateToken
object
: Login to get token- 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
- is_admin
string
- last_sign_in_at
string
- linkedin
string
- location
string
- name
string
- organization
string
- private_token
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
- avatar_url
Variable
- Variable
object
: Delete an existing variable from a project- key
string
- value
string
- key