GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves details of a specific entity from a GitLab bulk import migration using the GitLab API. It is useful for users who want to programmatically access information about entities involved in a bulk import process in GitLab, such as migration status or metadata. For example, a user can fetch the status of a particular project or group being imported in a migration.

Use Case Examples

  1. Fetch details of a project entity in a GitLab bulk import migration by providing the import ID and entity ID.
  2. Monitor the progress of a specific entity in a bulk import to automate migration workflows.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, defaulting to GET.
Path Parameters The path parameters required for the API endpoint, specifically the import ID and entity ID identifying the bulk import and entity respectively.

Output

JSON

  • id - The unique identifier of the entity in the bulk import.
  • status - The current status of the entity import process.
  • created_at - Timestamp when the entity import was created.
  • updated_at - Timestamp when the entity import was last updated.
  • entity_type - The type of entity being imported (e.g., project, group).
  • details - Additional details or metadata about the entity import.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the import_id and entity_id path parameters are correctly provided and valid integers.
  • Verify that the GitLab API key credential has sufficient permissions to access bulk import data.
  • Check the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • Common error messages include 404 Not Found if the import or entity ID does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion