GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows updating the Pipelines Email service integration for a specific GitLab project by sending a PUT request to the GitLab API endpoint `/api/v4/projects/{id}/services/pipelines-email`. It is useful for managing email notifications related to CI/CD pipelines within a GitLab project.

Use Case Examples

  1. Updating the email settings for pipeline notifications in a GitLab project to customize who receives alerts.
  2. Automating the configuration of pipeline email services across multiple projects in GitLab.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but for this operation it is PUT.
Path Parameters Parameters to be included in the request path, specifically the project ID in this case.

Output

JSON

  • id - The ID of the GitLab project for which the integration is updated.
  • serviceStatus - Status or response details of the updated Pipelines Email service integration.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID is correctly provided in the path parameters to avoid 404 errors.
  • Verify that the API key has sufficient permissions to update project service integrations.
  • Check the base URL if using a self-hosted GitLab instance to avoid connection errors.

Links

Discussion