GitLab API

GitlabTool
Join our community

Actions905

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 mirroring tasks where SSH receive pack operations need to be proxied through the API. For example, it can be used to programmatically handle Git push operations in a Geo secondary node setup.

Use Case Examples

  1. Automate GitLab Geo replication by proxying SSH receive pack requests.
  2. Integrate GitLab Geo SSH operations into CI/CD workflows.

Properties

Name Meaning
Skip Authentication Determines whether to skip API authentication for the request.
Authentication Specifies the authentication method to use, typically a GitLab API key credential.
baseUrl The base URL of the GitLab instance to which the request is sent, defaulting to https://gitlab.com.
Method HTTP method to use for the request, such as GET, POST, PUT, DELETE, HEAD, or PATCH.
Parameter Schema Defines the schema for the parameters sent in the request body for the postApiV4GeoProxyGitSshReceivePack operation.
Request Body Schema Schema for the request body payload, specific to 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 proxying the Git SSH receive pack request.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Authentication errors if the API key is missing or invalid. Ensure the GitLab API key credential is correctly configured.
  • Incorrect baseUrl may cause connection failures. Verify the GitLab instance URL is correct.
  • HTTP method mismatch can cause API errors. Use POST method for the postApiV4GeoProxyGitSshReceivePack operation as required by the API.

Links

Discussion