GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API, specifically supporting the operation to update the 'Emails on Push' service settings for a project via a PUT request to the 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. For example, it can be used in CI/CD workflows to programmatically enable or modify email notifications for project pushes.

Use Case Examples

  1. Automate enabling email notifications on push events for multiple GitLab projects.
  2. Integrate GitLab project service configuration into a larger DevOps automation pipeline.

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 requests are sent.
Method The HTTP method used for the API request, defaulting to GET but supporting PUT for this operation.
Parameter Schema Defines the parameters required for the operation, including the project ID in the path and the request body schema for the PUT operation.
Request Body Schema The schema defining the structure of the request body for the PUT operation.
Request Path The API endpoint path for the operation, with a placeholder for the project ID.
Path Parameters Collection of path parameters, specifically the project ID required to identify the project to update.

Output

JSON

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

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and accessible with the authenticated user.
  • Verify that the request body conforms to the expected schema for the Emails on Push service settings.
  • Check network connectivity and the base URL to ensure the GitLab instance is reachable.
  • Authentication errors may occur if the API key is missing, invalid, or lacks sufficient permissions.

Links

Discussion