Gitlab
  1. projects
Gitlab
  • GitLab API v4
    • Topics
      • Introduction
      • Authentication
    • Endpoints
      • access_requests
        • List access requests for a project
        • Requests access for the authenticated user to a project
        • Approves access for the authenticated user to a project
        • Denies a project access request for the given user
        • Denies a project access request for the given user
        • List access requests for a group
        • Requests access for the authenticated user to a group
        • Approves access for the authenticated user to a group
        • Denies a group access request for the given user
      • access_tokens
        • List access tokens for a project
        • Creates an access token for a project
        • Revokes an access token
      • Retrieve metadata information for this GitLab instance
      • Retrieve metadata information for this GitLab instance
  • application
    • Get the current application settings
    • Modify application settings
  • ci
    • Validation of .gitlab-ci.yml content
  • deploy_keys
    • /v3/deploy_keys
  • dockerfiles
    • Get the list of the available template
    • Get the text for a specific template present in local filesystem
  • gitignores
    • Get the list of the available template
    • Get the text for a specific template present in local filesystem
  • gitlab_ci_ymls
    • Get the list of the available template
    • Get the text for a specific template present in local filesystem
  • groups
    • Get a groups list
    • Create a group. Available only for users who can create groups.
    • Get list of owned groups for authenticated user
    • Remove a group.
    • Get a single group, with containing projects.
    • Update a group. Available only for users who can administrate groups.
    • Gets a list of access requests for a group.
    • Requests access for the authenticated user to a group.
    • Denies an access request for the given user.
    • Approves an access request for the given user.
    • Get a list of group issues
    • Gets a list of group or project members viewable by the authenticated user.
    • Adds a member to a group or project.
    • Removes a user from a group or project.
    • Gets a member of a group or project.
    • Updates a member of a group or project.
    • Get group level notification level settings, defaults to Global
    • Update group level notification level settings, defaults to Global
    • Get a list of projects in this group.
    • Transfer a project to the group namespace. Available only for admin.
  • hooks
    • Get the list of system hooks
    • Create a new system hook
    • Delete a hook
    • Test a hook
  • internal
    • /v3/internal/allowed
    • /v3/internal/broadcast_message
    • /v3/internal/check
    • /v3/internal/discover
    • /v3/internal/lfs_authenticate
    • /v3/internal/merge_request_urls
    • /v3/internal/two_factor_recovery_codes
  • issues
    • Get currently authenticated user's issues
  • keys
    • Get single ssh key by id. Only available to admin users
  • licenses
    • Get the list of the available license template
    • Get the text for a specific license
  • namespaces
    • Get a namespaces list
  • notification_settings
    • Get global notification level settings and email, defaults to Participate
    • Update global notification level settings and email, defaults to Participate
  • projects
    • Get a projects list for authenticated user
      GET
    • Create new project
      POST
    • Get all projects for admin user
      GET
    • Fork new project for the current user or provided namespace.
      POST
    • Get an owned projects list for authenticated user
      GET
    • Search for projects the current user has access to
      GET
    • Gets starred project for the authenticated user
      GET
    • Create new project for a specified user. Only available to admin users.
      POST
    • Get a list of visible projects for authenticated user
      GET
    • Remove a project
      DELETE
    • Get a single project
      GET
    • Update an existing project
      PUT
    • Trigger a GitLab project build
      POST
    • Gets a list of access requests for a project.
      GET
    • Requests access for the authenticated user to a project.
      POST
    • Denies an access request for the given user.
      DELETE
    • Approves an access request for the given user.
      PUT
    • Archive a project
      POST
    • Get all project boards
      GET
    • Get the lists of a project board
      GET
    • Create a new board list
      POST
    • Delete a board list
      DELETE
    • Get a list of a project board
      GET
    • Moves a board list to a new position
      PUT
    • Get a project builds
      GET
    • Download the artifacts file from build
      GET
    • Get a specific build of a project
      GET
    • Download the artifacts file from build
      GET
    • Keep the artifacts to prevent them from being deleted
      POST
    • Cancel a specific build of a project
      POST
    • Erase build (remove artifacts and build trace)
      POST
    • Trigger a manual build
      POST
    • Retry a specific build of a project
      POST
    • Get a trace of a specific build of a project
      GET
    • Get a specific project's deploy keys
      GET
    • Add new deploy key to currently authenticated user
      POST
    • Delete deploy key for a project
      DELETE
    • Get single deploy key
      GET
    • Disable a deploy key for a project
      DELETE
    • Enable a deploy key for a project
      POST
    • Get all deployments of the project
      GET
    • Gets a specific deployment
      GET
    • Get all environments of the project
      GET
    • Creates a new environment
      POST
    • Deletes an existing environment
      DELETE
    • Updates an existing environment
      PUT
    • Get events for a single project
      GET
    • Remove a forked_from relationship
      DELETE
    • Mark this project as forked from another
      POST
    • Get project hooks
      GET
    • Add hook to project
      POST
    • Deletes project hook
      DELETE
    • Get a project hook
      GET
    • Update an existing project hook
      PUT
    • Get a list of project issues
      GET
    • Create a new project issue
      POST
    • Delete a project issue
      DELETE
    • Get a single project issue
      GET
    • Update an existing issue
      PUT
    • Add spent time for a project issue
      POST
    • Get a list of project +awardable+ award emoji
      GET
    • Award a new Emoji
      POST
    • Delete a +awardables+ award emoji
      DELETE
    • Get a specific award emoji
      GET
    • Move an existing issue
      POST
    • Get a list of project +awardable+ award emoji
      GET
    • Award a new Emoji
      POST
    • Delete a +awardables+ award emoji
      DELETE
    • Get a specific award emoji
      GET
    • Reset spent time for a project issue
      POST
    • Reset the time estimate for a project issue
      POST
    • Set a time estimate for a project issue
      POST
    • Show time stats for a project issue
      GET
    • Create a todo on an issuable
      POST
    • Get a list of project +noteable+ notes
      GET
    • Create a new +noteable+ note
      POST
    • Delete a +noteable+ note
      DELETE
    • Get a single +noteable+ note
      GET
    • Update an existing +noteable+ note
      PUT
    • Unsubscribe from a resource
      DELETE
    • Subscribe to a resource
      POST
    • Get a specific project's deploy keys
      GET
    • Add new deploy key to currently authenticated user
      POST
    • Delete deploy key for a project
      DELETE
    • Get single deploy key
      GET
    • Disable a deploy key for a project
      DELETE
    • Enable a deploy key for a project
      POST
    • Delete an existing label
      DELETE
    • Get all labels of the project
      GET
    • Create a new label
      POST
    • Update an existing label. At least one optional parameter is required.
      PUT
    • Unsubscribe from a resource
      DELETE
    • Subscribe to a resource
      POST
    • Gets a list of group or project members viewable by the authenticated user.
      GET
    • Adds a member to a group or project.
      POST
    • Removes a user from a group or project.
      DELETE
    • Gets a member of a group or project.
      GET
    • Updates a member of a group or project.
      PUT
    • Get a single merge request
      GET
    • Update a merge request
      PUT
    • Cancel merge if "Merge When Pipeline Succeeds" is enabled
      POST
    • Show the merge request changes
      GET
    • List issues that will be closed on merge
      GET
    • Get the comments of a merge request
      GET
    • Post a comment to a merge request
      POST
    • Get the commits of a merge request
      GET
    • Merge a merge request
      PUT
    • Unsubscribe from a resource
      DELETE
    • Subscribe to a resource
      POST
    • List merge requests
      GET
    • Create a merge request
      POST
    • Delete a merge request
      DELETE
    • Get a single merge request
      GET
    • Update a merge request
      PUT
    • Add spent time for a project merge_request
      POST
    • Get a list of project +awardable+ award emoji
      GET
    • Award a new Emoji
      POST
    • Delete a +awardables+ award emoji
      DELETE
    • Get a specific award emoji
      GET
    • Cancel merge if "Merge When Pipeline Succeeds" is enabled
      POST
    • Show the merge request changes
      GET
    • List issues that will be closed on merge
      GET
    • Get the comments of a merge request
      GET
    • Post a comment to a merge request
      POST
    • Get the commits of a merge request
      GET
    • Merge a merge request
      PUT
    • Get a list of project +awardable+ award emoji
      GET
    • Award a new Emoji
      POST
    • Delete a +awardables+ award emoji
      DELETE
    • Get a specific award emoji
      GET
    • Reset spent time for a project merge_request
      POST
    • Reset the time estimate for a project merge_request
      POST
    • Set a time estimate for a project merge_request
      POST
    • Show time stats for a project merge_request
      GET
    • Create a todo on an issuable
      POST
    • Get a list of merge request diff versions
      GET
    • Get a single merge request diff version
      GET
    • Get a list of project +noteable+ notes
      GET
    • Create a new +noteable+ note
      POST
    • Delete a +noteable+ note
      DELETE
    • Get a single +noteable+ note
      GET
    • Update an existing +noteable+ note
      PUT
    • Unsubscribe from a resource
      DELETE
    • Subscribe to a resource
      POST
    • Get a list of project milestones
      GET
    • Create a new project milestone
      POST
    • Get a single project milestone
      GET
    • Update an existing project milestone
      PUT
    • Get all issues for a single project milestone
      GET
    • Get project level notification level settings, defaults to Global
      GET
    • Update project level notification level settings, defaults to Global
      PUT
    • Create a new pipeline
      POST
    • Get all Pipelines of the project
      GET
    • Gets a specific pipeline for the project
      GET
    • Cancel all builds in the pipeline
      POST
    • Retry failed builds in the pipeline
      POST
    • Get an archive of the repository
      GET
    • Get a raw file contents
      GET
    • Get a project repository branches
      GET
    • Create branch
      POST
    • Delete a branch
      DELETE
    • Get a single branch
      GET
    • Protect a single branch
      PUT
    • Unprotect a single branch
      PUT
    • Get a project repository commits
      GET
    • Commit multiple file changes as one commit
      POST
    • Get a specific commit of a project
      GET
    • Get a raw file contents
      GET
    • Get builds for a specific commit of a project
      GET
    • Cherry pick commit into a branch
      POST
    • Get a commit's comments
      GET
    • Post comment to commit
      POST
    • Get the diff for a specific commit of a project
      GET
    • Get a commit's statuses
      GET
    • Compare two branches, tags, or commits
      GET
    • Get repository contributors
      GET
    • Delete an existing file in repository
      DELETE
    • Get a file from repository
      GET
    • Create new file in repository
      POST
    • Update existing file in repository
      PUT
    • /v3/projects/{id}/repository/merged_branches
      DELETE
    • Get a raw blob contents by blob sha
      GET
    • Get a project repository tags
      GET
    • Create a new repository tag
      POST
    • Delete a repository tag
      DELETE
    • Get a single repository tag
      GET
    • Add a release note to a tag
      POST
    • Update a tag's release note
      PUT
    • Get a project repository tree
      GET
    • Get runners available for project
      GET
    • Enable a runner for a project
      POST
    • Disable project's runner
      DELETE
    • Set asana service for project
      PUT
    • Set assembla service for project
      PUT
    • Set bamboo service for project
      PUT
    • Set bugzilla service for project
      PUT
    • Set buildkite service for project
      PUT
    • Set builds-email service for project
      PUT
    • Set campfire service for project
      PUT
    • Set custom-issue-tracker service for project
      PUT
    • Set drone-ci service for project
      PUT
    • Set emails-on-push service for project
      PUT
    • Set external-wiki service for project
      PUT
    • Set flowdock service for project
      PUT
    • Set gemnasium service for project
      PUT
    • Set hipchat service for project
      PUT
    • Set irker service for project
      PUT
    • Set jira service for project
      PUT
    • Set kubernetes service for project
      PUT
    • Set mattermost service for project
      PUT
    • Set mattermost-slash-commands service for project
      PUT
    • Trigger a slash command for mattermost-slash-commands
      POST
    • Set pipelines-email service for project
      PUT
    • Set pivotaltracker service for project
      PUT
    • Set pushover service for project
      PUT
    • Set redmine service for project
      PUT
    • Set slack service for project
      PUT
    • Set slack-slash-commands service for project
      PUT
    • Trigger a slash command for slack-slash-commands
      POST
    • Set teamcity service for project
      PUT
    • Delete a service for project
      DELETE
    • Get the service settings for project
      GET
    • Share the project with a group
      POST
    • /v3/projects/{id}/share/{group_id}
      DELETE
    • Get all project snippets
      GET
    • Create a new project snippet
      POST
    • Get a list of project +noteable+ notes
      GET
    • Create a new +noteable+ note
      POST
    • Delete a +noteable+ note
      DELETE
    • Get a single +noteable+ note
      GET
    • Update an existing +noteable+ note
      PUT
    • Delete a project snippet
      DELETE
    • Get a single project snippet
      GET
    • Update an existing project snippet
      PUT
    • Get a list of project +awardable+ award emoji
      GET
    • Award a new Emoji
      POST
    • Delete a +awardables+ award emoji
      DELETE
    • Get a specific award emoji
      GET
    • Get a list of project +awardable+ award emoji
      GET
    • Award a new Emoji
      POST
    • Delete a +awardables+ award emoji
      DELETE
    • Get a specific award emoji
      GET
    • Get a raw project snippet
      GET
    • Unstar a project
      DELETE
    • Star a project
      POST
    • Post status to a commit
      POST
    • Get triggers list
      GET
    • Create a trigger
      POST
    • Delete a trigger
      DELETE
    • Get specific trigger of a project
      GET
    • Unarchive a project
      POST
    • Upload a file
      POST
    • Get the users list of a project
      GET
    • Get project variables
      GET
    • Create a new variable in a project
      POST
    • Delete an existing variable from a project
      DELETE
    • Get a specific variable from a project
      GET
    • Update an existing variable from a project
      PUT
  • runners
    • Get runners available for user
    • Get all runners - shared and specific
    • Remove a runner
    • Get runner's details
    • Update runner's details
  • session
    • Login to get token
  • sidekiq
    • Get the Sidekiq Compound metrics. Includes queue, process, and job statistics
    • Get the Sidekiq job statistics
    • Get the Sidekiq process metrics
    • Get the Sidekiq queue metrics
  • snippets
    • Get a snippets list for authenticated user
    • Create new snippet
    • List all public snippets current_user has access to
    • Remove snippet
    • Get a single snippet
    • Update an existing snippet
    • Get a raw snippet
  • templates
    • Get the list of the available template
    • Get the text for a specific template present in local filesystem
    • Get the list of the available template
    • Get the text for a specific template present in local filesystem
    • Get the list of the available template
    • Get the text for a specific template present in local filesystem
    • Get the list of the available license template
    • Get the text for a specific license
  • todos
    • Mark all todos as done
    • Get a todo list
    • Mark a todo as done
  • user
    • Get the currently authenticated user
    • Get the currently authenticated user's email addresses
    • Add new email address to the currently authenticated user
    • Delete an email address from the currently authenticated user
    • Get a single email address owned by the currently authenticated user
    • Get the currently authenticated user's SSH keys
    • Add a new SSH key to the currently authenticated user
    • Delete an SSH key from the currently authenticated user
    • Get a single key owned by currently authenticated user
  • users
    • Get the list of users
    • Create a user. Available only for admins.
    • Delete a user. Available only for admins.
    • Get a single user
    • Update a user. Available only for admins.
    • Block a user. Available only for admins.
    • Get the emails addresses of a specified user. Available only for admins.
    • Add an email address to a specified user. Available only for admins.
    • Delete an email address of a specified user. Available only for admins.
    • Get the contribution events of a specified user
    • Get the SSH keys of a specified user. Available only for admins.
    • Add an SSH key to a specified user. Available only for admins.
    • Delete an existing SSH key from a specified user. Available only for admins.
    • Unblock a user. Available only for admins.
  • version
    • Get the version information of the GitLab instance.
  1. projects

Set jira service for project

PUT
/v3/projects/{id}/services/jira
Set jira service for project
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://gitlab.com/api/v3/projects//services/jira' \
--data-urlencode 'url=' \
--data-urlencode 'project_key='
Response Response Example
{}

Request

Path Params
id
integer 
required
Body Params application/x-www-form-urlencoded
url
string 
required
The URL to the JIRA project which is being linked to this GitLab project, e.g., https://jira.example.com
project_key
string 
required
The short identifier for your JIRA project, all uppercase, e.g., PROJ
username
string 
optional
The username of the user created to be used with GitLab/JIRA
password
string 
optional
The password of the user created to be used with GitLab/JIRA
jira_issue_transition_id
integer 
optional
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 to 2
commit_events
string 
optional
Event will be triggered when a commit is created/updated
merge_request_events
string 
optional
Event will be triggered when a merge request is created/updated/merged

Responses

🟢200Set jira service for project
application/json
Body
object {0}
Modified at 2023-08-15 04:14:33
Previous
Set irker service for project
Next
Set kubernetes service for project
Built with