blob: a293d2717e686a308b04ede260c7cec9ba3833e1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
###########
Deploy keys
###########
Deploy keys
===========
Reference
---------
* v4 API:
+ :class:`gitlab.v4.objects.DeployKey`
+ :class:`gitlab.v4.objects.DeployKeyManager`
+ :attr:`gitlab.Gitlab.deploykeys`
* v3 API:
+ :class:`gitlab.v3.objects.DeployKey`
+ :class:`gitlab.v3.objects.DeployKeyManager`
+ :attr:`gitlab.Gitlab.deploykeys`
* GitLab API: https://docs.gitlab.com/ce/api/deploy_keys.html
Examples
--------
List the deploy keys:
.. literalinclude:: deploy_keys.py
:start-after: # global list
:end-before: # end global list
Get a single deploy key:
.. literalinclude:: deploy_keys.py
:start-after: # global get
:end-before: # end global get
Deploy keys for projects
========================
Deploy keys can be managed on a per-project basis.
Reference
---------
* v4 API:
+ :class:`gitlab.v4.objects.ProjectKey`
+ :class:`gitlab.v4.objects.ProjectKeyManager`
+ :attr:`gitlab.v4.objects.Project.keys`
* v3 API:
+ :class:`gitlab.v3.objects.ProjectKey`
+ :class:`gitlab.v3.objects.ProjectKeyManager`
+ :attr:`gitlab.v3.objects.Project.keys`
+ :attr:`gitlab.Gitlab.project_keys`
* GitLab API: https://docs.gitlab.com/ce/api/deploy_keys.html
Examples
--------
List keys for a project:
.. literalinclude:: deploy_keys.py
:start-after: # list
:end-before: # end list
Get a single deploy key:
.. literalinclude:: deploy_keys.py
:start-after: # get
:end-before: # end get
Create a deploy key for a project:
.. literalinclude:: deploy_keys.py
:start-after: # create
:end-before: # end create
Delete a deploy key for a project:
.. literalinclude:: deploy_keys.py
:start-after: # delete
:end-before: # end delete
Enable a deploy key for a project:
.. literalinclude:: deploy_keys.py
:start-after: # enable
:end-before: # end enable
Disable a deploy key for a project:
.. literalinclude:: deploy_keys.py
:start-after: # disable
:end-before: # end disable
|
