GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to retrieve information about a specific replicable instance in a Geo replicator setup. It is useful for scenarios where you need to fetch details about a replicable resource identified by its name and ID within a GitLab Geo environment. For example, it can be used to monitor replication status or retrieve metadata of a package file or other replicable entities in a distributed GitLab setup.

Use Case Examples

  1. Retrieve details of a package file replicable instance by specifying its replicable name and ID.
  2. Fetch replication information for a specific replicable resource in a GitLab Geo environment.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the request is sent.
Method HTTP method used for the request, default is GET.
Path Parameters Parameters to specify the replicable name and replicable ID for the Geo replicator instance.

Output

JSON

  • response - The JSON response from the GitLab API containing details about the replicable instance.

Dependencies

  • Requires GitLab API key credential for authentication.

Troubleshooting

  • Ensure the replicable_name and replicable_id path parameters are correctly set and valid, as incorrect values will result in API errors.
  • If authentication is enabled, verify that the GitLab API key credential is correctly configured and has sufficient permissions.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion