GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node interacts with the GitLab API to retrieve the API version information from the endpoint `/api/v4/version`. It is useful for scenarios where you need to verify the GitLab API version or check the availability of the API before performing further operations. For example, it can be used in automation workflows to ensure compatibility with specific GitLab API versions.

Use Case Examples

  1. Checking the GitLab API version before running deployment scripts.
  2. Verifying API version in a monitoring workflow to alert if the API changes.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication when making the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, defaulting to GET.
Parameter Schema Hidden property for parameter schema, not user-configurable.
Request Body Schema Hidden property for request body schema, not user-configurable.
Request Path The API endpoint path to request, fixed to `/api/v4/version` for this operation.

Output

JSON

  • version - The GitLab API version information retrieved from the `/api/v4/version` endpoint.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • If authentication is skipped but the GitLab instance requires authentication, the request may fail with an authorization error. Ensure the correct authentication method is used.
  • Incorrect baseUrl may lead to connection errors or 404 responses. Verify the GitLab instance URL is correct.
  • Using an unsupported HTTP method for this endpoint may result in errors; typically, GET is used for version retrieval.

Links

Discussion