GitLab API

GitlabTool
Join our community

Actions1000

Overview

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

Use Case Examples

  1. Automatically enable or update email notifications for push events in a GitLab group as part of a CI/CD pipeline.
  2. Manage group integration settings programmatically to ensure consistent notification policies across multiple GitLab groups.

Properties

Name Meaning
Skip Authentication Determines whether to skip API authentication for the request.
Authentication Specifies the authentication method to use if authentication is not skipped.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, defaulting to PUT for this operation.
Path Parameters The path parameters required for the API endpoint, specifically the group ID (`id`) to identify which group's integration to update.

Output

JSON

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

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the group ID (`id`) path parameter is correctly provided and corresponds to an existing GitLab group.
  • Verify that the authentication credentials are valid and have sufficient permissions to update group integrations.
  • Check the base URL to confirm it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If skipping authentication, ensure the API endpoint allows unauthenticated requests, otherwise the request will fail.

Links

Discussion