GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API to update the GitHub integration settings for a specific GitLab project. It is useful for automating the configuration of GitHub integrations within GitLab projects, such as enabling or modifying webhook settings or other integration parameters. For example, a user can update the GitHub integration for a project by specifying the project ID and the desired integration settings in the request body.

Use Case Examples

  1. Updating GitHub integration settings for a GitLab project by providing the project ID and new configuration parameters.
  2. Automating the management of GitHub integrations across multiple GitLab projects in a CI/CD pipeline.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication Type of authentication used, hidden and defaults to GitLab API key credential.
baseUrl Base URL for the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is PUT.
Parameter Schema Schema defining the path parameter 'id' (project ID) and the request body for the GitHub integration update, hidden from UI.
Request Body Schema Schema for the request body payload, hidden from UI.
Request Path API endpoint path template for updating GitHub integration of a project, hidden from UI.
Path Parameters Collection of path parameters, specifically the 'id' of the project to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the GitHub integration for the specified project.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and exists in GitLab.
  • Verify that the authentication credentials (GitLab API key) are correctly configured and have sufficient permissions to update project integrations.
  • Check that the request body conforms to the expected schema for the GitHub integration update; invalid or incomplete data may cause API errors.
  • If skipping authentication, be aware that the request may fail due to lack of authorization.

Links

Discussion