GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node interacts with the GitLab API to retrieve metadata from the endpoint `/api/v4/metadata`. It supports making HTTP requests with various methods (GET, POST, PUT, DELETE, HEAD, PATCH) to the specified path, primarily used to fetch metadata information from GitLab's API v4. This is useful for scenarios where users need to programmatically access GitLab metadata for automation, integration, or monitoring purposes.

Use Case Examples

  1. Fetching GitLab instance metadata to monitor API version and status.
  2. Automating retrieval of GitLab metadata for integration with other tools.

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, used internally.
Request Body Schema Hidden property for the request body schema of the API request, used internally.
Request Path The API endpoint path, fixed to `/api/v4/metadata` for this operation.

Output

JSON

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

Dependencies

  • GitLab API key credential for authentication unless skipping authentication is enabled.

Troubleshooting

  • If authentication is required but skipped, the request may fail with authorization errors. Ensure the correct API key is provided or skip authentication only if the endpoint allows it.
  • Incorrect baseUrl may lead to connection errors. Verify the GitLab instance URL is correct.
  • Using unsupported HTTP methods for this endpoint may result in errors. Use the GET method unless the API documentation specifies otherwise.

Links

Discussion