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 token against gitlab.com, which is the only host this endpoint talks to: to use it against a self-managed instance, run the server yourself — its documentation covers that. 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. That is why the figures differ elsewhere: the upstream project counts 868 operations on Community Edition and up to 1,094 on GitLab.com's top tier, while this deployment publishes 768 because it is OAuth-only and acts with your token, so the administration domains a non-admin account cannot call never appear. All three describe the same catalog, counted from three vantage points.

Each entry also says what a GitLab fine-grained personal access token needs to run it, as GitLab 19.4.1 declares it: every permission of one line, at one of the boundaries named. Where there are alternatives, any one is enough.

Back to the server card

1. pipeline.cancel

   Pipeline 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|integer)

   Fine-grained token: Pipeline: Update at project

2. pipeline.create

   Pipeline 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|integer), ref (string)

   Fine-grained token: Pipeline: Create at project

3. pipeline.delete

   Pipeline 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|integer)

   Fine-grained token: Pipeline: Delete at project

4. pipeline.get

   Pipeline 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|integer)

   Fine-grained token: Pipeline: Read at project

5. pipeline.latest

   Pipeline Latestread-only

   Get the latest pipeline of a ref (the default branch when ref is omitted): the one GitLab ran for the commit at its head, or, when that commit has none on the ref, the newest on the ref (the first under any filters or ordering passed). Returns: full pipeline metadata, plus head_sha and fallback_note when the pipeline ran for an earlier commit. See also: pipeline.get, pipeline.list, job.list_project.

   Required parameters: project_id (string|integer)

   Fine-grained token: Pipeline: Read at project

6. pipeline.list

   Pipeline 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|integer)

   Fine-grained token: Pipeline: Read at project

7. pipeline.resource_group_edit

   Edit Resource Group

   Update the process mode of one CI resource group by key. Returns: the updated resource group ID, key, new process mode that controls how queued jobs sharing the resource group are serialized, and created and updated times. 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|integer)

   Fine-grained token: Resource Group: Update at project

8. pipeline.resource_group_get

   Get Resource Groupread-only

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

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

   Fine-grained token: Resource Group: Read at project

9. pipeline.resource_group_list

   List Resource Groupsread-only

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

   Required parameters: project_id (string|integer)

   Fine-grained token: Resource Group: Read at project

10. pipeline.resource_group_upcoming_jobs

    List 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, stage, ref, tag and allow-failure flags, pipeline, web URL, and creation time, ordered as they will run under the resource group's process mode, with pagination metadata. See also: pipeline.resource_group_get, pipeline.resource_group_list, job.list.

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

    Fine-grained token: Job: Read and Resource Group: Read at project

11. pipeline.retry

    Pipeline 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|integer)

    Fine-grained token: Pipeline: Update at project

12. pipeline.schedule_create

    Pipeline 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|integer), ref (string)

    Fine-grained token: Pipeline Schedule: Create at project

13. pipeline.schedule_create_variable

    Pipeline Schedule Create Variable

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

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

    Fine-grained token: Pipeline Schedule: Update at project

14. pipeline.schedule_delete

    Pipeline Schedule Deletedestructive

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

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

    Fine-grained token: Pipeline Schedule: Delete at project

15. pipeline.schedule_delete_variable

    Pipeline 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|integer), schedule_id (integer)

    Fine-grained token: Pipeline Schedule: Update at project

16. pipeline.schedule_edit_variable

    Pipeline Schedule Edit Variable

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

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

    Fine-grained token: Pipeline Schedule: Update at project

17. pipeline.schedule_get

    Pipeline 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|integer), schedule_id (integer)

    Fine-grained token: Pipeline Schedule: Read at project

18. pipeline.schedule_list

    Pipeline 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|integer)

    Fine-grained token: Pipeline Schedule: Read at project

19. pipeline.schedule_list_triggered_pipelines

    Pipeline 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|integer), schedule_id (integer)

    Fine-grained token: Pipeline: Read and Pipeline Schedule: Read at project

20. pipeline.schedule_run

    Pipeline 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|integer), schedule_id (integer)

    Fine-grained token: Pipeline Schedule: Read and Pipeline Schedule: Update at project

21. pipeline.schedule_take_ownership

    Pipeline 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|integer), schedule_id (integer)

    Fine-grained token: Pipeline Schedule: Update at project

22. pipeline.schedule_update

    Pipeline 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|integer), schedule_id (integer)

    Fine-grained token: Pipeline Schedule: Update at project

23. pipeline.test_report

    Pipeline 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|integer)

    Fine-grained token: Pipeline: Read at project

24. pipeline.test_report_summary

    Pipeline 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|integer)

    Fine-grained token: Pipeline: Read at project

25. pipeline.trigger_create

    Pipeline 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|integer)

    Fine-grained token: Trigger: Create at project

26. pipeline.trigger_delete

    Pipeline Trigger Deletedestructive

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

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

    Fine-grained token: Trigger: Delete at project

27. pipeline.trigger_get

    Pipeline 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|integer), trigger_id (integer)

    Fine-grained token: Trigger: Read at project

28. pipeline.trigger_list

    Pipeline 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|integer)

    Fine-grained token: Trigger: Read at project

29. pipeline.trigger_run

    Pipeline 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|integer)

    Fine-grained token: not judged by the grant (GitLab authenticates this request another way)

30. pipeline.trigger_update

    Pipeline 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|integer), trigger_id (integer)

    Fine-grained token: Trigger: Update at project

31. pipeline.update_metadata

    Pipeline 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|integer)

    Fine-grained token: Pipeline: Update at project

32. pipeline.variables

    Pipeline Variablesread-only

    List a pipeline's runtime variables. Returns: variable keys, values, types, and whether each value is raw (not expanded). See also: pipeline.get, pipeline.create, job.list_project.

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

    Fine-grained token: Pipeline: Read at project

33. pipeline.wait

    Pipeline 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|integer)

    Fine-grained token: Pipeline: Read at project