GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation allows updating the 'Emails on Push' service integration for a specific GitLab project by sending a PUT request to the GitLab API endpoint `/api/v4/projects/{id}/services/emails-on-push`. It is useful for automating the configuration of email notifications triggered by push events in GitLab projects.

Use Case Examples

  1. Automatically enable or update email notifications for push events in a GitLab project as part of a CI/CD pipeline.
  2. Manage project service integrations programmatically to ensure consistent notification settings 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 key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the request, defaulting to PUT for this operation.
Path Parameters The path parameters required for the API endpoint, specifically the project ID ('id') to identify the target project for the service update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the Emails on Push service integration for the specified project.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID ('id') path parameter is correctly provided and corresponds to an existing project in GitLab.
  • Verify that the API key used for authentication has sufficient permissions to update project service integrations.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages include 401 Unauthorized (authentication failure), 404 Not Found (invalid project ID or service endpoint), and 400 Bad Request (invalid request body). Resolving these involves verifying credentials, project existence, and request payload format.

Links

Discussion