summaryrefslogtreecommitdiff
path: root/docs/gl_objects/deploy_keys.rst
blob: e67e2c171b67ab933436943517b67f4d66a2e31e (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
###########
Deploy keys
###########

Deploy keys
===========

Use :class:`~gitlab.objects.Key` objects to manipulate deploy keys. The
:attr:`gitlab.Gitlab.keys` manager object provides helper functions.

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
========================

Use :class:`~gitlab.objects.ProjectKey` objects to manipulate deploy keys for
projects. The :attr:`gitlab.Gitlab.project_keys` and :attr:`Project.keys
<gitlab.objects.Project.keys>` manager objects provide helper functions.

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