GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves a snapshot of a specific GitLab project using the GitLab API v4. It is useful for users who want to get a snapshot of a project's repository, including optionally the wiki repository, by specifying the project ID. Practical examples include automating project data retrieval for backups, audits, or integrations with other systems.

Use Case Examples

  1. Retrieve a snapshot of a project with ID 12345 to back up the repository state.
  2. Fetch the project snapshot including the wiki repository for documentation purposes.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Query Parameters Optional query parameters for the request, e.g., 'wiki' to include the wiki repository.
Path Parameters Path parameters for the request, specifically the project 'id' which is required.

Output

JSON

  • id - The ID of the project snapshot.
  • repository - The snapshot data of the project's repository.
  • wiki - The snapshot data of the project's wiki repository, if requested.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID is correctly provided in the path parameters; missing or incorrect ID will cause errors.
  • If authentication is required and skipped, the request will fail with authorization errors.
  • Check the baseUrl if using a self-hosted GitLab instance to avoid connection issues.

Links

Discussion