python-gitlab Documentation Release 2.10.1 Gauvain Pocentek, Mika Mäenpää Aug 28, 2021 CONTENTS 1 Installation 3 2 gitlab CLI usage 5 2.1 Configuration...............................................5 2.2 CLI....................................................7 2.3 Examples.................................................8 2.4 Enabling shell autocompletion...................................... 10 3 Getting started with the API 13 3.1 gitlab.Gitlab class......................................... 13 3.2 Managers................................................. 14 3.3 Gitlab Objects.............................................. 15 3.4 Base types................................................ 15 3.5 Lazy objects............................................... 16 3.6 Pagination................................................ 16 3.7 Sudo................................................... 17 3.8 Advanced HTTP configuration...................................... 17 3.9 Attributes in updated objects....................................... 19 4 FAQ 21 5 API examples 23 5.1 Access requests.............................................. 23 5.2 Appearance................................................ 24 5.3 Applications............................................... 24 5.4 Award Emojis.............................................. 25 5.5 Badges.................................................. 26 5.6 Branches................................................. 27 5.7 Clusters.................................................. 28 5.8 Broadcast messages........................................... 29 5.9 Commits................................................. 30 5.10 Deploy keys............................................... 33 5.11 Deploy tokens.............................................. 34 5.12 Deployments............................................... 37 5.13 Discussions................................................ 38 5.14 Environments............................................... 40 5.15 Events.................................................. 41 5.16 Epics................................................... 42 5.17 Features flags............................................... 44 5.18 Geo nodes................................................ 44 i 5.19 Groups.................................................. 45 5.20 Issues................................................... 52 5.21 Keys................................................... 57 5.22 Issue boards............................................... 58 5.23 Labels.................................................. 60 5.24 Notification settings........................................... 62 5.25 Merge requests.............................................. 63 5.26 Merge request approvals settings..................................... 67 5.27 Milestones................................................ 68 5.28 Namespaces............................................... 70 5.29 Notes................................................... 71 5.30 Packages................................................. 72 5.31 Pages domains.............................................. 74 5.32 Personal Access Tokens......................................... 76 5.33 Pipelines and Jobs............................................ 76 5.34 Projects.................................................. 83 5.35 Project Access Tokens.......................................... 96 5.36 Protected branches............................................ 97 5.37 Releases................................................. 98 5.38 Runners.................................................. 100 5.39 Project Remote Mirrors......................................... 102 5.40 Registry Repositories........................................... 103 5.41 Registry Repository Tags......................................... 104 5.42 Search API................................................ 105 5.43 Settings.................................................. 106 5.44 Snippets................................................. 106 5.45 System hooks............................................... 108 5.46 Templates................................................. 108 5.47 Todos................................................... 111 5.48 Users and current user.......................................... 111 5.49 CI/CD Variables............................................. 119 5.50 Sidekiq metrics.............................................. 121 5.51 Wiki pages................................................ 121 6 API reference (gitlab package) 123 6.1 Module contents............................................. 123 6.2 Subpackages............................................... 130 6.3 Submodules............................................... 250 6.4 gitlab.base module............................................ 250 6.5 gitlab.cli module............................................. 251 6.6 gitlab.config module........................................... 252 6.7 gitlab.const module............................................ 252 6.8 gitlab.exceptions module......................................... 252 6.9 gitlab.mixins module........................................... 258 6.10 gitlab.utils module............................................ 265 7 CLI reference (gitlab command) 267 7.1 gitlab................................................... 267 8 Release notes 523 8.1 Changes from 1.8 to 1.9......................................... 523 8.2 Changes from 1.7 to 1.8......................................... 523 8.3 Changes from 1.5 to 1.6......................................... 523 8.4 Changes from 1.4 to 1.5......................................... 524 ii 8.5 Changes from 1.3 to 1.4......................................... 524 8.6 Changes from 1.2 to 1.3......................................... 525 8.7 Changes from 1.1 to 1.2......................................... 525 8.8 Changes from 1.0.2 to 1.1........................................ 525 8.9 Changes from 0.21 to 1.0.0....................................... 526 8.10 Changes from 0.20 to 0.21........................................ 526 8.11 Changes from 0.19 to 0.20........................................ 526 9 ChangeLog - Moved to GitHub releases 527 9.1 Version 1.9.0 - 2019-06-19........................................ 527 9.2 Version 1.8.0 - 2019-02-22........................................ 528 9.3 Version 1.7.0 - 2018-12-09........................................ 528 9.4 Version 1.6.0 - 2018-08-25........................................ 529 9.5 Version 1.5.1 - 2018-06-23........................................ 529 9.6 Version 1.5.0 - 2018-06-22........................................ 529 9.7 Version 1.4.0 - 2018-05-19........................................ 531 9.8 Version 1.3.0 - 2018-02-18........................................ 532 9.9 Version 1.2.0 - 2018-01-01........................................ 532 9.10 Version 1.1.0 - 2017-11-03........................................ 533 9.11 Version 1.0.2 - 2017-09-29........................................ 534 9.12 Version 1.0.1 - 2017-09-21........................................ 534 9.13 Version 1.0.0 - 2017-09-08........................................ 534 9.14 Version 0.21.2 - 2017-06-11....................................... 535 9.15 Version 0.21.1 - 2017-05-25....................................... 535 9.16 Version 0.21 - 2017-05-24........................................ 535 9.17 Version 0.20 - 2017-03-25........................................ 536 9.18 Version 0.19 - 2017-02-21........................................ 536 9.19 Version 0.18 - 2016-12-27........................................ 537 9.20 Version 0.17 - 2016-12-02........................................ 537 9.21 Version 0.16 - 2016-10-16........................................ 538 9.22 Version 0.15.1 - 2016-10-16....................................... 538 9.23 Version 0.15 - 2016-08-28........................................ 539 9.24 Version 0.14 - 2016-08-07........................................ 539 9.25 Version 0.13 - 2016-05-16........................................ 541 9.26 Version 0.12.2 - 2016-03-19....................................... 541 9.27 Version 0.12.1 - 2016-02-03....................................... 542 9.28 Version 0.12 - 2016-02-03........................................ 542 9.29 Version 0.11.1 - 2016-01-17....................................... 543 9.30 Version 0.11 - 2016-01-09........................................ 543 9.31 Version 0.10 - 2015-12-29........................................ 543 9.32 Version 0.9.2 - 2015-07-11........................................ 544 9.33 Version 0.9.1 - 2015-05-15........................................ 544 9.34 Version 0.9 - 2015-05-15......................................... 544 9.35 Version 0.8 - 2014-10-26......................................... 544 9.36 Version 0.7 - 2014-08-21......................................... 545 9.37 Version 0.6 - 2014-01-16......................................... 545 9.38 Version 0.5 - 2013-12-26......................................... 545 9.39 Version 0.4 - 2013-09-26......................................... 546 9.40 Version 0.3 - 2013-08-27......................................... 546 9.41 Version 0.2 - 2013-08-08......................................... 546 9.42 Version 0.1 - 2013-07-08......................................... 546 10 Switching to GitLab API v4 547 10.1 Using the v4 API............................................. 547 iii 10.2 Changes between v3 and v4 API....................................