GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API, specifically supporting the operation to get API v4 metadata. It allows users to configure the base URL, HTTP method, and request path to retrieve metadata from GitLab's API. This is useful for scenarios where users need to programmatically access GitLab metadata for automation, integration, or data retrieval purposes.

Use Case Examples

  1. Fetching GitLab API metadata to understand available endpoints and data structures.
  2. Automating retrieval of GitLab project metadata for reporting or synchronization tasks.

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 (GET, POST, PUT, DELETE, HEAD, PATCH).
Parameter Schema Hidden property for the parameter schema of the API request, relevant to the getApiV4Metadata operation.
Request Body Schema Hidden property for the request body schema of the API request, relevant to the getApiV4Metadata operation.
Request Path The API endpoint path for the request, defaulting to /api/v4/metadata for the getApiV4Metadata operation.

Output

JSON

  • metadata - The metadata information retrieved from the GitLab API v4 endpoint.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access the metadata endpoint.
  • Verify the baseUrl is correct and accessible from the network where the node is running.
  • If skipping authentication, ensure the endpoint allows unauthenticated access, otherwise requests will fail with authorization errors.
  • Common error messages include 401 Unauthorized (due to missing or invalid credentials) and 404 Not Found (due to incorrect path or baseUrl).

Links

Discussion