GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API, specifically supporting the Geo resource's operation to proxy Git SSH receive pack requests. It is useful for automating GitLab Geo replication or synchronization tasks by sending POST requests to the GitLab Geo proxy endpoint. For example, it can be used to programmatically trigger Git SSH receive pack operations in a GitLab Geo setup.

Use Case Examples

  1. Automate GitLab Geo synchronization by sending POST requests to the /api/v4/geo/proxy_git_ssh/receive_pack endpoint.
  2. Integrate GitLab Geo proxy operations into CI/CD pipelines to manage repository replication.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the 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 request is sent, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, with options including GET, POST, PUT, DELETE, HEAD, and PATCH.
Parameter Schema Defines the schema for the parameters sent in the request body for the postApiV4GeoProxyGitSshReceivePack operation.
Request Body Schema Defines the schema for the request body for the postApiV4GeoProxyGitSshReceivePack operation.
Request Path The API endpoint path for the postApiV4GeoProxyGitSshReceivePack operation, fixed to /api/v4/geo/proxy_git_ssh/receive_pack.

Output

JSON

  • response - The JSON response returned from the GitLab API after performing the Geo proxy Git SSH receive pack operation.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access the Geo proxy endpoint.
  • Verify the baseUrl is correctly set to the target GitLab instance, especially if using a self-hosted GitLab server.
  • Check that the HTTP method is set to POST for the postApiV4GeoProxyGitSshReceivePack operation as required by the API.
  • Common errors may include authentication failures (401 Unauthorized) if the API key is invalid or missing, and 404 Not Found if the path or baseUrl is incorrect.

Links

Discussion