GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API, specifically supporting the operation to get the API v4 version information. It is useful for workflows that need to verify or retrieve the current version of the GitLab API being used, which can help in ensuring compatibility or for informational purposes.

Use Case Examples

  1. A workflow that checks the GitLab API version before performing other API calls to ensure compatibility.
  2. A monitoring workflow that logs the GitLab API version periodically for auditing or debugging.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, hidden unless Skip Authentication is false.
baseUrl The base URL of the GitLab instance to which the API requests are sent.
Method The HTTP method used for the API request.
Parameter Schema Schema for parameters used in the getApiV4Version operation, hidden in the UI.
Request Body Schema Schema for the request body used in the getApiV4Version operation, hidden in the UI.
Request Path The API endpoint path for the getApiV4Version operation, hidden in the UI.

Output

JSON

  • version - The version information of the GitLab API v4 returned from the endpoint.

Dependencies

  • An API key credential for GitLab API authentication

Troubleshooting

  • If authentication is skipped but the GitLab instance requires authentication, the request may fail with an authorization error. Ensure Skip Authentication is set correctly.
  • Incorrect baseUrl can lead to connection errors or 404 responses. Verify the baseUrl is correct for your GitLab instance.
  • If the API endpoint path is changed or incorrect, the node will fail to retrieve the version information.

Links

Discussion