GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation updates the GitHub integration settings for a specific project in GitLab using the GitLab API. It is useful for automating the configuration of GitHub integrations within GitLab projects, such as enabling or modifying webhook URLs, tokens, or other integration parameters. For example, a DevOps engineer might use this node to programmatically update GitHub integration settings across multiple projects to ensure consistent CI/CD workflows.

Use Case Examples

  1. Updating GitHub integration settings for a project by specifying the project ID and providing the integration configuration in the request body.
  2. Automating the enabling or disabling of GitHub integration for a GitLab project as part of a deployment pipeline.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request (boolean). Default is false.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET but can be set to POST, PUT, DELETE, HEAD, or PATCH.
Path Parameters The path parameters for the API endpoint, specifically the project ID to identify which project's GitHub integration to update.

Output

JSON

  • id - The ID of the project whose GitHub integration was updated.
  • integrationStatus - The status or result of the GitHub integration update operation.
  • updatedFields - Details of the fields that were updated in the GitHub integration settings.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API key used for authentication has sufficient permissions to update project integrations.
  • Check that the request body schema matches the expected structure for GitHub integration settings to avoid validation errors.
  • If skipping authentication, ensure the GitLab instance allows unauthenticated requests for this operation, otherwise authentication errors will occur.

Links

Discussion