GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates metadata for a specific pipeline within a GitLab project using the GitLab API. It is useful for automating the management of pipeline metadata, such as adding or modifying information related to CI/CD pipelines in GitLab projects. For example, it can be used to programmatically update pipeline metadata after a deployment or testing phase.

Use Case Examples

  1. Updating pipeline metadata to reflect the status of a deployment.
  2. Adding custom metadata to a pipeline for tracking purposes.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method used for the request, default is PUT for this operation.
Path Parameters Parameters specifying the project ID or URL-encoded path and the pipeline ID to identify the pipeline whose metadata is being updated.

Output

JSON

  • response - The JSON response from the GitLab API containing the updated pipeline metadata.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the project ID and pipeline ID are correct and exist in the GitLab instance.
  • Verify that the authentication token has sufficient permissions to update pipeline metadata.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • Common error messages include 401 Unauthorized (authentication issues), 404 Not Found (invalid project or pipeline ID), and 400 Bad Request (invalid request body). Resolving these involves verifying credentials, IDs, and request payload formats.

Links

Discussion