gitlab.v4 package

Submodules

gitlab.v4.objects module

class gitlab.v4.objects.Application(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ApplicationAppearance(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ApplicationAppearanceManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.mixins.UpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Optional attributes for object update:

  • title

  • description

  • logo

  • header_logo

  • favicon

  • new_project_guidelines

  • header_message

  • footer_message

  • message_background_color

  • message_font_color

  • email_header_and_footer_enabled

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.appearance.ApplicationAppearance]

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.appearance.ApplicationAppearance]

gitlab: gitlab.client.Gitlab
update(id: Optional[Union[int, str]] = None, new_data: Dict[str, Any] = None, **kwargs: Any) → Dict[str, Any]

Update an object on the server.

Parameters

  • id (Optional[Union[int, str]]) – ID of the object to update (can be None if not required)

  • new_data (Dict[str, Any]) – the update data for the object

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The new object data (not a RESTObject)

Raises
Return type

Dict[str, Any]

class gitlab.v4.objects.ApplicationManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • name

  • redirect_uri

  • scopes

Optional attributes:

  • confidential

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ApplicationSettings(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ApplicationSettingsManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.mixins.UpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Optional attributes for object update:

  • id

  • default_projects_limit

  • signup_enabled

  • password_authentication_enabled_for_web

  • gravatar_enabled

  • sign_in_text

  • created_at

  • updated_at

  • home_page_url

  • default_branch_protection

  • restricted_visibility_levels

  • max_attachment_size

  • session_expire_delay

  • default_project_visibility

  • default_snippet_visibility

  • default_group_visibility

  • outbound_local_requests_whitelist

  • disabled_oauth_sign_in_sources

  • domain_whitelist

  • domain_blacklist_enabled

  • domain_blacklist

  • domain_allowlist

  • domain_denylist_enabled

  • domain_denylist

  • external_authorization_service_enabled

  • external_authorization_service_url

  • external_authorization_service_default_label

  • external_authorization_service_timeout

  • import_sources

  • user_oauth_applications

  • after_sign_out_path

  • container_registry_token_expire_delay

  • repository_storages

  • plantuml_enabled

  • plantuml_url

  • terminal_max_session_time

  • polling_interval_multiplier

  • rsa_key_restriction

  • dsa_key_restriction

  • ecdsa_key_restriction

  • ed25519_key_restriction

  • first_day_of_week

  • enforce_terms

  • terms

  • performance_bar_allowed_group_id

  • instance_statistics_visibility_private

  • user_show_add_ssh_key_message

  • file_template_project_id

  • local_markdown_version

  • asset_proxy_enabled

  • asset_proxy_url

  • asset_proxy_whitelist

  • asset_proxy_allowlist

  • geo_node_allowed_ips

  • allow_local_requests_from_hooks_and_services

  • allow_local_requests_from_web_hooks_and_services

  • allow_local_requests_from_system_hooks

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.settings.ApplicationSettings]

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.settings.ApplicationSettings]

gitlab: gitlab.client.Gitlab
update(id: Optional[Union[int, str]] = None, new_data: Dict[str, Any] = None, **kwargs: Any) → Dict[str, Any]

Update an object on the server.

Parameters

  • id (Optional[Union[int, str]]) – ID of the object to update (can be None if not required)

  • new_data (Dict[str, Any]) – the update data for the object

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The new object data (not a RESTObject)

Raises
Return type

Dict[str, Any]

class gitlab.v4.objects.AuditEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.AuditEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object listing filters

  • created_after

  • created_before

  • entity_type

  • entity_id

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.audit_events.AuditEvent

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.audit_events.AuditEvent

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.BroadcastMessage(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.BroadcastMessageManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • message

Optional attributes:

  • starts_at

  • ends_at

  • color

  • font

Object update

Optional attributes for object update:

  • message

  • starts_at

  • ends_at

  • color

  • font

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.broadcast_messages.BroadcastMessage

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.broadcast_messages.BroadcastMessage

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.CurrentUser(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

emails: gitlab.v4.objects.users.CurrentUserEmailManager
gpgkeys: gitlab.v4.objects.users.CurrentUserGPGKeyManager
keys: gitlab.v4.objects.users.CurrentUserKeyManager
status: gitlab.v4.objects.users.CurrentUserStatusManager
class gitlab.v4.objects.CurrentUserEmail(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.CurrentUserEmailManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • email

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.users.CurrentUserEmail

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.users.CurrentUserEmail

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.CurrentUserGPGKey(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.CurrentUserGPGKeyManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • key

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.users.CurrentUserGPGKey

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.users.CurrentUserGPGKey

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.CurrentUserKey(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.CurrentUserKeyManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • title

  • key

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.users.CurrentUserKey

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.users.CurrentUserKey

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.CurrentUserManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.users.CurrentUser]

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.users.CurrentUser]

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.CurrentUserStatus(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.CurrentUserStatusManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.mixins.UpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Optional attributes for object update:

  • emoji

  • message

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.users.CurrentUserStatus]

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.users.CurrentUserStatus]

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.DeployKey(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.DeployKeyManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.DeployToken(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.DeployTokenManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.Dockerfile(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.DockerfileManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.templates.Dockerfile

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.templates.Dockerfile

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.Event(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.EventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • action

  • target_type

  • before

  • after

  • sort

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.Feature(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.FeatureManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
set(name: str, value: Union[bool, int], feature_group: Optional[str] = None, user: Optional[str] = None, group: Optional[str] = None, project: Optional[str] = None, **kwargs: Any) → gitlab.v4.objects.features.Feature

Create or update the object.

Parameters

  • name (str) – The value to set for the object

  • value (Union[bool, int]) – The value to set for the object

  • feature_group (Optional[str]) – A feature group name

  • user (Optional[str]) – A GitLab username

  • group (Optional[str]) – A GitLab group

  • project (Optional[str]) – A GitLab project in form group/project

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The created/updated attribute

Return type

gitlab.v4.objects.features.Feature

class gitlab.v4.objects.GenericPackage(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GenericPackageManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

download(package_name: str, package_version: str, file_name: str, streamed: bool = False, action: Optional[Callable] = None, chunk_size: int = 1024, **kwargs: Any) → Optional[bytes]

Download a generic package.

Parameters

  • package_name (str) – The package name.

  • package_version (str) – The package version.

  • file_name (str) – The name of the file in the registry

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment

  • action (Optional[Callable]) – Callable responsible of dealing with chunk of data

  • chunk_size (int) – Size of each chunk

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The package content if streamed is False, None otherwise

Return type

Optional[bytes]

gitlab: gitlab.client.Gitlab
upload(package_name: str, package_version: str, file_name: str, path: Union[str, pathlib.Path], **kwargs: Any) → gitlab.v4.objects.packages.GenericPackage

Upload a file as a generic package.

Parameters

  • package_name (str) – The package name. Must follow generic package name regex rules

  • package_version (str) – The package version. Must follow semantic version regex rules

  • file_name (str) – The name of the file as uploaded in the registry

  • path (Union[str, pathlib.Path]) – The path to a local file to upload

  • kwargs (Any) –

Raises
Returns

An object storing the metadata of the uploaded package.

Return type

gitlab.v4.objects.packages.GenericPackage

https://docs.gitlab.com/ee/user/packages/generic_packages/

class gitlab.v4.objects.GeoNode(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
repair(**kwargs: Any) → None

Repair the OAuth authentication of the geo node.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

status(**kwargs: Any) → Dict[str, Any]

Get the status of the geo node.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The status of the geo node

Return type

Dict[str, Any]

class gitlab.v4.objects.GeoNodeManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Optional attributes for object update:

  • enabled

  • url

  • files_max_capacity

  • repos_max_capacity

Parameters
Return type

None

current_failures(**kwargs: Any) → List[Dict[str, Any]]

Get the list of failures on the current geo node.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The list of failures

Return type

List[Dict[str, Any]]

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.geo_nodes.GeoNode

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.geo_nodes.GeoNode

gitlab: gitlab.client.Gitlab
status(**kwargs: Any) → List[Dict[str, Any]]

Get the status of all the geo nodes.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The status of all the geo nodes

Return type

List[Dict[str, Any]]

class gitlab.v4.objects.Gitignore(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GitignoreManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.templates.Gitignore

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.templates.Gitignore

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.Gitlabciyml(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GitlabciymlManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.templates.Gitlabciyml

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.templates.Gitlabciyml

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.Group(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

access_tokens: gitlab.v4.objects.group_access_tokens.GroupAccessTokenManager
accessrequests: gitlab.v4.objects.access_requests.GroupAccessRequestManager

Add an LDAP group link.

Parameters

  • cn (str) – CN of the LDAP group

  • group_access (int) – Minimum access level for members of the LDAP group

  • provider (str) – LDAP provider for the LDAP group

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

audit_events: gitlab.v4.objects.audit_events.GroupAuditEventManager
badges: gitlab.v4.objects.badges.GroupBadgeManager
billable_members: gitlab.v4.objects.members.GroupBillableMemberManager
boards: gitlab.v4.objects.boards.GroupBoardManager
clusters: gitlab.v4.objects.clusters.GroupClusterManager
customattributes: gitlab.v4.objects.custom_attributes.GroupCustomAttributeManager

Delete an LDAP group link.

Parameters

  • cn (str) – CN of the LDAP group

  • provider (Optional[str]) – LDAP provider for the LDAP group

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

deploytokens: gitlab.v4.objects.deploy_tokens.GroupDeployTokenManager
descendant_groups: GroupDescendantGroupManager
epics: gitlab.v4.objects.epics.GroupEpicManager
exports: gitlab.v4.objects.export_import.GroupExportManager
hooks: gitlab.v4.objects.hooks.GroupHookManager
imports: gitlab.v4.objects.export_import.GroupImportManager
issues: gitlab.v4.objects.issues.GroupIssueManager
issues_statistics: gitlab.v4.objects.statistics.GroupIssuesStatisticsManager
labels: gitlab.v4.objects.labels.GroupLabelManager
ldap_sync(**kwargs: Any) → None

Sync LDAP groups.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

members: gitlab.v4.objects.members.GroupMemberManager
members_all: gitlab.v4.objects.members.GroupMemberAllManager
mergerequests: gitlab.v4.objects.merge_requests.GroupMergeRequestManager
milestones: gitlab.v4.objects.milestones.GroupMilestoneManager
notificationsettings: gitlab.v4.objects.notification_settings.GroupNotificationSettingsManager
packages: gitlab.v4.objects.packages.GroupPackageManager
projects: gitlab.v4.objects.projects.GroupProjectManager
runners: gitlab.v4.objects.runners.GroupRunnerManager
search(scope: str, search: str, **kwargs: Any) → Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

Search the group resources matching the provided string.

Parameters

  • scope (str) – Scope of the search

  • search (str) – Search string

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A list of dicts describing the resources found.

Return type

Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

share(group_id: int, group_access: int, expires_at: Optional[str] = None, **kwargs: Any) → None

Share the group with a group.

Parameters

  • group_id (int) – ID of the group.

  • group_access (int) – Access level for the group.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • expires_at (Optional[str]) –

  • kwargs (Any) –

Raises
Returns

Group

Return type

None

subgroups: GroupSubgroupManager
transfer(group_id: Optional[int] = None, **kwargs: Any) → None

Transfer the group to a new parent group or make it a top-level group.

Requires GitLab ≥14.6.

Parameters

  • group_id (Optional[int]) – ID of the new parent group. When not specified, the group to transfer is instead turned into a top-level group.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

transfer_project(project_id: int, **kwargs: Any) → None

Transfer a project to this group.

Parameters

  • to_project_id – ID of the project to transfer

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • project_id (int) –

  • kwargs (Any) –

Raises
Return type

None

unshare(group_id: int, **kwargs: Any) → None

Delete a shared group link within a group.

Parameters

  • group_id (int) – ID of the group.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

variables: gitlab.v4.objects.variables.GroupVariableManager
wikis: gitlab.v4.objects.wikis.GroupWikiManager
class gitlab.v4.objects.GroupAccessRequest(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.AccessRequestMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupAccessRequestManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupAuditEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupAuditEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object listing filters

  • created_after

  • created_before

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.audit_events.GroupAuditEvent

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.audit_events.GroupAuditEvent

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupBadge(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupBadgeManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.BadgeRenderMixin, gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • link_url

  • image_url

Object update

Optional attributes for object update:

  • link_url

  • image_url

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.badges.GroupBadge

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.badges.GroupBadge

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupBillableMember(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

memberships: GroupBillableMemberMembershipManager
class gitlab.v4.objects.GroupBillableMemberManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object listing filters

  • search

  • sort

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupBillableMemberMembership(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupBillableMemberMembershipManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupBoard(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

lists: gitlab.v4.objects.boards.GroupBoardListManager
class gitlab.v4.objects.GroupBoardList(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupBoardListManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • label_id

Object update

Mandatory attributes for object update:

  • position

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.boards.GroupBoardList

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.boards.GroupBoardList

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupBoardManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • name

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.boards.GroupBoard

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.boards.GroupBoard

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupCluster(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupClusterManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • name

  • platform_kubernetes_attributes

Optional attributes:

  • domain

  • enabled

  • managed

  • environment_scope

Object update

Optional attributes for object update:

  • name

  • domain

  • management_project_id

  • platform_kubernetes_attributes

  • environment_scope

Parameters
Return type

None

create(data: Optional[Dict[str, Any]] = None, **kwargs: Any) → gitlab.v4.objects.clusters.GroupCluster

Create a new object.

Parameters

  • data (Optional[Dict[str, Any]]) – Parameters to send to the server to create the resource

  • **kwargs – Extra options to send to the server (e.g. sudo or ‘ref_name’, ‘stage’, ‘name’, ‘all’)

  • kwargs (Any) –

Raises
Returns

A new instance of the manage object class build with

the data sent by the server

Return type

gitlab.v4.objects.clusters.GroupCluster

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.clusters.GroupCluster

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.clusters.GroupCluster

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupCustomAttribute(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupCustomAttributeManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.SetMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.custom_attributes.GroupCustomAttribute

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.custom_attributes.GroupCustomAttribute

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupDeployToken(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupDeployTokenManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • name

  • scopes

Optional attributes:

  • expires_at

  • username

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupDescendantGroup(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupDescendantGroupManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.v4.objects.groups.GroupSubgroupManager

This manager inherits from GroupSubgroupManager as descendant groups share all attributes with subgroups, except the path and object class.

Object listing filters

  • skip_groups

  • all_available

  • search

  • order_by

  • sort

  • statistics

  • owned

  • with_custom_attributes

  • min_access_level

Object Creation

Object update

Parameters
Return type

None

class gitlab.v4.objects.GroupEpic(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

issues: GroupEpicIssueManager
resourcelabelevents: gitlab.v4.objects.events.GroupEpicResourceLabelEventManager
class gitlab.v4.objects.GroupEpicAwardEmoji(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupEpicAwardEmojiManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • name

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.award_emojis.GroupEpicAwardEmoji

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.award_emojis.GroupEpicAwardEmoji

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupEpicDiscussionNote(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupEpicDiscussionNoteManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.GetMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • body

Optional attributes:

  • created_at

Object update

Mandatory attributes for object update:

  • body

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.notes.GroupEpicDiscussionNote

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.notes.GroupEpicDiscussionNote

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupEpicIssue(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: GroupEpicIssueManager
save(**kwargs: Any) → None

Save the changes made to the object to the server.

The object is updated to match what the server returns.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

class gitlab.v4.objects.GroupEpicIssueManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • issue_id

Object update

Optional attributes for object update:

  • move_before_id

  • move_after_id

Parameters
Return type

None

create(data: Optional[Dict[str, Any]] = None, **kwargs: Any) → gitlab.v4.objects.epics.GroupEpicIssue

Create a new object.

Parameters

  • data (Optional[Dict[str, Any]]) – Parameters to send to the server to create the resource

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A new instance of the manage object class build with

the data sent by the server

Return type

gitlab.v4.objects.epics.GroupEpicIssue

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupEpicManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object listing filters

  • author_id

  • labels

  • order_by

  • sort

  • search

Object Creation

Mandatory attributes:

  • title

Optional attributes:

  • labels

  • description

  • start_date

  • end_date

Object update

Optional attributes for object update:

  • title

  • labels

  • description

  • start_date

  • end_date

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.epics.GroupEpic

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.epics.GroupEpic

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupEpicNote(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

awardemojis: gitlab.v4.objects.award_emojis.GroupEpicNoteAwardEmojiManager
class gitlab.v4.objects.GroupEpicNoteAwardEmoji(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupEpicNoteAwardEmojiManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • name

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.award_emojis.GroupEpicNoteAwardEmoji

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.award_emojis.GroupEpicNoteAwardEmoji

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupEpicNoteManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • body

Optional attributes:

  • created_at

Object update

Mandatory attributes for object update:

  • body

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.notes.GroupEpicNote

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.notes.GroupEpicNote

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupEpicResourceLabelEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupEpicResourceLabelEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.events.GroupEpicResourceLabelEvent

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.events.GroupEpicResourceLabelEvent

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupExport(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.DownloadMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupExportManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.mixins.CreateMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.export_import.GroupExport]

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.export_import.GroupExport]

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupHook(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupHookManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • url

Optional attributes:

  • push_events

  • issues_events

  • confidential_issues_events

  • merge_requests_events

  • tag_push_events

  • note_events

  • confidential_note_events

  • job_events

  • pipeline_events

  • wiki_page_events

  • deployment_events

  • releases_events

  • subgroup_events

  • enable_ssl_verification

  • token

Object update

Mandatory attributes for object update:

  • url

Optional attributes for object update:

  • push_events

  • issues_events

  • confidential_issues_events

  • merge_requests_events

  • tag_push_events

  • note_events

  • confidential_note_events

  • job_events

  • pipeline_events

  • wiki_page_events

  • deployment_events

  • releases_events

  • subgroup_events

  • enable_ssl_verification

  • token

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.hooks.GroupHook

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.hooks.GroupHook

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupImport(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupImportManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.export_import.GroupImport]

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.export_import.GroupImport]

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupIssue(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupIssueManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • state

  • labels

  • milestone

  • order_by

  • sort

  • iids

  • author_id

  • assignee_id

  • my_reaction_emoji

  • search

  • created_after

  • created_before

  • updated_after

  • updated_before

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupIssuesStatistics(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.RefreshMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupIssuesStatisticsManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.statistics.GroupIssuesStatistics]

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.statistics.GroupIssuesStatistics]

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupLabel(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SubscribableMixin, gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: GroupLabelManager
save(**kwargs: Any) → None

Saves the changes made to the object to the server.

The object is updated to match what the server returns.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

class gitlab.v4.objects.GroupLabelManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • name

  • color

Optional attributes:

  • description

  • priority

Object update

Mandatory attributes for object update:

  • name

Optional attributes for object update:

  • new_name

  • color

  • description

  • priority

Parameters
Return type

None

delete(name: str, **kwargs: Any) → None

Delete a Label on the server.

Parameters

  • name (str) – The name of the label

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

gitlab: gitlab.client.Gitlab
update(name: Optional[str], new_data: Optional[Dict[str, Any]] = None, **kwargs: Any) → Dict[str, Any]

Update a Label on the server.

Parameters

  • name (Optional[str]) – The name of the label

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • new_data (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

Dict[str, Any]

class gitlab.v4.objects.GroupManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object listing filters

  • skip_groups

  • all_available

  • search

  • order_by

  • sort

  • statistics

  • owned

  • with_custom_attributes

  • min_access_level

  • top_level_only

Object Creation

Mandatory attributes:

  • name

  • path

Optional attributes:

  • description

  • membership_lock

  • visibility

  • share_with_group_lock

  • require_two_factor_authentication

  • two_factor_grace_period

  • project_creation_level

  • auto_devops_enabled

  • subgroup_creation_level

  • emails_disabled

  • avatar

  • mentions_disabled

  • lfs_enabled

  • request_access_enabled

  • parent_id

  • default_branch_protection

  • shared_runners_minutes_limit

  • extra_shared_runners_minutes_limit

Object update

Optional attributes for object update:

  • name

  • path

  • description

  • membership_lock

  • share_with_group_lock

  • visibility

  • require_two_factor_authentication

  • two_factor_grace_period

  • project_creation_level

  • auto_devops_enabled

  • subgroup_creation_level

  • emails_disabled

  • avatar

  • mentions_disabled

  • lfs_enabled

  • request_access_enabled

  • default_branch_protection

  • file_template_project_id

  • shared_runners_minutes_limit

  • extra_shared_runners_minutes_limit

  • prevent_forking_outside_group

  • shared_runners_setting

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.groups.Group

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.groups.Group

gitlab: gitlab.client.Gitlab
import_group(file: BinaryIO, path: str, name: str, parent_id: Optional[str] = None, **kwargs: Any) → Union[Dict[str, Any], requests.models.Response]

Import a group from an archive file.

Parameters

  • file (BinaryIO) – Data or file object containing the group

  • path (str) – The path for the new group to be imported.

  • name (str) – The name for the new group.

  • parent_id (Optional[str]) – ID of a parent group that the group will be imported into.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A representation of the import status.

Return type

Union[Dict[str, Any], requests.models.Response]

class gitlab.v4.objects.GroupMember(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupMemberAll(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupMemberAllManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.members.GroupMemberAll

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.members.GroupMemberAll

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupMemberManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • access_level

  • user_id

Optional attributes:

  • expires_at

Object update

Mandatory attributes for object update:

  • access_level

Optional attributes for object update:

  • expires_at

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.members.GroupMember

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.members.GroupMember

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupMergeRequest(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupMergeRequestManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • state

  • order_by

  • sort

  • milestone

  • view

  • labels

  • created_after

  • created_before

  • updated_after

  • updated_before

  • scope

  • author_id

  • assignee_id

  • approver_ids

  • approved_by_ids

  • my_reaction_emoji

  • source_branch

  • target_branch

  • search

  • wip

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupMilestone(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

issues(**kwargs: Any) → gitlab.base.RESTObjectList

List issues related to this milestone.

Parameters

  • all – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

  • page – ID of the page to return (starts with page 1)

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The list of issues

Return type

gitlab.base.RESTObjectList

manager: gitlab.base.RESTManager
merge_requests(**kwargs: Any) → gitlab.base.RESTObjectList

List the merge requests related to this milestone.

Parameters

  • all – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

  • page – ID of the page to return (starts with page 1)

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The list of merge requests

Return type

gitlab.base.RESTObjectList

class gitlab.v4.objects.GroupMilestoneManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object listing filters

  • iids

  • state

  • search

Object Creation

Mandatory attributes:

  • title

Optional attributes:

  • description

  • due_date

  • start_date

Object update

Optional attributes for object update:

  • title

  • description

  • due_date

  • start_date

  • state_event

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.milestones.GroupMilestone

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.milestones.GroupMilestone

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupNotificationSettings(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.v4.objects.notification_settings.NotificationSettings

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupNotificationSettingsManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.v4.objects.notification_settings.NotificationSettingsManager

Object Creation

Object update

Optional attributes for object update:

  • level

  • notification_email

  • new_note

  • new_issue

  • reopen_issue

  • close_issue

  • reassign_issue

  • new_merge_request

  • reopen_merge_request

  • close_merge_request

  • reassign_merge_request

  • merge_merge_request

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.notification_settings.GroupNotificationSettings]

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.notification_settings.GroupNotificationSettings]

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupPackage(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupPackageManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • exclude_subgroups

  • order_by

  • sort

  • package_type

  • package_name

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupProject(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupProjectManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • archived

  • visibility

  • order_by

  • sort

  • search

  • simple

  • owned

  • starred

  • with_custom_attributes

  • include_subgroups

  • with_issues_enabled

  • with_merge_requests_enabled

  • with_shared

  • min_access_level

  • with_security_reports

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupRunner(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupRunnerManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • scope

  • tag_list

Object Creation

Mandatory attributes:

  • runner_id

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupSubgroup(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupSubgroupManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • skip_groups

  • all_available

  • search

  • order_by

  • sort

  • statistics

  • owned

  • with_custom_attributes

  • min_access_level

Object Creation

Object update

Parameters
Return type

None

class gitlab.v4.objects.GroupVariable(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupVariableManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • key

  • value

Optional attributes:

  • protected

  • variable_type

  • masked

Object update

Mandatory attributes for object update:

  • key

  • value

Optional attributes for object update:

  • protected

  • variable_type

  • masked

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.variables.GroupVariable

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.variables.GroupVariable

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.GroupWiki(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.GroupWikiManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object listing filters

  • with_content

Object Creation

Mandatory attributes:

  • title

  • content

Optional attributes:

  • format

Object update

Optional attributes for object update:

  • title

  • content

  • format

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.wikis.GroupWiki

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.wikis.GroupWiki

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.Hook(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.HookManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • url

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.hooks.Hook

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.hooks.Hook

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.Issue(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.IssueManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object listing filters

  • state

  • labels

  • milestone

  • scope

  • author_id

  • assignee_id

  • my_reaction_emoji

  • iids

  • order_by

  • sort

  • search

  • created_after

  • created_before

  • updated_after

  • updated_before

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.issues.Issue

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.issues.Issue

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.IssuesStatistics(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.RefreshMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.IssuesStatisticsManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.statistics.IssuesStatistics]

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.statistics.IssuesStatistics]

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.Key(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.KeyManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.GetMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.keys.Key

Retrieve a single object.

Parameters

  • id (Optional[Union[int, str]]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.keys.Key

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.LDAPGroup(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.LDAPGroupManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.base.RESTManager

Object listing filters

  • search

  • provider

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
list(**kwargs: Any) → Union[List[gitlab.v4.objects.ldap.LDAPGroup], gitlab.base.RESTObjectList]

Retrieve a list of objects.

Parameters

  • all – If True, return all the items, without pagination

  • per_page – Number of items to retrieve per request

  • page – ID of the page to return (starts with page 1)

  • as_list – If set to False and no pagination option is defined, return a generator instead of a list

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The list of objects, or a generator if as_list is False

Raises
Return type

Union[List[gitlab.v4.objects.ldap.LDAPGroup], gitlab.base.RESTObjectList]

class gitlab.v4.objects.License(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.LicenseManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object listing filters

  • popular

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.templates.License

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.templates.License

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.MergeRequest(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.MergeRequestManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • state

  • order_by

  • sort

  • milestone

  • view

  • labels

  • with_labels_details

  • with_merge_status_recheck

  • created_after

  • created_before

  • updated_after

  • updated_before

  • scope

  • author_id

  • author_username

  • assignee_id

  • approver_ids

  • approved_by_ids

  • reviewer_id

  • reviewer_username

  • my_reaction_emoji

  • source_branch

  • target_branch

  • search

  • in

  • wip

  • not

  • environment

  • deployed_before

  • deployed_after

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.Namespace(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.NamespaceManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object listing filters

  • search

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.namespaces.Namespace

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.namespaces.Namespace

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.NotificationSettings(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.NotificationSettingsManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.mixins.UpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Optional attributes for object update:

  • level

  • notification_email

  • new_note

  • new_issue

  • reopen_issue

  • close_issue

  • reassign_issue

  • new_merge_request

  • reopen_merge_request

  • close_merge_request

  • reassign_merge_request

  • merge_merge_request

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.notification_settings.NotificationSettings]

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.notification_settings.NotificationSettings]

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.PagesDomain(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.PagesDomainManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.PersonalAccessToken(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.PersonalAccessTokenManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.DeleteMixin, gitlab.mixins.ListMixin, gitlab.base.RESTManager

Object listing filters

  • user_id

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.Project(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.RefreshMixin, gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.v4.objects.repositories.RepositoryMixin, gitlab.base.RESTObject

Parameters
Return type

None

access_tokens: gitlab.v4.objects.project_access_tokens.ProjectAccessTokenManager
accessrequests: gitlab.v4.objects.access_requests.ProjectAccessRequestManager
additionalstatistics: gitlab.v4.objects.statistics.ProjectAdditionalStatisticsManager
approvalrules: gitlab.v4.objects.merge_request_approvals.ProjectApprovalRuleManager
approvals: gitlab.v4.objects.merge_request_approvals.ProjectApprovalManager
archive(**kwargs: Any) → None

Archive a project.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

artifact(ref_name: str, artifact_path: str, job: str, streamed: bool = False, action: Optional[Callable] = None, chunk_size: int = 1024, **kwargs: Any) → Optional[bytes]

Download a single artifact file from a specific tag or branch from within the job’s artifacts archive.

Parameters

  • ref_name (str) – Branch or tag name in repository. HEAD or SHA references are not supported.

  • artifact_path (str) – Path to a file inside the artifacts archive.

  • job (str) – The name of the job.

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment

  • action (Optional[Callable]) – Callable responsible of dealing with chunk of data

  • chunk_size (int) – Size of each chunk

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The artifacts if streamed is False, None otherwise.

Return type

Optional[bytes]

artifacts(ref_name: str, job: str, streamed: bool = False, action: Optional[Callable] = None, chunk_size: int = 1024, **kwargs: Any) → Optional[bytes]

Get the job artifacts archive from a specific tag or branch.

Parameters

  • ref_name (str) – Branch or tag name in repository. HEAD or SHA references

  • supported. (are not) –

  • artifact_path – Path to a file inside the artifacts archive.

  • job (str) – The name of the job.

  • job_token – Job token for multi-project pipeline triggers.

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment

  • action (Optional[Callable]) – Callable responsible of dealing with chunk of data

  • chunk_size (int) – Size of each chunk

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The artifacts if streamed is False, None otherwise.

Return type

Optional[bytes]

audit_events: gitlab.v4.objects.audit_events.ProjectAuditEventManager
badges: gitlab.v4.objects.badges.ProjectBadgeManager
boards: gitlab.v4.objects.boards.ProjectBoardManager
branches: gitlab.v4.objects.branches.ProjectBranchManager
clusters: gitlab.v4.objects.clusters.ProjectClusterManager
commits: gitlab.v4.objects.commits.ProjectCommitManager
create_fork_relation(forked_from_id: int, **kwargs: Any) → None

Create a forked from/to relation between existing projects.

Parameters

  • forked_from_id (int) – The ID of the project that was forked from

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

customattributes: gitlab.v4.objects.custom_attributes.ProjectCustomAttributeManager
delete_fork_relation(**kwargs: Any) → None

Delete a forked relation between existing projects.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

deployments: gitlab.v4.objects.deployments.ProjectDeploymentManager
deploytokens: gitlab.v4.objects.deploy_tokens.ProjectDeployTokenManager
environments: gitlab.v4.objects.environments.ProjectEnvironmentManager
events: gitlab.v4.objects.events.ProjectEventManager
exports: gitlab.v4.objects.export_import.ProjectExportManager
files: gitlab.v4.objects.files.ProjectFileManager
forks: ProjectForkManager
generic_packages: gitlab.v4.objects.packages.GenericPackageManager
groups: gitlab.v4.objects.projects.ProjectGroupManager
hooks: gitlab.v4.objects.hooks.ProjectHookManager
housekeeping(**kwargs: Any) → None

Start the housekeeping task.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

imports: gitlab.v4.objects.export_import.ProjectImportManager
issues: gitlab.v4.objects.issues.ProjectIssueManager
issues_statistics: gitlab.v4.objects.statistics.ProjectIssuesStatisticsManager
jobs: gitlab.v4.objects.jobs.ProjectJobManager
keys: gitlab.v4.objects.deploy_keys.ProjectKeyManager
labels: gitlab.v4.objects.labels.ProjectLabelManager
languages(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]

Get languages used in the project with percentage value.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

Union[Dict[str, Any], requests.models.Response]

members: gitlab.v4.objects.members.ProjectMemberManager
members_all: gitlab.v4.objects.members.ProjectMemberAllManager
merge_trains: gitlab.v4.objects.merge_trains.ProjectMergeTrainManager
mergerequests: gitlab.v4.objects.merge_requests.ProjectMergeRequestManager
milestones: gitlab.v4.objects.milestones.ProjectMilestoneManager
mirror_pull(**kwargs: Any) → None

Start the pull mirroring process for the project.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

notes: gitlab.v4.objects.notes.ProjectNoteManager
notificationsettings: gitlab.v4.objects.notification_settings.ProjectNotificationSettingsManager
packages: gitlab.v4.objects.packages.ProjectPackageManager
pagesdomains: gitlab.v4.objects.pages.ProjectPagesDomainManager
pipelines: gitlab.v4.objects.pipelines.ProjectPipelineManager
pipelineschedules: gitlab.v4.objects.pipelines.ProjectPipelineScheduleManager
protectedbranches: gitlab.v4.objects.branches.ProjectProtectedBranchManager
protectedtags: gitlab.v4.objects.tags.ProjectProtectedTagManager
pushrules: gitlab.v4.objects.push_rules.ProjectPushRulesManager
releases: gitlab.v4.objects.releases.ProjectReleaseManager
remote_mirrors: ProjectRemoteMirrorManager
repositories: gitlab.v4.objects.container_registry.ProjectRegistryRepositoryManager
runners: gitlab.v4.objects.runners.ProjectRunnerManager
search(scope: str, search: str, **kwargs: Any) → Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

Search the project resources matching the provided string.’

Parameters

  • scope (str) – Scope of the search

  • search (str) – Search string

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

A list of dicts describing the resources found.

Return type

Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

services: gitlab.v4.objects.services.ProjectServiceManager
share(group_id: int, group_access: int, expires_at: Optional[str] = None, **kwargs: Any) → None

Share the project with a group.

Parameters

  • group_id (int) – ID of the group.

  • group_access (int) – Access level for the group.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • expires_at (Optional[str]) –

  • kwargs (Any) –

Raises
Return type

None

snapshot(wiki: bool = False, streamed: bool = False, action: Optional[Callable] = None, chunk_size: int = 1024, **kwargs: Any) → Optional[bytes]

Return a snapshot of the repository.

Parameters

  • wiki (bool) – If True return the wiki repository

  • streamed (bool) – If True the data will be processed by chunks of chunk_size and each chunk is passed to action for treatment.

  • action (Optional[Callable]) – Callable responsible of dealing with chunk of data

  • chunk_size (int) – Size of each chunk

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The uncompressed tar archive of the repository

Return type

Optional[bytes]

snippets: gitlab.v4.objects.snippets.ProjectSnippetManager
star(**kwargs: Any) → None

Star a project.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

tags: gitlab.v4.objects.tags.ProjectTagManager
transfer(to_namespace: Union[int, str], **kwargs: Any) → None

Transfer a project to the given namespace ID

Parameters

  • to_namespace (Union[int, str]) – ID or path of the namespace to transfer the

  • to (project) –

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

transfer_project(*args: Any, **kwargs: Any) → None
Parameters

  • args (Any) –

  • kwargs (Any) –

Return type

None

trigger_pipeline(ref: str, token: str, variables: Optional[Dict[str, Any]] = None, **kwargs: Any) → gitlab.v4.objects.pipelines.ProjectPipeline

Trigger a CI build.

See https://gitlab.com/help/ci/triggers/README.md#trigger-a-build

Parameters

  • ref (str) – Commit to build; can be a branch name or a tag

  • token (str) – The trigger token

  • variables (Optional[Dict[str, Any]]) – Variables passed to the build script

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

gitlab.v4.objects.pipelines.ProjectPipeline

triggers: gitlab.v4.objects.triggers.ProjectTriggerManager
unarchive(**kwargs: Any) → None

Unarchive a project.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

unshare(group_id: int, **kwargs: Any) → None

Delete a shared project link within a group.

Parameters

  • group_id (int) – ID of the group.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

unstar(**kwargs: Any) → None

Unstar a project.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

upload(filename: str, filedata: Optional[bytes] = None, filepath: Optional[str] = None, **kwargs: Any) → Dict[str, Any]

Upload the specified file into the project.

Note

Either filedata or filepath MUST be specified.

Parameters

  • filename (str) – The name of the file being uploaded

  • filedata (Optional[bytes]) – The raw data of the file being uploaded

  • filepath (Optional[str]) – The path to a local file to upload (optional)

  • kwargs (Any) –

Raises
Returns

  • alt - The alternate text for the upload

  • url - The direct url to the uploaded file

  • markdown - Markdown for the uploaded file

Return type

A dict with the keys

users: gitlab.v4.objects.users.ProjectUserManager
variables: gitlab.v4.objects.variables.ProjectVariableManager
wikis: gitlab.v4.objects.wikis.ProjectWikiManager
class gitlab.v4.objects.ProjectAccessRequest(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.AccessRequestMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectAccessRequestManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectAdditionalStatistics(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.RefreshMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectAdditionalStatisticsManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.statistics.ProjectAdditionalStatistics]

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.statistics.ProjectAdditionalStatistics]

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectApproval(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectApprovalManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.GetWithoutIdMixin, gitlab.mixins.UpdateMixin, gitlab.base.RESTManager

Object Creation

Object update

Optional attributes for object update:

  • approvals_before_merge

  • reset_approvals_on_push

  • disable_overriding_approvers_per_merge_request

  • merge_requests_author_approval

  • merge_requests_disable_committers_approval

Parameters
Return type

None

get(id: Optional[Union[int, str]] = None, **kwargs: Any) → Optional[gitlab.v4.objects.merge_request_approvals.ProjectApproval]

Retrieve a single object.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • id (Optional[Union[int, str]]) –

  • kwargs (Any) –

Returns

The generated RESTObject

Raises
Return type

Optional[gitlab.v4.objects.merge_request_approvals.ProjectApproval]

gitlab: gitlab.client.Gitlab
set_approvers(approver_ids: Optional[List[int]] = None, approver_group_ids: Optional[List[int]] = None, **kwargs: Any) → Dict[str, Any]

Change project-level allowed approvers and approver groups.

Parameters

  • approver_ids (Optional[List[int]]) – User IDs that can approve MRs

  • approver_group_ids (Optional[List[int]]) – Group IDs whose members can approve MRs

  • kwargs (Any) –

Raises
Returns

A dict value of the result

Return type

Dict[str, Any]

class gitlab.v4.objects.ProjectApprovalRule(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectApprovalRuleManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • name

  • approvals_required

Optional attributes:

  • user_ids

  • group_ids

  • protected_branch_ids

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectAudit(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.v4.objects.audit_events.ProjectAuditEvent

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectAuditEvent(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectAuditEventManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.base.RESTManager

Object listing filters

  • created_after

  • created_before

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.audit_events.ProjectAuditEvent

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.audit_events.ProjectAuditEvent

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectAuditManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.v4.objects.audit_events.ProjectAuditEventManager

Object listing filters

  • created_after

  • created_before

Object Creation

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectBadge(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectBadgeManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.BadgeRenderMixin, gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • link_url

  • image_url

Object update

Optional attributes for object update:

  • link_url

  • image_url

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.badges.ProjectBadge

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.badges.ProjectBadge

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectBoard(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

lists: gitlab.v4.objects.boards.ProjectBoardListManager
class gitlab.v4.objects.ProjectBoardList(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectBoardListManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • label_id

Object update

Mandatory attributes for object update:

  • position

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.boards.ProjectBoardList

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.boards.ProjectBoardList

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectBoardManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • name

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.boards.ProjectBoard

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.boards.ProjectBoard

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectBranch(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectBranchManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.NoUpdateMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • branch

  • ref

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.branches.ProjectBranch

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.branches.ProjectBranch

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectCluster(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectClusterManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.CRUDMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • name

  • platform_kubernetes_attributes

Optional attributes:

  • domain

  • enabled

  • managed

  • environment_scope

Object update

Optional attributes for object update:

  • name

  • domain

  • management_project_id

  • platform_kubernetes_attributes

  • environment_scope

Parameters
Return type

None

create(data: Optional[Dict[str, Any]] = None, **kwargs: Any) → gitlab.v4.objects.clusters.ProjectCluster

Create a new object.

Parameters

  • data (Optional[Dict[str, Any]]) – Parameters to send to the server to create the resource

  • **kwargs – Extra options to send to the server (e.g. sudo or ‘ref_name’, ‘stage’, ‘name’, ‘all’)

  • kwargs (Any) –

Raises
Returns

A new instance of the manage object class build with

the data sent by the server

Return type

gitlab.v4.objects.clusters.ProjectCluster

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.clusters.ProjectCluster

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.clusters.ProjectCluster

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectCommit(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

cherry_pick(branch: str, **kwargs: Any) → None

Cherry-pick a commit into a branch.

Parameters

  • branch (str) – Name of target branch

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Return type

None

comments: ProjectCommitCommentManager
diff(**kwargs: Any) → Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

Generate the commit diff.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The changes done in this commit

Return type

Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

discussions: gitlab.v4.objects.discussions.ProjectCommitDiscussionManager
merge_requests(**kwargs: Any) → Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

List the merge requests related to the commit.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The merge requests related to the commit.

Return type

Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

refs(type: str = 'all', **kwargs: Any) → Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

List the references the commit is pushed to.

Parameters

  • type (str) – The scope of references (‘branch’, ‘tag’ or ‘all’)

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The references the commit is pushed to.

Return type

Union[gitlab.client.GitlabList, List[Dict[str, Any]]]

revert(branch: str, **kwargs: Any) → Union[Dict[str, Any], requests.models.Response]

Revert a commit on a given branch.

Parameters

  • branch (str) – Name of target branch

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The new commit data (not a RESTObject)

Return type

Union[Dict[str, Any], requests.models.Response]

signature(**kwargs: Any) → Union[Dict[str, Any], requests.models.Response]

Get the signature of the commit.

Parameters

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Raises
Returns

The commit’s signature data

Return type

Union[Dict[str, Any], requests.models.Response]

statuses: ProjectCommitStatusManager
class gitlab.v4.objects.ProjectCommitComment(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectCommitCommentManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • note

Optional attributes:

  • path

  • line

  • line_type

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectCommitDiscussion(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.base.RESTObject

Parameters
Return type

None

notes: gitlab.v4.objects.notes.ProjectCommitDiscussionNoteManager
class gitlab.v4.objects.ProjectCommitDiscussionManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • body

Optional attributes:

  • created_at

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.discussions.ProjectCommitDiscussion

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.discussions.ProjectCommitDiscussion

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectCommitDiscussionNote(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectCommitDiscussionNoteManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.GetMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • body

Optional attributes:

  • created_at

  • position

Object update

Mandatory attributes for object update:

  • body

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.notes.ProjectCommitDiscussionNote

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.notes.ProjectCommitDiscussionNote

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectCommitManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • branch

  • commit_message

  • actions

Optional attributes:

  • author_email

  • author_name

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.commits.ProjectCommit

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.commits.ProjectCommit

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectCommitStatus(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.RefreshMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectCommitStatusManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • state

Optional attributes:

  • description

  • name

  • context

  • ref

  • target_url

  • coverage

Object update

Parameters
Return type

None

create(data: Optional[Dict[str, Any]] = None, **kwargs: Any) → gitlab.v4.objects.commits.ProjectCommitStatus

Create a new object.

Parameters

  • data (Optional[Dict[str, Any]]) – Parameters to send to the server to create the resource

  • **kwargs – Extra options to send to the server (e.g. sudo or ‘ref_name’, ‘stage’, ‘name’, ‘all’)

  • kwargs (Any) –

Raises
Returns

A new instance of the manage object class build with

the data sent by the server

Return type

gitlab.v4.objects.commits.ProjectCommitStatus

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectCustomAttribute(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectCustomAttributeManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.SetMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.custom_attributes.ProjectCustomAttribute

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.custom_attributes.ProjectCustomAttribute

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectDeployToken(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.ObjectDeleteMixin, gitlab.base.RESTObject

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectDeployTokenManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.ListMixin, gitlab.mixins.CreateMixin, gitlab.mixins.DeleteMixin, gitlab.base.RESTManager

Object Creation

Mandatory attributes:

  • name

  • scopes

Optional attributes:

  • expires_at

  • username

Object update

Parameters
Return type

None

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectDeployment(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.mixins.SaveMixin, gitlab.base.RESTObject

Parameters
Return type

None

mergerequests: gitlab.v4.objects.merge_requests.ProjectDeploymentMergeRequestManager
class gitlab.v4.objects.ProjectDeploymentManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.mixins.RetrieveMixin, gitlab.mixins.CreateMixin, gitlab.mixins.UpdateMixin, gitlab.base.RESTManager

Object listing filters

  • order_by

  • sort

  • updated_after

  • updated_before

  • environment

  • status

Object Creation

Mandatory attributes:

  • sha

  • ref

  • tag

  • status

  • environment

Object update

Parameters
Return type

None

get(id: Union[str, int], lazy: bool = False, **kwargs: Any) → gitlab.v4.objects.deployments.ProjectDeployment

Retrieve a single object.

Parameters

  • id (Union[str, int]) – ID of the object to retrieve

  • lazy (bool) – If True, don’t request the server, but create a shallow object giving access to the managers. This is useful if you want to avoid useless calls to the API.

  • **kwargs – Extra options to send to the server (e.g. sudo)

  • kwargs (Any) –

Returns

The generated RESTObject.

Raises
Return type

gitlab.v4.objects.deployments.ProjectDeployment

gitlab: gitlab.client.Gitlab
class gitlab.v4.objects.ProjectDeploymentMergeRequest(manager: gitlab.base.RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: gitlab.v4.objects.merge_requests.MergeRequest

Parameters
Return type

None

manager: gitlab.base.RESTManager
class gitlab.v4.objects.ProjectDeploymentMergeRequestManager(gl: gitlab.client.Gitlab, parent: Optional[gitlab.base.RESTObject] = None)

Bases: gitlab.v4.objects.merge_requests.MergeRequestManager

Object listing filters

  • state

  • order_by

  • sort

  • milestone

  • view

  • labels

  • with_labels_details

  • with_merge_status_recheck

  • created_after

  • created_before

  • updated_after

  • updated_before

  • scope

  • author_id

  • author_username

  • assignee_id

  • approver_ids

  • approved_by_ids

  • reviewer_id

  • reviewer_username

  • <