GitLab API icon

GitLab API

Gitlab

Actions917

Overview

This node interacts with the GitLab API to update the Pipelines Email service settings for a specific project. It is useful for automating the configuration of email notifications related to CI/CD pipelines in GitLab projects. For example, it can be used to enable or modify email notifications for pipeline events in a project by specifying the project ID and the desired settings in the request body.

Use Case Examples

  1. Updating the pipeline email service settings for a project to customize notification recipients or email content.
  2. Automating the enabling or disabling of pipeline email notifications across multiple projects.

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 authentication.
baseUrl The base URL of the GitLab instance to which the API requests are sent.
Method The HTTP method used for the API request, defaulting to PUT for this operation.
Path Parameters The path parameters for the API request, specifically the project ID to identify which project's pipeline email service to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the pipeline email service settings.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and accessible with the authenticated user.
  • Verify that the request body conforms to the expected schema for updating the pipeline email service settings.
  • Check network connectivity and the base URL to ensure the GitLab instance is reachable.
  • Authentication errors may occur if the API key or token is invalid or lacks necessary permissions.

Links

Discussion