category: Utilities provider: GitLab Inc. commonfields: id: GitLab version: -1 configuration: - defaultvalue: https://gitlab.com/api/v4 display: Server URL (e.g. https://gitlab.com/api/v4) name: url required: true type: 0 - display: API Key name: api_key required: true type: 4 - display: Trigger Token name: trigger_token type: 4 required: false - display: Trust any certificate (not secure) name: insecure type: 8 required: false - display: Use system proxy settings name: proxy type: 8 required: false description: Deprecated. Use GitLab v2 in GitLab Pack instead. display: GitLab (Deprecated) name: GitLab script: commands: - arguments: - description: Limits the results to projects stored on repository_storage. Available for administrators only. name: repository_storage - description: Limits the results to projects with last_activity before a specified time. name: last_activity_before - description: Limits by the minimal access level of the current user. name: min_access_level - description: Returns only limited fields for each project. This is a no operation without authentication as only simple fields are returned. name: simple - description: Returns the projects sorted in ascending or descending order. name: sort - description: Limits by the projects that the current user is a member of. name: membership - description: Includes the ancestor namespaces when matching search criteria. name: search_namespaces - description: Limits by archived status. name: archived - description: Returns a list of projects that match the search criteria. name: search - description: Limits the results to projects with IDs that are less than the specified ID. name: id_before - description: Limits the results to projects with last_activity after a specified time. name: last_activity_after - description: Limits by the projects starred by the current user. name: starred - description: Limits the results to projects with IDs greater than the specified ID. name: id_after - description: Limits by the projects explicitly owned by the current user. name: owned - description: Returns the projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields. Repository_size, storage_size, and wiki_size fields are only allowed for administrators. The default is created_at. name: order_by - description: Includes the project statistics. name: statistics - description: Limits by visibility; public, internal, or private. name: visibility - description: Includes the custom attributes in the response (administrators only). name: with_custom_attributes - description: Limits by the enabled issues feature. name: with_issues_enabled - description: Limits by the enabled merge requests feature. name: with_merge_requests_enabled - description: Limits by the projects that use the given programming language. name: with_programming_language deprecated: true description: Gets a list of all visible projects across GitLab for the authenticated user. When accessed without authentication, only public projects with simple fields are returned. name: gitlab-get-projects outputs: - contextPath: GitLab.Projects.web_url description: Project Web URL. type: Unknown - contextPath: GitLab.Projects.name description: Project Name. type: Unknown - contextPath: GitLab.Projects.path description: Project Path. type: Unknown - contextPath: GitLab.Projects.created_at description: Project Created At. type: Unknown - contextPath: GitLab.Projects.visibility description: Project Visiblity. type: Unknown - contextPath: GitLab.Projects.id description: Project ID. type: Unknown - arguments: - description: The ID or URL encoded path of the project that is owned by the authenticated user. name: id required: true deprecated: true description: Gets a list of the access requests viewable by the authenticated user. name: gitlab-projects-get-access-requests outputs: - contextPath: GitLab.AccessRequests.id description: Access Request ID. type: Unknown - contextPath: GitLab.AccessRequests.username description: Access Request User. type: Unknown - contextPath: GitLab.AccessRequests.requested_at description: Access Request Create Time. type: Unknown - contextPath: GitLab.AccessRequests.state description: Access Request State. type: Unknown - arguments: - description: The ID or URL encoded path of the project that is owned by the authenticated user. name: id required: true deprecated: true description: Requests the authenticated user access to a group or project. name: gitlab-projects-request-access outputs: - contextPath: GitLab.AccessRequests.id description: Access Request ID. type: Unknown - contextPath: GitLab.AccessRequests.username description: Access Request User. type: Unknown - contextPath: GitLab.AccessRequests.requested_at description: Access Request Create Time. type: Unknown - contextPath: GitLab.AccessRequests.state description: Access Request State. type: Unknown - arguments: - description: The ID or URL encoded path of the project owned by the authenticated user. name: id required: true - description: The user ID of the access requester. name: user_id required: true - description: 'A valid access level (defaults: 30, developer access level).' name: access_level deprecated: true description: Approves an access request for the given user. name: gitlab-projects-approve-access outputs: - contextPath: GitLab.AccessRequests.id description: Access Request ID. type: Unknown - contextPath: GitLab.AccessRequests.username description: Access Request User. type: Unknown - contextPath: GitLab.AccessRequests.requested_at description: Access Request Create Time. type: Unknown - contextPath: GitLab.AccessRequests.state description: Access Request State. type: Unknown - arguments: - description: The ID or URL encoded path of the project that is owned by the authenticated user. name: id required: true - description: The user ID of the access requester. name: user_id required: true deprecated: true description: Denies an access request for the given user. name: gitlab-projects-deny-access outputs: - contextPath: GitLab.AccessRequests.id description: Access Request ID. type: Unknown - contextPath: GitLab.AccessRequests.state description: Access Request State. type: Unknown - arguments: - description: The ID or URL encoded path of the project that is owned by the authenticated user. name: id required: true - description: Returns a list of branches containing the search string. You can use ^term and term$ to find branches that begin and end with term, respectively. name: search deprecated: true description: Gets a list of repository branches from a project, sorted by name alphabetically. name: gitlab-projects-get-repository-branches outputs: - contextPath: GitLab.Branches.name description: Branch Name. type: Unknown - contextPath: GitLab.Branches.web_url description: Branch Web URL. type: Unknown - contextPath: GitLab.Branches.commit.id description: Branch Head Commit ID. type: Unknown - arguments: - description: The ID or URL encoded path of the project that is owned by the authenticated user. name: id required: true - description: The name of the branch. name: branch required: true - description: Branch name, or commit SHA to create a branch from. name: ref required: true deprecated: true description: Creates a new branch in the repository. name: gitlab-projects-create-repository-branch outputs: - contextPath: GitLab.Branches.name description: Branch Name. type: Unknown - contextPath: GitLab.Branches.web_url description: Branch Web URL. type: Unknown - contextPath: GitLab.Branches.commit.id description: Branch Head Commit ID. type: Unknown - arguments: - description: The ID or URL encoded path of the project that is owned by the authenticated user. name: id required: true - description: The name of the branch. name: branch required: true deprecated: true description: Deletes a branch from the repository. name: gitlab-projects-delete-repository-branch - arguments: - description: The ID or URL encoded path of the project that is owned by the authenticated user. name: id required: true deprecated: true description: Deletes all branches that are merged into the project’s default branch. name: gitlab-projects-delete-repository-merged-branches - deprecated: true description: Retrieves the version information for the GitLab instance, and responds 200 OK for authenticated users. name: gitlab-get-version outputs: - contextPath: GitLab.version description: GitLab Verion type: String - contextPath: GitLab.revision description: GitLab Revision type: String - arguments: - description: Project ID from which to retrieve pipeline schedules. name: project_id required: true - description: ID of the specific pipeline schedule from which to retrieve its details. name: pipeline_schedule_id deprecated: true description: Gets the details of the pipeline schedules. name: gitlab-pipelines-schedules-list outputs: - contextPath: GitLab.PipelineSchedule.id description: Pipeline schedule ID. type: Number - contextPath: GitLab.PipelineSchedule.description description: Pipeline schedule description. type: String - contextPath: GitLab.PipelineSchedule.ref description: Pipeline schedule reference. type: String - contextPath: GitLab.PipelineSchedule.next_run_at description: Pipeline schedule next run scheduled time. type: Date - contextPath: GitLab.PipelineSchedule.active description: Whether pipeline schedule is active. type: Boolean - contextPath: GitLab.PipelineSchedule.created_at description: When pipeline schedule was created. type: Date - contextPath: GitLab.PipelineSchedule.updated_at description: When the pipeline schedule was last updated. type: Date - contextPath: GitLab.PipelineSchedule.last_pipeline.id description: ID of the last pipeline that was run by the scheduled pipeline. Relevant only when the pipeline schedule ID is given. type: Number - contextPath: GitLab.PipelineSchedule.last_pipeline.sha description: SHA of the last pipeline that was run by the scheduled pipeline. Relevant only when the pipeline schedule ID is given. type: String - contextPath: GitLab.PipelineSchedule.last_pipeline.ref description: Reference of the last pipeline that was run by the scheduled pipeline. Relevant only when the pipeline schedule ID is given. type: String - contextPath: GitLab.PipelineSchedule.last_pipeline.status description: Status of the last pipeline that was run by the scheduled pipeline. Relevant only when the pipeline schedule ID is given. type: String - arguments: - description: Project ID from which to retrieve pipelines. name: project_id required: true - description: ID of specific pipeline from which to retrieve its details. name: pipeline_id - description: Reference name of the pipelines, e.g., 'master'. name: ref - auto: PREDEFINED description: Retrieves pipelines of which status matches the given status. name: status predefined: - 'created' - 'waiting_for_resource' - 'preparing' - 'pending' - 'running' - 'success' - 'failed' - 'canceled' - 'skipped' - 'manual' - 'scheduled' deprecated: true description: Gets the details of the pipelines. name: gitlab-pipelines-list outputs: - contextPath: GitLab.Pipeline.id description: Pipeline ID. type: Number - contextPath: GitLab.Pipeline.project_id description: Project ID that the pipeline belongs to. type: Number - contextPath: GitLab.Pipeline.status description: Status of the pipeline. type: String - contextPath: GitLab.Pipeline.ref description: Reference of the pipeline. type: String - contextPath: GitLab.Pipeline.sha description: SHA of the pipeline. type: String - contextPath: GitLab.Pipeline.created_at description: Time when the pipeline was created. type: Date - contextPath: GitLab.Pipeline.updated_at description: Time when the pipeline was last updated. type: Date - contextPath: GitLab.Pipeline.started_at description: Time when the pipeline was started. type: Date - contextPath: GitLab.Pipeline.finished_at description: Time when the pipeline was finished. type: Date - contextPath: GitLab.Pipeline.duration description: Duration of the pipeline in seconds. type: Number - contextPath: GitLab.Pipeline.web_url description: Web URL of the pipeline. type: String - contextPath: GitLab.Pipeline.user.name description: Name of the user who triggered the pipeline. type: String - contextPath: GitLab.Pipeline.user.username description: Username that triggered the pipeline. type: String - contextPath: GitLab.Pipeline.user.id description: ID of the user who triggered the pipeline. type: Number - contextPath: GitLab.Pipeline.user.state description: State of the user who triggered the pipeline. type: String - contextPath: GitLab.Pipeline.user.avatar_url description: Avatar URL of the user who trigerred the pipeline. type: String - contextPath: GitLab.Pipeline.user.web_url description: Web URL of the user who triggered the pipeline. type: String - arguments: - description: Project ID from which to retrieve jobs details. name: project_id required: true - description: ID of the pipeline from which to retrieve its jobs. name: pipeline_id required: true deprecated: true description: Gets job details. name: gitlab-jobs-list outputs: - contextPath: GitLab.Job.status description: The status of the job. type: String - contextPath: GitLab.Job.created_at description: Time the job was created. type: Date - contextPath: GitLab.Job.started_at description: Time the job was started. type: Date - contextPath: GitLab.Job.finished_at description: Time the job was finished. type: Date - contextPath: GitLab.Job.duration description: Duration of the job in seconds. type: Number - contextPath: GitLab.Job.id description: ID of the job. type: Number - contextPath: GitLab.Job.name description: Name of the job. type: String - contextPath: GitLab.Job.pipeline.id description: Pipeline the job belongs to. type: Number - contextPath: GitLab.Job.pipeline.project_id description: Project ID the job belongs to. type: Number - contextPath: GitLab.Job.pipeline.ref description: Reference of the pipeline the job belongs to. type: String - contextPath: GitLab.Job.pipeline.sha description: SHA of the pipeline the job belongs to. type: String - contextPath: GitLab.Job.pipeline.status description: Status of the pipeline the job belongs to. type: String - contextPath: GitLab.Job.ref description: Reference name of the job. type: String - contextPath: GitLab.Job.stage description: Stage of the job. type: String - contextPath: GitLab.Job.web_url description: Web URL of the job. type: String - arguments: - description: Project ID from which to retrieve an artifact. name: project_id required: true - description: ID of a specific job from which to retrieve its artifact. name: job_id required: true - description: Suffix to the path of an artifact from which to retrieve its data. name: artifact_path_suffix required: true deprecated: true description: Gets an artifact from a given artifact path, corresponding to a given job ID. name: gitlab-artifact-get outputs: - contextPath: GitLab.Artifact.job_id description: Job ID from which the artifact was taken. type: String - contextPath: GitLab.Artifact.artifact_path_suffix description: Suffix of the given artifact path. type: String - contextPath: GitLab.Artifact.artifact_data description: Data of the artifact requested. type: String - arguments: - defaultValue: master name: target_branch description: The target branch of the Merge Request. - auto: PREDEFINED defaultValue: opened name: state description: The state of the Merge Request. predefined: - opened - closed - locked - merged - description: Project ID from which to retrieve the Merge Requests. name: project_id required: true description: List all merge requests name: gitlab-merge-requests-list outputs: - contextPath: GitLab.MergeRequest.id description: The merge request ID. type: Number - contextPath: GitLab.MergeRequest.iid description: The merge request IID. type: Number - contextPath: GitLab.MergeRequest.project_id description: The project ID of the merge request. type: Number - contextPath: GitLab.MergeRequest.title description: The merge request title. type: String - contextPath: GitLab.MergeRequest.description description: The merge request description type: String - contextPath: GitLab.MergeRequest.state description: The merge request state. type: String - contextPath: GitLab.MergeRequest.created_at description: The time the merge request was created. type: Date - contextPath: GitLab.MergeRequest.updated_at description: The time the merge request was updated. type: Date - contextPath: GitLab.MergeRequest.merged_at description: The time the merge request was merged. type: Date - contextPath: GitLab.MergeRequest.closed_by description: The user who closed the merge request. type: String - contextPath: GitLab.MergeRequest.closed_at description: The time the merge request was closed. type: Date - contextPath: GitLab.MergeRequest.target_branch description: The merge request target branch. type: String - contextPath: GitLab.MergeRequest.source_branch description: The merge request source branch. type: String - contextPath: GitLab.MergeRequest.assignee description: The merge request assignee. type: String - contextPath: GitLab.MergeRequest.sha description: The merge request commit SHA. type: String - contextPath: GitLab.MergeRequest.merge_commit_sha description: The merge request merge commit SHA. type: String - contextPath: GitLab.MergeRequest.squash_commit_sha description: The merge request squash commit SHA. type: String deprecated: true - arguments: - description: Project ID from which to retrieve the Merge Requests. name: project_id required: true - description: Merge Request IID. name: merge_request_iid required: true description: Get a Merge Request name: gitlab-merge-request-get outputs: - contextPath: GitLab.MergeRequest.id description: The merge request ID. type: Number - contextPath: GitLab.MergeRequest.iid description: The merge request IID. type: Number - contextPath: GitLab.MergeRequest.project_id description: The project ID of the merge request. type: Number - contextPath: GitLab.MergeRequest.title description: The merge request title. type: String - contextPath: GitLab.MergeRequest.description description: The merge request description type: String - contextPath: GitLab.MergeRequest.state description: The merge request state. type: String - contextPath: GitLab.MergeRequest.created_at description: The time the merge request was created. type: Date - contextPath: GitLab.MergeRequest.updated_at description: The time the merge request was updated. type: Date - contextPath: GitLab.MergeRequest.merged_at description: The time the merge request was merged. type: Date - contextPath: GitLab.MergeRequest.closed_by description: The user who closed the merge request. type: String - contextPath: GitLab.MergeRequest.closed_at description: The time the merge request was closed. type: Date - contextPath: GitLab.MergeRequest.target_branch description: The merge request target branch. type: String - contextPath: GitLab.MergeRequest.source_branch description: The merge request source branch. type: String - contextPath: GitLab.MergeRequest.assignee description: The merge request assignee. type: String - contextPath: GitLab.MergeRequest.sha description: The merge request commit SHA. type: String - contextPath: GitLab.MergeRequest.merge_commit_sha description: The merge request merge commit SHA. type: String - contextPath: GitLab.MergeRequest.squash_commit_sha description: The merge request squash commit SHA. type: String deprecated: true - arguments: - name: labels description: Comma seperated values of labels to search issues by. - name: scope defaultValue: title,description description: On what scope to perform the search on. predefined: - title - description - title,description auto: PREDEFINED - name: search description: The search clause. - auto: PREDEFINED defaultValue: all name: state description: The state of the issue. predefined: - opened - closed - all - description: Project ID from which to retrieve the Merge Requests. name: project_id required: true - name: assignee_username description: filter by assignee username description: List all issues name: gitlab-issues-list outputs: - contextPath: GitLab.Issue.id description: The issue ID. type: Number - contextPath: GitLab.Issue.iid description: The issue IID. type: Number - contextPath: GitLab.Issue.project_id description: The project ID of the issue. type: Number - contextPath: GitLab.Issue.title description: The issue title. type: String - contextPath: GitLab.Issue.description description: The issue description. type: String - contextPath: GitLab.Issue.state description: The issue state. type: String - contextPath: GitLab.Issue.created_at description: The time the issue was created. type: Date - contextPath: GitLab.Issue.updated_at description: The time the issue was updated. type: Date - contextPath: GitLab.Issue.closed_at description: The time the issue was closed. type: Date - contextPath: GitLab.Issue.closed_by description: The user who closed the issue. type: String - contextPath: GitLab.Issue.labels description: Comma seperated values of the issue's labels. type: String - contextPath: GitLab.Issue.merge_requests_count description: merge requests count type: Number - contextPath: GitLab.Issue.has_tasks description: Whether the issue has tasks or not. type: Boolean - contextPath: GitLab.Issue.task_status description: The status of the issue's tasks. type: String deprecated: true - arguments: - name: labels description: Comma separated values of labels to add to the issue. - name: title description: The issue title. required: true - name: description description: The issue description. required: true - description: Project ID of the created issue. name: project_id required: true description: Create an issue name: gitlab-issue-create outputs: - contextPath: GitLab.Issue.id description: The issue ID. type: Number - contextPath: GitLab.Issue.iid description: The issue IID. type: Number - contextPath: GitLab.Issue.project_id description: The project ID of the issue. type: Number - contextPath: GitLab.Issue.title description: The issue title. type: String - contextPath: GitLab.Issue.description description: The issue description. type: String - contextPath: GitLab.Issue.state description: The issue state. type: String - contextPath: GitLab.Issue.created_at description: The time the issue was created. type: Date - contextPath: GitLab.Issue.updated_at description: The time the issue was updated. type: Date - contextPath: GitLab.Issue.closed_at description: The time the issue was closed. type: Date - contextPath: GitLab.Issue.closed_by description: The user who closed the issue. type: String - contextPath: GitLab.Issue.labels description: Comma seperated values of the issue's labels. type: String - contextPath: GitLab.Issue.merge_requests_count description: merge requests count type: Number - contextPath: GitLab.Issue.has_tasks description: Whether the issue has tasks or not. type: Boolean - contextPath: GitLab.Issue.task_status description: The status of the issue's tasks. type: String deprecated: true - arguments: - name: add_labels description: The labels to add to the issue. - name: remove_labels description: The labels to remove from the issue. - name: description description: The description of the issue. - description: Project ID from which to retrieve the issue. name: project_id required: true - description: Issue ID. name: issue_id required: true description: Edit an issue name: gitlab-issue-edit outputs: - contextPath: GitLab.Issue.id description: The issue ID. type: Number - contextPath: GitLab.Issue.iid description: The issue IID. type: Number - contextPath: GitLab.Issue.project_id description: The project ID of the issue. type: Number - contextPath: GitLab.Issue.title description: The issue title. type: String - contextPath: GitLab.Issue.description description: The issue description. type: String - contextPath: GitLab.Issue.state description: The issue state. type: String - contextPath: GitLab.Issue.created_at description: The time the issue was created. type: Date - contextPath: GitLab.Issue.updated_at description: The time the issue was updated. type: Date - contextPath: GitLab.Issue.closed_at description: The time the issue was closed. type: Date - contextPath: GitLab.Issue.closed_by description: The user who closed the issue. type: String - contextPath: GitLab.Issue.labels description: Comma seperated values of the issue's labels. type: String - contextPath: GitLab.Issue.merge_requests_count description: Merge requests count type: Number - contextPath: GitLab.Issue.has_tasks description: Whether the issue has tasks or not. type: Boolean - contextPath: GitLab.Issue.task_status description: The status of the issue's tasks. type: String deprecated: true - arguments: - description: Group ID from which to retrieve the projects. name: group_id required: true description: Get the list of projects of a given group. name: gitlab-group-projects-list outputs: - contextPath: GitLab.Project.id description: The project ID. type: Number - contextPath: GitLab.Project.name description: The project name. type: String - contextPath: GitLab.Project.path_with_namespace description: The project path with namespace. type: String deprecated: true - arguments: - description: Project ID to get the file from. name: project_id required: true - description: The file path. name: file_path required: true - description: The branch to retrieve the file from, default is master name: ref - defaultValue: false description: 'Whether to create a file entry in the War Room with the file contents. Possible values are: "true" and "false". Default value is "false".' name: create_file_from_content predefined: - 'true' - 'false' description: Get raw file name: gitlab-raw-file-get outputs: - contextPath: GitLab.File.ref description: The branch the file's content was taken from. type: String - contextPath: GitLab.File.path description: The file path. type: String - contextPath: GitLab.File.content description: The file content. type: String deprecated: true - arguments: - description: ref branch of the PR. name: ref_branch required: true - description: 'json contains the requests variables as keys and values for example {"BuildParam1": "ParamValue"}.' name: trigger_variables - description: Project ID. name: project_id required: true description: Trigger a pipeline in gitlab. name: gitlab-trigger-pipeline outputs: - contextPath: GitLab.Pipeline.id description: Pipeline ID. type: Number - contextPath: GitLab.Pipeline.project_id description: Project ID that the pipeline belongs to. type: Number - contextPath: GitLab.Pipeline.status description: Status of the pipeline. type: String - contextPath: GitLab.Pipeline.ref description: Reference of the pipeline. type: String - contextPath: GitLab.Pipeline.sha description: SHA of the pipeline. type: String - contextPath: GitLab.Pipeline.created_at description: Time when the pipeline was created. type: Date - contextPath: GitLab.Pipeline.updated_at description: Time when the pipeline was last updated. type: Date - contextPath: GitLab.Pipeline.started_at description: Time when the pipeline was started. type: Date - contextPath: GitLab.Pipeline.finished_at description: Time when the pipeline was finished. type: Date - contextPath: GitLab.Pipeline.duration description: Duration of the pipeline in seconds. type: Number - contextPath: GitLab.Pipeline.web_url description: Web URL of the pipeline. type: String - contextPath: GitLab.Pipeline.user.name description: Name of the user who triggered the pipeline. type: String - contextPath: GitLab.Pipeline.user.username description: Username that triggered the pipeline. type: String - contextPath: GitLab.Pipeline.user.id description: ID of the user who triggered the pipeline. type: Number - contextPath: GitLab.Pipeline.user.state description: State of the user who triggered the pipeline. type: String - contextPath: GitLab.Pipeline.user.avatar_url description: Avatar URL of the user who trigerred the pipeline. type: String - contextPath: GitLab.Pipeline.user.web_url description: Web URL of the user who triggered the pipeline. type: String deprecated: true dockerimage: demisto/python3:3.10.7.35188 runonce: false script: '-' subtype: python3 type: python tests: - No tests (deprecated) fromversion: 6.0.0 deprecated: true