GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves the merge reference information for a specific merge request in a GitLab project using the GitLab API. It is useful for scenarios where you need to programmatically access details about the merge reference of a merge request, such as in CI/CD pipelines, automation workflows, or integration with other tools.

Use Case Examples

  1. Get the merge reference of a merge request to verify its status before merging.
  2. Fetch merge request details to trigger downstream automation based on merge request state.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the API request.
Authentication The authentication method used for the API request, typically an API key or token.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the API request, default is GET.
Path Parameters Parameters required in the API path to identify the project and merge request.

Output

JSON

  • id - The ID or URL-encoded path of the project.
  • merge_request_iid - The internal ID of the merge request.
  • merge_ref - The merge reference information of the specified merge request.

Dependencies

  • GitLab API authentication token or API key

Troubleshooting

  • Ensure the project ID and merge request IID are correctly specified and exist in the GitLab instance.
  • Verify that the authentication token has sufficient permissions to access the merge request details.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion