table of contents
| PYTHON-GITLAB(1) | User Commands | PYTHON-GITLAB(1) |
NAME¶
python-gitlab - GitLab API Command Line Interface
DESCRIPTION¶
usage: python-gitlab [-h] [--version] [-v] [-d] [-c CONFIG_FILE] [-g GITLAB]
- [-o {json,legacy,yaml}] [-f FIELDS]
- [--server-url SERVER_URL] [--ssl-verify SSL_VERIFY | --no-ssl-verify] [--timeout TIMEOUT] [--api-version API_VERSION] [--per-page PER_PAGE] [--pagination PAGINATION] [--order-by ORDER_BY] [--user-agent USER_AGENT] [--private-token PRIVATE_TOKEN | --oauth-token OAUTH_TOKEN | --job-token JOB_TOKEN] [--skip-login] [--no-mask-credentials] <resource> ...
GitLab API Command Line Interface
options:¶
- -h, --help
- show this help message and exit
- --version
- Display the version.
- -v, --verbose, --fancy
- Verbose mode (legacy format only) [env var: GITLAB_VERBOSE]
- -d, --debug
- Debug mode (display HTTP requests) [env var: GITLAB_DEBUG]
- -c, --config-file CONFIG_FILE
- Configuration file to use. Can be used multiple times. [env var: PYTHON_GITLAB_CFG]
- -g, --gitlab GITLAB
- Which configuration section should be used. If not defined, the default selection will be used.
- -o, --output {json,legacy,yaml}
- Output format (v4 only): json|legacy|yaml
- -f, --fields FIELDS
- Fields to display in the output (comma separated). Not used with legacy output
- --server-url SERVER_URL
- GitLab server URL [env var: GITLAB_URL]
- --ssl-verify SSL_VERIFY
- Path to a CA_BUNDLE file or directory with certificates of trusted CAs. [env var: GITLAB_SSL_VERIFY]
- --no-ssl-verify
- Disable SSL verification
- --timeout TIMEOUT
- Timeout to use for requests to the GitLab server. [env var: GITLAB_TIMEOUT]
- --api-version API_VERSION
- GitLab API version [env var: GITLAB_API_VERSION]
- --per-page PER_PAGE
- Number of entries to return per page in the response. [env var: GITLAB_PER_PAGE]
- --pagination PAGINATION
- Whether to use keyset or offset pagination [env var: GITLAB_PAGINATION]
- --order-by ORDER_BY
- Set order_by globally [env var: GITLAB_ORDER_BY]
- --user-agent USER_AGENT
- The user agent to send to GitLab with the HTTP request. [env var: GITLAB_USER_AGENT]
- --private-token PRIVATE_TOKEN
- GitLab private access token [env var: GITLAB_PRIVATE_TOKEN]
- --oauth-token OAUTH_TOKEN
- GitLab OAuth token [env var: GITLAB_OAUTH_TOKEN]
- --job-token JOB_TOKEN
- GitLab CI job token [env var: CI_JOB_TOKEN]
- --skip-login
- Skip initial authenticated API call to the current user endpoint. This may be useful when invoking the CLI in scripts. [env var: GITLAB_SKIP_LOGIN]
- --no-mask-credentials
- Don't mask credentials in debug mode
resource:¶
- <resource>
- The GitLab resource to manipulate.
- application
- API endpoint: /applications
- application-appearance
- API endpoint: /application/appearance
- application-settings
- API endpoint: /application/settings
- application-statistics
- API endpoint: /application/statistics
- audit-event
- API endpoint: /audit_events
- broadcast-message
- API endpoint: /broadcast_messages
- bulk-import
- API endpoint: /bulk_imports
- bulk-import-all-entity
- API endpoint: /bulk_imports/entities
- bulk-import-entity
- API endpoint: /bulk_imports/{bulk_import_id}/entities
- ci-lint
- API endpoint: /ci/lint
- current-user
- API endpoint: /user
- current-user-email
- API endpoint: /user/emails
- current-user-gpg-key
- API endpoint: /user/gpg_keys
- current-user-key
- API endpoint: /user/keys
- current-user-runner
- API endpoint: /user/runners
- current-user-status
- API endpoint: /user/status
- deploy-key
- API endpoint: /deploy_keys
- deploy-token
- API endpoint: /deploy_tokens
- dockerfile
- API endpoint: /templates/dockerfiles
- event
- API endpoint: /events
- feature
- API endpoint: /features/
- generic-package
- API endpoint: /projects/{project_id}/packages/generic
- geo-node
- API endpoint: /geo_nodes
- gitignore
- API endpoint: /templates/gitignores
- gitlabciyml
- API endpoint: /templates/gitlab_ci_ymls
- group
- API endpoint: /groups
- group-access-request
- API endpoint: /groups/{group_id}/access_requests
- group-access-token
- API endpoint: /groups/{group_id}/access_tokens
- group-approval-rule
- API endpoint: /groups/{group_id}/approval_rules
- group-audit-event
- API endpoint: /groups/{group_id}/audit_events
- group-badge
- API endpoint: /groups/{group_id}/badges
- group-billable-member
- API endpoint: /groups/{group_id}/billable_members
- group-billable-member-membership
- API endpoint: /groups/{group_id}/billable_members/{use r_id}/memberships
- group-board
- API endpoint: /groups/{group_id}/boards
- group-board-list
- API endpoint: /groups/{group_id}/boards/{board_id}/lists
- group-cluster
- API endpoint: /groups/{group_id}/clusters
- group-custom-attribute
- API endpoint: /groups/{group_id}/custom_attributes
- group-deploy-token
- API endpoint: /groups/{group_id}/deploy_tokens
- group-descendant-group
- API endpoint: /groups/{group_id}/descendant_groups
- group-epic
- API endpoint: /groups/{group_id}/epics
- group-epic-award-emoji
- API endpoint: /groups/{group_id}/epics/{epic_iid}/award_emoji
- group-epic-discussion-note
- API endpoint: /groups/{group_id}/epics/{epic_id}/discu ssions/{discussion_id}/notes
- group-epic-issue
- API endpoint: /groups/{group_id}/epics/{epic_iid}/issues
- group-epic-note
- API endpoint: /groups/{group_id}/epics/{epic_id}/notes
- group-epic-note-award-emoji
- API endpoint: /groups/{group_id}/epics/{epic_iid}/note s/{note_id}/award_emoji
- group-epic-resource-label-event
- API endpoint: /groups/{group_id}/epics/{epic_id}/resou rce_label_events
- group-export
- API endpoint: /groups/{group_id}/export
- group-hook
- API endpoint: /groups/{group_id}/hooks
- group-import
- API endpoint: /groups/{group_id}/import
- group-invitation
- API endpoint: /groups/{group_id}/invitations
- group-issue
- API endpoint: /groups/{group_id}/issues
- group-issues-statistics
- API endpoint: /groups/{group_id}/issues_statistics
- group-iteration
- API endpoint: /groups/{group_id}/iterations
- group-ldap-group-link
- API endpoint: /groups/{group_id}/ldap_group_links
- group-label
- API endpoint: /groups/{group_id}/labels
- group-member
- API endpoint: /groups/{group_id}/members
- group-member-all
- API endpoint: /groups/{group_id}/members/all
- group-member-role
- API endpoint: /groups/{group_id}/member_roles
- group-merge-request
- API endpoint: /groups/{group_id}/merge_requests
- group-milestone
- API endpoint: /groups/{group_id}/milestones
- group-notification-settings
- API endpoint: /groups/{group_id}/notification_settings
- group-package
- API endpoint: /groups/{group_id}/packages
- group-project
- API endpoint: /groups/{group_id}/projects
- group-push-rules
- API endpoint: /groups/{group_id}/push_rule
- group-runner
- API endpoint: /groups/{group_id}/runners
- group-saml-group-link
- API endpoint: /groups/{group_id}/saml_group_links
- group-service-account
- API endpoint: /groups/{group_id}/service_accounts
- group-service-account-access-token
- API endpoint: /groups/{group_id}/service_accounts/{use r_id}/personal_access_tokens
- group-subgroup
- API endpoint: /groups/{group_id}/subgroups
- group-variable
- API endpoint: /groups/{group_id}/variables
- group-wiki
- API endpoint: /groups/{group_id}/wikis
- hook
- API endpoint: /hooks
- issue
- API endpoint: /issues
- issues-statistics
- API endpoint: /issues_statistics
- key
- API endpoint: /keys
- ldap-group
- API endpoint: /ldap/groups
- license
- API endpoint: /templates/licenses
- member-role
- API endpoint: /member_roles
- merge-request
- API endpoint: /merge_requests
- namespace
- API endpoint: /namespaces
- notification-settings
- API endpoint: /notification_settings
- pages-domain
- API endpoint: /pages/domains
- personal-access-token
- API endpoint: /personal_access_tokens
- project
- API endpoint: /projects
- project-access-request
- API endpoint: /projects/{project_id}/access_requests
- project-access-token
- API endpoint: /projects/{project_id}/access_tokens
- project-additional-statistics
- API endpoint: /projects/{project_id}/statistics
- project-approval
- API endpoint: /projects/{project_id}/approvals
- project-approval-rule
- API endpoint: /projects/{project_id}/approval_rules
- project-artifact
- API endpoint: /projects/{project_id}/jobs/artifacts
- project-audit-event
- API endpoint: /projects/{project_id}/audit_events
- project-badge
- API endpoint: /projects/{project_id}/badges
- project-board
- API endpoint: /projects/{project_id}/boards
- project-board-list
- API endpoint: /projects/{project_id}/boards/{board_id}/lists
- project-branch
- API endpoint: /projects/{project_id}/repository/branches
- project-ci-lint
- API endpoint: /projects/{project_id}/ci/lint
- project-cluster
- API endpoint: /projects/{project_id}/clusters
- project-cluster-agent
- API endpoint: /projects/{project_id}/cluster_agents
- project-commit
- API endpoint: /projects/{project_id}/repository/commits
- project-commit-comment
- API endpoint: /projects/{project_id}/repository/commit s/{commit_id}/comments
- project-commit-discussion
- API endpoint: /projects/{project_id}/repository/commit s/{commit_id}/discussions
- project-commit-discussion-note
- API endpoint: /projects/{project_id}/repository/commit s/{commit_id}/discussions/{discussion_id}/notes
- project-commit-status
- API endpoint: /projects/{project_id}/repository/commit s/{commit_id}/statuses
- project-custom-attribute
- API endpoint: /projects/{project_id}/custom_attributes
- project-deploy-token
- API endpoint: /projects/{project_id}/deploy_tokens
- project-deployment
- API endpoint: /projects/{project_id}/deployments
- project-deployment-merge-request
- API endpoint: /projects/{project_id}/deployments/{depl oyment_id}/merge_requests
- project-dockerfile-template
- API endpoint: /projects/{project_id}/templates/dockerfiles
- project-environment
- API endpoint: /projects/{project_id}/environments
- project-event
- API endpoint: /projects/{project_id}/events
- project-export
- API endpoint: /projects/{project_id}/export
- project-external-status-check
- API endpoint: /projects/{project_id}/external_status_checks
- project-feature-flag
- API endpoint: /projects/{project_id}/feature_flags
- project-feature-flag-user-list
- API endpoint: /projects/{project_id}/feature_flags_user_lists
- project-file
- API endpoint: /projects/{project_id}/repository/files
- project-fork
- API endpoint: /projects/{project_id}/forks
- project-gitignore-template
- API endpoint: /projects/{project_id}/templates/gitignores
- project-gitlabciyml-template
- API endpoint: /projects/{project_id}/templates/gitlab_ci_ymls
- project-hook
- API endpoint: /projects/{project_id}/hooks
- project-import
- API endpoint: /projects/{project_id}/import
- project-integration
- API endpoint: /projects/{project_id}/integrations
- project-invitation
- API endpoint: /projects/{project_id}/invitations
- project-issue
- API endpoint: /projects/{project_id}/issues
- project-issue-award-emoji
- API endpoint: /projects/{project_id}/issues/{issue_iid}/award_emoji
- project-issue-discussion
- API endpoint: /projects/{project_id}/issues/{issue_iid}/discussions
- project-issue-discussion-note
- API endpoint: /projects/{project_id}/issues/{issue_iid }/discussions/{discussion_id}/notes
- project-issue-link
- API endpoint: /projects/{project_id}/issues/{issue_iid}/links
- project-issue-note
- API endpoint: /projects/{project_id}/issues/{issue_iid}/notes
- project-issue-note-award-emoji
- API endpoint: /projects/{project_id}/issues/{issue_iid }/notes/{note_id}/award_emoji
- project-issue-resource-iteration-event
- API endpoint: /projects/{project_id}/issues/{issue_iid }/resource_iteration_events
- project-issue-resource-label-event
- API endpoint: /projects/{project_id}/issues/{issue_iid }/resource_label_events
- project-issue-resource-milestone-event
- API endpoint: /projects/{project_id}/issues/{issue_iid }/resource_milestone_events
- project-issue-resource-state-event
- API endpoint: /projects/{project_id}/issues/{issue_iid }/resource_state_events
- project-issue-resource-weight-event
- API endpoint: /projects/{project_id}/issues/{issue_iid }/resource_weight_events
- project-issue-template
- API endpoint: /projects/{project_id}/templates/issues
- project-issues-statistics
- API endpoint: /projects/{project_id}/issues_statistics
- project-job
- API endpoint: /projects/{project_id}/jobs
- project-job-token-scope
- API endpoint: /projects/{project_id}/job_token_scope
- project-key
- API endpoint: /projects/{project_id}/deploy_keys
- project-label
- API endpoint: /projects/{project_id}/labels
- project-license-template
- API endpoint: /projects/{project_id}/templates/licenses
- project-member
- API endpoint: /projects/{project_id}/members
- project-member-all
- API endpoint: /projects/{project_id}/members/all
- project-merge-request
- API endpoint: /projects/{project_id}/merge_requests
- project-merge-request-approval
- API endpoint: /projects/{project_id}/merge_requests/{m r_iid}/approvals
- project-merge-request-approval-rule
- API endpoint: /projects/{project_id}/merge_requests/{m erge_request_iid}/approval_rules
- project-merge-request-approval-state
- API endpoint: /projects/{project_id}/merge_requests/{m r_iid}/approval_state
- project-merge-request-award-emoji
- API endpoint: /projects/{project_id}/merge_requests/{m r_iid}/award_emoji
- project-merge-request-diff
- API endpoint: /projects/{project_id}/merge_requests/{m r_iid}/versions
- project-merge-request-discussion
- API endpoint: /projects/{project_id}/merge_requests/{m r_iid}/discussions
- project-merge-request-discussion-note
- API endpoint: /projects/{project_id}/merge_requests/{m r_iid}/discussions/{discussion_id}/notes
- project-merge-request-draft-note
- API endpoint: /projects/{project_id}/merge_requests/{m r_iid}/draft_notes
- project-merge-request-note
- API endpoint: /projects/{project_id}/merge_requests/{mr_iid}/notes
- project-merge-request-note-award-emoji
- API endpoint: /projects/{project_id}/merge_requests/{m r_iid}/notes/{note_id}/award_emoji
- project-merge-request-pipeline
- API endpoint: /projects/{project_id}/merge_requests/{m r_iid}/pipelines
- project-merge-request-resource-label-event
- API endpoint: /projects/{project_id}/merge_requests/{m r_iid}/resource_label_events
- project-merge-request-resource-milestone-event
- API endpoint: /projects/{project_id}/merge_requests/{m r_iid}/resource_milestone_events
- project-merge-request-resource-state-event
- API endpoint: /projects/{project_id}/merge_requests/{m r_iid}/resource_state_events
- project-merge-request-reviewer-detail
- API endpoint: /projects/{project_id}/merge_requests/{m r_iid}/reviewers
- project-merge-request-status-check
- API endpoint: /projects/{project_id}/merge_requests/{m erge_request_iid}/status_checks
- project-merge-request-template
- API endpoint: /projects/{project_id}/templates/merge_requests
- project-merge-train
- API endpoint: /projects/{project_id}/merge_trains
- project-milestone
- API endpoint: /projects/{project_id}/milestones
- project-note
- API endpoint: /projects/{project_id}/notes
- project-notification-settings
- API endpoint: /projects/{project_id}/notification_settings
- project-package
- API endpoint: /projects/{project_id}/packages
- project-package-file
- API endpoint: /projects/{project_id}/packages/{package _id}/package_files
- project-package-pipeline
- API endpoint: /projects/{project_id}/packages/{package_id}/pipelines
- project-package-protection-rule
- API endpoint: /projects/{project_id}/packages/protection/rules
- project-pages
- API endpoint: /projects/{project_id}/pages
- project-pages-domain
- API endpoint: /projects/{project_id}/pages/domains
- project-pipeline
- API endpoint: /projects/{project_id}/pipelines
- project-pipeline-bridge
- API endpoint: /projects/{project_id}/pipelines/{pipeline_id}/bridges
- project-pipeline-job
- API endpoint: /projects/{project_id}/pipelines/{pipeline_id}/jobs
- project-pipeline-schedule
- API endpoint: /projects/{project_id}/pipeline_schedules
- project-pipeline-schedule-pipeline
- API endpoint: /projects/{project_id}/pipeline_schedule s/{pipeline_schedule_id}/pipelines
- project-pipeline-schedule-variable
- API endpoint: /projects/{project_id}/pipeline_schedule s/{pipeline_schedule_id}/variables
- project-pipeline-test-report
- API endpoint: /projects/{project_id}/pipelines/{pipeli ne_id}/test_report
- project-pipeline-test-report-summary
- API endpoint: /projects/{project_id}/pipelines/{pipeli ne_id}/test_report_summary
- project-pipeline-variable
- API endpoint: /projects/{project_id}/pipelines/{pipeli ne_id}/variables
- project-protected-branch
- API endpoint: /projects/{project_id}/protected_branches
- project-protected-environment
- API endpoint: /projects/{project_id}/protected_environments
- project-protected-tag
- API endpoint: /projects/{project_id}/protected_tags
- project-pull-mirror
- API endpoint: /projects/{project_id}/mirror/pull
- project-push-rules
- API endpoint: /projects/{project_id}/push_rule
- project-registry-protection-rule
- API endpoint: /projects/{project_id}/registry/protection/rules
- project-registry-repository
- API endpoint: /projects/{project_id}/registry/repositories
- project-registry-repository-protection-rule
- API endpoint: /projects/{project_id}/registry/protecti on/repository/rules
- project-registry-tag
- API endpoint: /projects/{project_id}/registry/reposito ries/{repository_id}/tags
- project-release
- API endpoint: /projects/{project_id}/releases
- project-release-link
- API endpoint: /projects/{project_id}/releases/{tag_nam e}/assets/links
- project-remote-mirror
- API endpoint: /projects/{project_id}/remote_mirrors
- project-resource-group
- API endpoint: /projects/{project_id}/resource_groups
- project-resource-group-upcoming-job
- API endpoint: /projects/{project_id}/resource_groups/{ resource_group_key}/upcoming_jobs
- project-runner
- API endpoint: /projects/{project_id}/runners
- project-secure-file
- API endpoint: /projects/{project_id}/secure_files
- project-service
- API endpoint: /projects/{project_id}/integrations
- project-service-account
- API endpoint: /projects/{project_id}/service_accounts
- project-service-account-access-token
- API endpoint: /projects/{project_id}/service_accounts/ {user_id}/personal_access_tokens
- project-snippet
- API endpoint: /projects/{project_id}/snippets
- project-snippet-award-emoji
- API endpoint: /projects/{project_id}/snippets/{snippet _id}/award_emoji
- project-snippet-discussion
- API endpoint: /projects/{project_id}/snippets/{snippet _id}/discussions
- project-snippet-discussion-note
- API endpoint: /projects/{project_id}/snippets/{snippet _id}/discussions/{discussion_id}/notes
- project-snippet-note
- API endpoint: /projects/{project_id}/snippets/{snippet_id}/notes
- project-snippet-note-award-emoji
- API endpoint: /projects/{project_id}/snippets/{snippet _id}/notes/{note_id}/award_emoji
- project-storage
- API endpoint: /projects/{project_id}/storage
- project-tag
- API endpoint: /projects/{project_id}/repository/tags
- project-trigger
- API endpoint: /projects/{project_id}/triggers
- project-user
- API endpoint: /projects/{project_id}/users
- project-variable
- API endpoint: /projects/{project_id}/variables
- project-wiki
- API endpoint: /projects/{project_id}/wikis
- registry-repository
- API endpoint: /registry/repositories
- runner
- API endpoint: /runners
- runner-all
- API endpoint: /runners/all
- runner-job
- API endpoint: /runners/{runner_id}/jobs
- service-account
- API endpoint: /service_accounts
- API endpoint: /groups/{group_id}/projects/shared
- snippet
- API endpoint: /snippets
- starred-project
- API endpoint: /users/{user_id}/starred_projects
- todo
- API endpoint: /todos
- topic
- API endpoint: /topics
- user
- API endpoint: /users
- user-activities
- API endpoint: /user/activities
- user-contributed-project
- API endpoint: /users/{user_id}/contributed_projects
- user-custom-attribute
- API endpoint: /users/{user_id}/custom_attributes
- user-email
- API endpoint: /users/{user_id}/emails
- user-event
- API endpoint: /users/{user_id}/events
- user-gpg-key
- API endpoint: /users/{user_id}/gpg_keys
- user-impersonation-token
- API endpoint: /users/{user_id}/impersonation_tokens
- user-key
- API endpoint: /users/{user_id}/keys
- user-membership
- API endpoint: /users/{user_id}/memberships
- user-personal-access-token
- API endpoint: /users/{user_id}/personal_access_tokens
- user-project
- API endpoint: /projects/user/{user_id}
- user-status
- API endpoint: /users/{user_id}/status
- variable
- API endpoint: /admin/ci/variables
| November 2026 | python-gitlab 1:8.6.0-1 |