GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates the 'Emails on Push' integration settings for a specific GitLab project. It is useful for automating the configuration of email notifications triggered by push events in GitLab projects. For example, a user can programmatically enable or modify email notifications for project pushes without manually changing settings in the GitLab UI.

Use Case Examples

  1. Automatically update email notification settings for a GitLab project when a new project is created.
  2. Integrate with a CI/CD pipeline to ensure email notifications on push are configured consistently across multiple projects.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the API request.
Authentication Specifies the authentication method to use for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to PUT for this operation.
Path Parameters Parameters included in the API request path, specifically the project ID to identify which project's integration settings to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the emails-on-push integration settings for the specified project.

Dependencies

  • Requires GitLab API key credentials for authentication unless 'Skip Authentication' is enabled.

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and the project exists in GitLab.
  • Verify that the API key used has sufficient permissions to update project integrations.
  • If skipping authentication, confirm that the GitLab instance allows unauthenticated requests for this endpoint, otherwise the request will fail.
  • Check the request body schema matches the expected format for the emails-on-push integration settings to avoid validation errors.

Links

Discussion