@datafire/gitlab v6.0.0
@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)