GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves a snapshot of a specific project from the GitLab API (version 4). It is useful for scenarios where you need to get a snapshot of a project's current state, including optionally its wiki repository. For example, it can be used in automation workflows to back up project data or to analyze project snapshots programmatically.

Use Case Examples

  1. Retrieve a snapshot of a project by its ID to back up project data.
  2. Fetch the wiki repository snapshot of a project by setting the 'wiki' query parameter to true.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication The authentication method used for the request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to send the request to, default is https://gitlab.com.
Method The HTTP method to use for the request, default is GET.
Query Parameters Optional query parameters for the request, including 'wiki' to specify if the wiki repository should be included in the snapshot.
Path Parameters Path parameters for the request, including the required 'id' of the project to retrieve the snapshot for.

Output

JSON

  • id - The unique identifier of the project snapshot.
  • name - The name of the project.
  • description - Description of the project snapshot.
  • created_at - Timestamp when the snapshot was created.
  • wiki_included - Indicates if the wiki repository is included in the snapshot.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and exists in the GitLab instance.
  • 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.
  • If the 'wiki' query parameter is used, ensure it is a boolean value ('true' or 'false').

Links

Discussion