GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation updates the 'Emails on Push' integration settings for a specific project in GitLab. 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. Automate enabling email notifications for push events in multiple GitLab projects.
  2. Update email integration settings as part of a CI/CD pipeline to ensure consistent notification configurations.

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 request is sent.
Method The HTTP method used for the request, defaulting to GET but can be set to PUT for this operation.
Path Parameters Parameters included in the request path, specifically the project ID for this operation.

Output

JSON

  • id - The project ID specified in the path parameter.
  • integrationSettings - The updated settings of the 'Emails on Push' integration for the project.

Dependencies

  • GitLab API authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and the project exists in GitLab.
  • Verify that the authentication credentials are correctly configured and have sufficient permissions to update project integrations.
  • Check that the request body schema matches the expected structure for the 'Emails on Push' integration settings to avoid validation errors.

Discussion