GitLab API icon

GitLab API

Gitlab

Actions1062

Projects → postApiV4ProjectsIdPipelinesPipelineIdCancel

AI-generated

Summary

Cancel a specific pipeline of a GitLab project by providing the project ID and the pipeline ID.

Inputs

  • id (required) — The project ID or URL-encoded path identifying the GitLab project.
  • pipeline_id (required) — The pipeline ID of the pipeline to cancel within the specified project.
  • Skip Authentication — Whether to skip authentication for this request; defaults to false.
  • baseUrl — The base URL of the GitLab instance; defaults to 'https://gitlab.com'.

Output shape

a JSON object representing the cancelled pipeline's status and details as returned by the GitLab API

The operation makes a POST request to /api/v4/projects/{id}/pipelines/{pipeline_id}/cancel and returns the API response for the cancelled pipeline. Authentication is required unless skipped. The response format depends on the GitLab API.

Examples

Example 1: Cancel a pipeline

Set 'id' to the project ID, 'pipeline_id' to the pipeline ID, and execute the operation to cancel that pipeline.

Links

Discussion