GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves details about a specific integration for a GitLab group using the GitLab API v4. It is useful for automating the management and monitoring of group integrations in GitLab, such as Slack, Jira, or Jenkins integrations. For example, a user can fetch the configuration of a Slack integration for a particular group to verify or update its settings programmatically.

Use Case Examples

  1. Fetch the Slack integration details for a GitLab group with ID 12345 to check its configuration.
  2. Retrieve the Jira integration information for a group to automate issue tracking setup.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key 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 used for the API request, defaulting to GET.
Parameter Schema Defines the path parameters required for the API request, including the integration slug and group ID.
Request Body Schema Schema for the request body, not used in this GET operation.
Request Path The API endpoint path template used for the request, including placeholders for group ID and integration slug.
Path Parameters Collection of path parameters including 'slug' (the integration name) and 'id' (the group ID) required to construct the API request URL.

Output

JSON

  • id - The ID of the GitLab group.
  • slug - The slug (name) of the integration.
  • integrationDetails - Details about the specified integration for the group, including configuration and status.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the group ID and integration slug are correctly specified and exist in the GitLab instance.
  • If authentication is enabled, verify that the API key has sufficient permissions to access group integrations.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure the URL is correct.
  • Common error messages include 404 Not Found if the group or integration does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion