GitLab API

GitlabTool

Actions1000

Overview

This node operation retrieves details of a specific entity within a GitLab bulk import migration. It is useful for users who want to fetch information about a particular entity involved in a GitLab migration process, such as tracking the status or details of that entity during the migration.

Use Case Examples

  1. A user wants to check the status of a specific project or group entity being imported in a GitLab migration identified by import_id and entity_id.
  2. An administrator needs to verify details of an entity in a bulk import to troubleshoot or audit the migration process.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for testing or when authentication is handled externally.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method HTTP method used for the API request, defaulting to GET.
Path Parameters Parameters used in the API request path to specify the import and entity IDs for the bulk import entity to retrieve.

Output

JSON

  • import_id - The ID of the GitLab migration import.
  • entity_id - The ID of the specific entity within the bulk import.
  • entity_details - Details of the entity retrieved from the GitLab bulk import API.

Dependencies

  • GitLab API credentials for authentication

Troubleshooting

  • Ensure the import_id and entity_id path parameters are correctly set and correspond to existing migration and entity IDs in GitLab.
  • If authentication is enabled, verify that the GitLab API credentials are valid and have sufficient permissions to access bulk import data.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages may include 404 Not Found if the import or entity ID does not exist, or 401 Unauthorized if authentication fails.

Links

Discussion