GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows updating the Irker integration settings for a specific GitLab group by sending a PUT request to the GitLab API endpoint `/api/v4/groups/{id}/integrations/irker`. It is useful for managing group-level integrations programmatically, such as enabling or configuring notifications via Irker for GitLab groups.

Use Case Examples

  1. Updating the Irker integration settings for a GitLab group with a given group ID.
  2. Automating the configuration of group integrations in GitLab as part of a CI/CD pipeline or administrative workflow.

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 API request is sent, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET but settable to POST, PUT, DELETE, HEAD, or PATCH.
Path Parameters Parameters to be included in the request path, specifically the group ID (`id`) for the API endpoint.

Output

JSON

  • response - The JSON response from the GitLab API after updating the Irker integration for the specified group.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the group ID (`id`) path parameter is correctly provided and valid, as missing or incorrect IDs will cause the API request to fail.
  • Verify that the authentication credentials are correctly configured unless skipping authentication is enabled.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages may include authentication failures, invalid group ID errors, or permission denied errors if the API token lacks sufficient rights to update group integrations.

Links

Discussion