GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows updating the 'Emails on Push' service integration settings 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 Option to skip API authentication for the request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET but PUT is used for this operation.
Path Parameters Parameters to be included in the request path, specifically the project ID for this operation.

Output

JSON

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

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and the user has permission to update the project service.
  • Verify that the authentication credentials are correctly configured unless skipping authentication is enabled.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common errors include 401 Unauthorized (authentication issues), 404 Not Found (invalid project ID or service endpoint), and 400 Bad Request (invalid request body).

Links

Discussion