File: protected_environments.rst

package info (click to toggle)
python-gitlab 1%3A3.12.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 2,216 kB
  • sloc: python: 21,319; makefile: 169; ruby: 27; javascript: 3
file content (45 lines) | stat: -rw-r--r-- 1,061 bytes parent folder | download | duplicates (2)
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
######################
Protected environments
######################

You can list and manage protected environments in a project.

References
----------

* v4 API:

  + :class:`gitlab.v4.objects.ProjectProtectedEnvironment`
  + :class:`gitlab.v4.objects.ProjectProtectedEnvironmentManager`
  + :attr:`gitlab.v4.objects.Project.protected_environment`

* GitLab API: https://docs.gitlab.com/ee/api/protected_environments.html

Examples
--------

Get the list of protected environments for a project::

    p_environments = project.protected_environments.list()

Get a single protected environment::

    p_environments = project.protected_environments.get('production')

Protect an existing environment::

    p_environment = project.protected_environments.create(
        {
            'name': 'production',
            'deploy_access_levels': [
                {'access_level': 40}
            ],
        }
    )


Unprotect a protected environment::

    p_environment = project.protected_environments.delete('production')
    # or
    p_environment.delete()