GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves information about a specific replicable instance from the GitLab Geo API. It is useful for scenarios where you need to fetch details about a replicator instance identified by its replicable name and replicable ID, such as synchronizing or monitoring replication status in a GitLab Geo setup.

Use Case Examples

  1. Fetch details of a package_file replicable instance with a specific ID to monitor its replication status.
  2. Retrieve information about a repository replicable instance to verify its synchronization across Geo nodes.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, default is GET.
Path Parameters Parameters used in the API request path to specify the replicable instance to retrieve.

Output

JSON

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

Dependencies

  • GitLab API authentication credential

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.
  • Common error messages may include 404 Not Found if the replicable instance does not exist, or 401 Unauthorized if authentication fails.

Links

Discussion