GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

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

Use Case Examples

  1. Fetch details of the Slack integration for a GitLab project with ID 12345.
  2. Retrieve the configuration of the Jira integration for a specific project to audit integration settings.

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 project ID and the integration slug (name).
Request Body Schema Schema for the request body, which is null for this GET operation.
Request Path The API endpoint path template used for the request, with placeholders for project ID and integration slug.
Path Parameters Collection of path parameters including 'slug' (integration name) and 'id' (project ID) used to construct the API request URL.

Output

JSON

  • id - The project ID for which the integration details are retrieved.
  • slug - The integration name (slug) used to identify the specific integration.
  • integrationDetails - The detailed information about the specified integration for the project, including configuration and status.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and integration slug are correctly specified and exist in the GitLab instance.
  • Verify that the API key credential has sufficient permissions to access project integrations.
  • If skipping authentication, the API endpoint must allow unauthenticated access, which is uncommon for project integrations.
  • Common error messages include 404 Not Found if the project or integration does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion