GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation fetches entities related to bulk imports from the GitLab API (version 4). It is useful for retrieving information about GitLab migration entities, such as their status, sorting order, and pagination details. Practical applications include monitoring the progress of bulk import tasks, filtering entities by status, and managing large sets of migration data efficiently.

Use Case Examples

  1. Retrieve the first page of bulk import entities sorted by creation date in descending order.
  2. Filter bulk import entities to show only those with a 'finished' status.
  3. Adjust the number of entities returned per page to manage data volume.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API requests are sent.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Collection of optional query parameters to filter and paginate the bulk import entities.

Output

JSON

  • entities
    • page - Current page number of the results.
    • per_page - Number of entities per page.
    • sort - Sort order applied to the entities.
    • status - Status filter applied to the entities.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access bulk import entities.
  • Verify the baseUrl is correct and points to a valid GitLab instance.
  • Check that query parameters like page, per_page, sort, and status are valid and supported by the GitLab API.
  • Common error messages may include authentication failures, invalid query parameters, or network connectivity issues. Resolving these typically involves verifying credentials, correcting parameter values, and ensuring network access.

Links

Discussion