GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation interacts with the GitLab API to retrieve details about a specific integration for a group by its ID and integration slug. It is useful for scenarios where you need to programmatically access or manage group integrations in GitLab, such as fetching configuration details for integrations like Slack, Jira, or Jenkins within a GitLab group.

Use Case Examples

  1. Fetch the Slack integration details for a GitLab group by providing the group ID and the 'slack' slug.
  2. Retrieve the configuration of the Jira integration for a specific GitLab group to verify or audit integration settings.

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. Hidden if Skip Authentication is true.
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.
Path Parameters Parameters required in the API request path, including the group ID and the integration slug to specify which integration to retrieve.

Output

JSON

  • id - The unique identifier of the integration.
  • group_id - The ID of the group to which the integration belongs.
  • slug - The slug name of the integration.
  • title - The display title of the integration.
  • description - A description of the integration.
  • active - Indicates whether the integration is active.
  • properties - Additional properties and configuration details of the integration.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the group ID and integration slug are correctly provided and valid; otherwise, the API may return a 404 Not Found error.
  • If authentication is enabled, verify that the GitLab API credential is correctly configured and has sufficient permissions to access group integrations.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure the URL is correct and accessible.

Links

Discussion