GitLab API icon

GitLab API

Gitlab

Actions1062

Projects → putApiV4ProjectsIdPipelinesPipelineIdMetadata

AI-generated

Summary

Update the metadata of a specific pipeline in a GitLab project by sending a PUT request to the appropriate API endpoint.

Inputs

  • id (required) — The project ID or URL-encoded path identifying the GitLab project.
  • pipeline_id (required) — The numeric ID of the pipeline whose metadata is to be updated.
  • putApiV4ProjectsIdPipelinesPipelineIdMetadata (required) — The request body containing the metadata fields to update for the specified pipeline.
  • Skip Authentication — Optionally skip authentication if set to true (default is false).
  • baseUrl — The base URL for the GitLab instance, defaulting to https://gitlab.com if not specified.

Output shape

the JSON response from GitLab representing the updated pipeline metadata

The operation returns the updated metadata for the pipeline specified by the project ID and pipeline ID path parameters. Authentication via GitLab API credentials is used unless explicitly skipped. The base URL parameter allows targeting self-hosted GitLab instances.

Examples

Example 1: Update pipeline metadata

Set 'id' to the project identifier, 'pipeline_id' to the target pipeline, and provide the updated metadata in the request body schema 'putApiV4ProjectsIdPipelinesPipelineIdMetadata'. Optionally override baseUrl or skip authentication if necessary.

Links

Discussion