GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation performs a PUT request to update the Pipelines Email integration settings for a specific project in GitLab. It is useful for automating the configuration of email notifications related to CI/CD pipelines within GitLab projects. For example, it can be used to programmatically enable or modify email alerts for pipeline events in a project.

Use Case Examples

  1. Updating the email integration settings for a GitLab project to customize pipeline notification recipients.
  2. Automating the management of pipeline email integrations across multiple GitLab projects.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used for the request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is PUT for this operation.
Path Parameters The path parameters for the request, specifically the project ID (id) which is required to identify the project to update the integration for.

Output

JSON

  • response - The JSON response from the GitLab API after updating the pipelines email integration settings.

Dependencies

  • Requires GitLab API key credentials for authentication.

Troubleshooting

  • Ensure the project ID (path parameter 'id') is correctly provided and corresponds to an existing project in GitLab.
  • Verify that the API key used has sufficient permissions to update project integrations.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • Common errors include authentication failures (invalid or missing API key) and 404 errors if the project ID does not exist.

Links

Discussion