GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves entities related to a specific bulk import in GitLab using the GitLab API v4. It is useful for monitoring the status and details of entities involved in a bulk import process, such as migration imports. For example, it can be used to fetch entities with a particular status (e.g., finished or failed) or paginate through the list of entities for a given import ID.

Use Case Examples

  1. Fetch all entities for a bulk import with ID 12345.
  2. Retrieve entities with status 'finished' for a specific import to check completed items.
  3. Paginate through entities by specifying page number and items per page.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request (boolean). Defaults to false.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Parameter Schema Defines the parameters for the API call including path and query parameters such as import_id (required), status, page, and per_page for filtering and pagination.
Request Body Schema Schema for the request body, not used in this GET operation.
Request Path API endpoint path with placeholder for import_id.
Query Parameters Collection of optional query parameters to filter and paginate results: status, page, per_page.
Path Parameters Collection of path parameters including import_id which identifies the specific bulk import.

Output

JSON

  • entities - List of entities related to the specified bulk import, including their status and details.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the import_id path parameter is provided and valid; missing or incorrect import_id will cause errors.
  • Check that the GitLab API key credential is correctly configured and has sufficient permissions to access bulk import data.
  • Verify the baseUrl is correct if using a self-hosted GitLab instance instead of gitlab.com.
  • If filtering by status, ensure the status value is one of the allowed enums: created, started, finished, timeout, failed, canceled.
  • Pagination parameters (page, per_page) should be positive integers; invalid values may cause API errors.

Links

Discussion