GitLab API

GitlabTool
Join our community

Actions1000

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 obtain 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 a project snapshot including the wiki repository for documentation purposes.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance to send the request to.
Method The HTTP method to use for the request, defaulting to GET.
Query Parameters Optional query parameters for the request, such as 'wiki' to include the wiki repository in the snapshot.
Path Parameters Path parameters for the request, specifically the project ID to identify which project's snapshot to retrieve.

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 authentication token or credentials

Troubleshooting

  • Ensure the project ID path parameter is correctly set and is a valid integer; otherwise, the API request will fail.
  • If authentication is skipped, ensure the GitLab instance allows unauthenticated access to project snapshots, or the request will be denied.
  • Check the baseUrl to ensure it points to a valid GitLab instance; incorrect URLs will cause connection errors.
  • If the 'wiki' query parameter is set, ensure it is a valid boolean value ('true' or 'false') to avoid request errors.

Links

Discussion