GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API, specifically supporting the operation to POST to the /api/v4/geo/proxy_git_ssh/info_refs_upload_pack endpoint. It is useful for scenarios where you need to proxy Git SSH info refs upload pack requests through GitLab's Geo API, typically in distributed GitLab setups for geo-replication or proxying Git SSH traffic.

Use Case Examples

  1. Proxying Git SSH info refs upload pack requests in a GitLab Geo setup to ensure efficient Git operations across geo-distributed nodes.
  2. Automating GitLab Geo API interactions for managing Git SSH traffic in CI/CD pipelines or infrastructure automation.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the request. If true, the request is sent without authentication.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication. Hidden if Skip Authentication is true.
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, defaulting to GET. Options include GET, POST, PUT, DELETE, HEAD, PATCH.
Parameter Schema Defines the schema for the parameters sent in the body of the POST request to the /api/v4/geo/proxy_git_ssh/info_refs_upload_pack endpoint. This is a hidden property used internally.
Request Body Schema Defines the schema for the request body sent to the endpoint. This is a hidden property used internally.
Request Path The API endpoint path for the operation, fixed to /api/v4/geo/proxy_git_ssh/info_refs_upload_pack and hidden from the user.

Output

JSON

  • response - The JSON response returned from the GitLab API for the info_refs_upload_pack POST request.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the GitLab API credential is correctly configured and has the necessary permissions to access the Geo API endpoints.
  • Verify the baseUrl is correctly set to the GitLab instance URL, especially if using a self-hosted GitLab instance.
  • If skipping authentication, ensure the endpoint allows unauthenticated access, otherwise the request will fail with authentication errors.
  • Check that the HTTP method is set to POST for this operation, as other methods may not be supported for this endpoint.

Links

  • GitLab Geo API Documentation - Official documentation for GitLab Geo API endpoints, including proxying Git SSH info refs upload pack requests.

Discussion