GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves details of a specific integration for a given project in GitLab using the GitLab API v4. It is useful for users who want to programmatically access integration settings or status for a project, such as fetching configuration details for integrations like Slack, Jira, or Jenkins within a GitLab project.

Use Case Examples

  1. Fetch the Slack integration details for a project with ID 12345 to verify its configuration.
  2. Retrieve the Jira integration information for a project to check if it is active and properly set up.

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, including placeholders for project ID and integration slug.
Path Parameters Collection of path parameters specifying the project ID and integration slug to identify the integration to retrieve.

Output

JSON

  • id - The unique identifier of the integration.
  • project_id - The ID of the project 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 - Boolean indicating if the integration is active.
  • properties - Additional properties and configuration details specific to the integration.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and integration slug are correctly specified; incorrect values will result in a 404 Not Found error.
  • If authentication is required and skipped, the API request will fail with an authentication error; ensure credentials are provided unless skipping authentication is intentional.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure the API endpoint is reachable.

Links

Discussion