GitLab tools
The 13 GitLab operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List projectsGETLists projects, newest first. Send membership true to get only the projects of the account: without it, GitLab.com returns every public project. Each item has id and path_with_namespace, which the other tools take as the project. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- List project membersGETLists the members of a project, including those inherited from its groups. Each item has id, username and name: the id is what assignee_ids and reviewer_ids ask for. Paginate with page and per_page.
- List issuesGETLists issues of every project the account can see. By default only the issues the account created: send scope assigned_to_me or all for the others. Each item has project_id and iid, which the issue tools ask for. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- List project issuesGETLists the issues of a project, newest first. Each item has iid, the number of the issue in the project, which the issue tools ask for. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- Get issueGETReturns an issue of a project, with title, description, state, labels, assignees, milestone and due date.
- Create issuePOSTCreates an issue in a project and returns it, with its iid. Notifies the participants.
- Update issuePUTChanges an issue and returns it. Only the fields sent change, and at least one must be sent. To close or reopen it, send state_event. labels replaces all the labels; add_labels and remove_labels change only the ones named.
- List issue notesGETLists the comments (notes) of an issue, newest first by default, including the notes GitLab writes for each change. Send activity_filter only_comments to keep just what people wrote. Paginate with page and per_page.
- Create issue notePOSTAdds a comment (note) to an issue and returns it. Notifies the participants.
- List merge requestsGETLists the merge requests of a project, newest first. Each item has iid, which the merge request tools ask for. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- Get merge requestGETReturns a merge request, with its branches, sha, detailed_merge_status (mergeable is the value that allows merging), has_conflicts and head_pipeline.
- Create merge requestPOSTOpens a merge request from source_branch into target_branch and returns it, with its iid. A title that starts with Draft: opens it as a draft. Notifies the assignees and reviewers.
- Merge merge requestPUTMerges a merge request and returns it. With auto_merge true it merges once the pipeline and checks pass. Answers 405 when it cannot be merged, 409 when sha does not match the source branch, and 422 when the merge fails.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
