GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves import information for a specific project in GitLab using the GitLab API v4. It is useful for scenarios where you need to check the status or details of a project import process by providing the project ID or URL-encoded path. For example, it can be used to monitor project migrations or imports from other repositories.

Use Case Examples

  1. Retrieve import status of a project by its ID to monitor migration progress.
  2. Fetch import details to verify if the project import was successful or to troubleshoot import issues.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used for the request, defaulting to GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method used for the request, default is GET.
Parameter Schema Schema defining the path parameter 'id' which is the ID or URL-encoded path of the project.
Request Body Schema Schema for the request body, not used in this operation (null).
Request Path API endpoint path template for the request, /api/v4/projects/{id}/import.
Path Parameters Collection of path parameters with 'id' as the project identifier.

Output

JSON

  • id - The ID or URL-encoded path of the project used in the request path.
  • import - Details about the import status and information of the project returned by the API.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID or URL-encoded path is correct and accessible.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access project import information.
  • Check the base URL if using a self-hosted GitLab instance instead of gitlab.com.
  • Common errors include 404 Not Found if the project does not exist or 401 Unauthorized if authentication fails.

Links

Discussion