Action domain

pipeline

Every action this domain exposes through gitlab_execute_action, from the gitlab://tools manifest. Each entry folds out to its full upstream description and required parameters.

33 · actions4 · destructive15 · read-only

Counted with a Free-tier GitLab token. The catalog is scoped to the token that asks, so the count moves with both its tier and its permissions: higher tiers expose more actions, and administration domains only appear to tokens allowed to use them.

Back to the server card

1. pipeline.cancelPipeline Cancel

   Cancel a running pipeline. Returns: updated pipeline metadata reflecting the canceled status. See also: pipeline.get, pipeline.retry, job.list_project.

   Required parameters: pipeline_id (integer), project_id (string)

2. pipeline.createPipeline Create

   Create a new pipeline. Returns: created pipeline metadata including ID, status, and target ref. See also: pipeline.get, pipeline.wait, job.list_project.

   Required parameters: project_id (string), ref (string)

3. pipeline.deletePipeline Deletedestructive

   Delete a pipeline and all its jobs. Returns: a success status and confirmation message. See also: pipeline.get, pipeline.list, pipeline.cancel.

   Required parameters: pipeline_id (integer), project_id (string)

4. pipeline.getPipeline Getread-only

   Get one pipeline by ID. Returns: full pipeline metadata, status lifecycle fields, and links. See also: pipeline.list, pipeline.variables, job.list_project, pipeline.retry.

   Required parameters: pipeline_id (integer), project_id (string)

5. pipeline.latestPipeline Latestread-only

   Get the latest pipeline for a ref. Returns: full pipeline metadata for the most recent run. See also: pipeline.get, pipeline.list, job.list_project.

   Required parameters: project_id (string)

6. pipeline.listPipeline Listread-only

   List project pipelines with filters and pagination. Returns: pipeline IDs, refs, statuses, source, and timing metadata. See also: pipeline.get, pipeline.latest, job.list_project.

   Required parameters: project_id (string)

7. pipeline.resource_group_editEdit Resource Group

   Update the process mode of one CI resource group by key. Returns: the updated resource group ID, key, and new process mode that controls how queued jobs sharing the resource group are serialized. See also: pipeline.resource_group_get, pipeline.resource_group_list, pipeline.resource_group_upcoming_jobs.

   Required parameters: key (string), process_mode (string), project_id (string)

8. pipeline.resource_group_getGet Resource Groupread-only

   Get one CI resource group in a project by key. Returns: the resource group ID, key, and process mode (the concurrency mode that controls how jobs sharing the resource group are serialized). See also: pipeline.resource_group_list, pipeline.resource_group_edit, pipeline.resource_group_upcoming_jobs.

   Required parameters: key (string), project_id (string)

9. pipeline.resource_group_listList Resource Groupsread-only

   List the CI resource groups configured for a project. Returns: each resource group's ID, key, and process mode that controls how jobs sharing the group are serialized to limit pipeline concurrency. See also: pipeline.resource_group_get, pipeline.resource_group_edit, pipeline.resource_group_upcoming_jobs.

   Required parameters: project_id (string)

10. pipeline.resource_group_upcoming_jobsList Resource Group Upcoming Jobsread-only

    List the upcoming CI jobs queued for one resource group by key. Returns: each pending job's ID, name, status, and stage, ordered as they will run under the resource group's process mode. See also: pipeline.resource_group_get, pipeline.resource_group_list, pipeline.resource_group_upcoming_jobs.

    Required parameters: key (string), project_id (string)

11. pipeline.retryPipeline Retry

    Retry failed and canceled jobs in a pipeline. Returns: updated pipeline metadata after re-queuing jobs. See also: pipeline.get, pipeline.cancel, job.list_project.

    Required parameters: pipeline_id (integer), project_id (string)

12. pipeline.schedule_createPipeline Schedule Create

    Create a pipeline schedule. Returns: the created schedule with id, description, ref, cron, owner, and inputs. See also: pipeline.schedule_get, pipeline.schedule_update, pipeline.schedule_list.

    Required parameters: cron (string), description (string), project_id (string), ref (string)

13. pipeline.schedule_create_variablePipeline Schedule Create Variable

    Create a pipeline schedule variable. Returns: the created variable with key, value, and variable_type. See also: pipeline.schedule_edit_variable, pipeline.schedule_delete_variable.

    Required parameters: key (string), project_id (string), schedule_id (integer), value (string)

14. pipeline.schedule_deletePipeline Schedule Deletedestructive

    Delete a pipeline schedule permanently. Returns: a success confirmation. See also: pipeline.schedule_get, pipeline.schedule_list.

    Required parameters: project_id (string), schedule_id (integer)

15. pipeline.schedule_delete_variablePipeline Schedule Delete Variabledestructive

    Delete a pipeline schedule variable. Returns: a success confirmation naming the key. See also: pipeline.schedule_create_variable, pipeline.schedule_edit_variable.

    Required parameters: key (string), project_id (string), schedule_id (integer)

16. pipeline.schedule_edit_variablePipeline Schedule Edit Variable

    Edit a pipeline schedule variable. Returns: the updated variable with key, value, and variable_type. See also: pipeline.schedule_create_variable, pipeline.schedule_delete_variable.

    Required parameters: key (string), project_id (string), schedule_id (integer), value (string)

17. pipeline.schedule_getPipeline Schedule Getread-only

    Get a single pipeline schedule by ID. Returns: the schedule with cron, ref, owner, last_pipeline, variables, and inputs. See also: pipeline.schedule_list, pipeline.schedule_update, pipeline.schedule_run.

    Required parameters: project_id (string), schedule_id (integer)

18. pipeline.schedule_listPipeline Schedule Listread-only

    List pipeline schedules in a project. Returns: schedules with description, ref, cron, owner, and pagination metadata. See also: pipeline.schedule_get, pipeline.schedule_create.

    Required parameters: project_id (string)

19. pipeline.schedule_list_triggered_pipelinesPipeline Schedule List Triggered Pipelinesread-only

    List pipelines triggered by a schedule. Returns: triggered pipelines with status, ref, sha, web URL, and pagination metadata. See also: pipeline.schedule_get, pipeline.schedule_run.

    Required parameters: project_id (string), schedule_id (integer)

20. pipeline.schedule_runPipeline Schedule Run

    Run a pipeline schedule immediately. Returns: the schedule's current state after triggering. See also: pipeline.schedule_get, pipeline.schedule_list_triggered_pipelines.

    Required parameters: project_id (string), schedule_id (integer)

21. pipeline.schedule_take_ownershipPipeline Schedule Take Ownership

    Take ownership of a pipeline schedule. Returns: the schedule with the caller as owner. See also: pipeline.schedule_update, pipeline.schedule_run.

    Required parameters: project_id (string), schedule_id (integer)

22. pipeline.schedule_updatePipeline Schedule Update

    Update a pipeline schedule. Returns: the updated schedule with cron, ref, owner, and inputs. See also: pipeline.schedule_get, pipeline.schedule_take_ownership.

    Required parameters: project_id (string), schedule_id (integer)

23. pipeline.test_reportPipeline Test Reportread-only

    Get a pipeline's full test report. Returns: total/passed/failed/skipped counts and per-suite breakdown. See also: pipeline.test_report_summary, pipeline.get, job.list_project.

    Required parameters: pipeline_id (integer), project_id (string)

24. pipeline.test_report_summaryPipeline Test Report Summaryread-only

    Get a pipeline's test report summary. Returns: aggregate test totals and per-suite summaries with build IDs. See also: pipeline.test_report, pipeline.get, job.list_project.

    Required parameters: pipeline_id (integer), project_id (string)

25. pipeline.trigger_createPipeline Trigger Create

    Create a pipeline trigger token. Returns: the created trigger with id, description, token secret, and owner. See also: pipeline.trigger_run, pipeline.trigger_list, pipeline.trigger_delete.

    Required parameters: project_id (string)

26. pipeline.trigger_deletePipeline Trigger Deletedestructive

    Delete a pipeline trigger token. Returns: a success confirmation. See also: pipeline.trigger_get, pipeline.trigger_create.

    Required parameters: project_id (string), trigger_id (integer)

27. pipeline.trigger_getPipeline Trigger Getread-only

    Get a single pipeline trigger token. Returns: the trigger with id, description, token, owner, and timestamps. See also: pipeline.trigger_list, pipeline.trigger_update, pipeline.trigger_delete.

    Required parameters: project_id (string), trigger_id (integer)

28. pipeline.trigger_listPipeline Trigger Listread-only

    List a project's pipeline trigger tokens. Returns: trigger tokens with id, description, owner, last-used time, and pagination metadata. See also: pipeline.trigger_get, pipeline.trigger_create, pipeline.trigger_run.

    Required parameters: project_id (string)

29. pipeline.trigger_runPipeline Trigger Run

    Trigger a pipeline using a trigger token. Returns: the created pipeline with id, status, ref, sha, source, user, detailed_status, and web URL. See also: pipeline.trigger_list, pipeline.get.

    Required parameters: project_id (string)

30. pipeline.trigger_updatePipeline Trigger Update

    Update a pipeline trigger token's description. Returns: the updated trigger with id, description, token, and owner. See also: pipeline.trigger_get, pipeline.trigger_delete.

    Required parameters: project_id (string), trigger_id (integer)

31. pipeline.update_metadataPipeline Update Metadata

    Update a pipeline's name. Returns: updated pipeline metadata reflecting the new name. See also: pipeline.get, pipeline.list, pipeline.create.

    Required parameters: name (string), pipeline_id (integer), project_id (string)

32. pipeline.variablesPipeline Variablesread-only

    List a pipeline's runtime variables. Returns: variable keys, values, and types. See also: pipeline.get, pipeline.create, job.list_project.

    Required parameters: pipeline_id (integer), project_id (string)

33. pipeline.waitPipeline Waitread-only

    Use only to poll an existing pipeline_id until a terminal status. For merge when pipeline succeeds, use merge_request.merge with auto_merge=true instead.

    Required parameters: pipeline_id (integer), project_id (string)