GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves entities related to bulk imports from the GitLab API (version 4). It is useful for users who want to monitor or manage bulk import processes in GitLab, such as checking the status or details of migrations. For example, a user can fetch a paginated list of bulk import entities, filter them by status, or sort them by creation date.

Use Case Examples

  1. Fetch the first page of bulk import entities with 20 items per page, sorted by creation date in descending order.
  2. Retrieve bulk import entities filtered by status 'finished' to see completed migrations.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Type of authentication used for the request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the API requests are sent.
Method HTTP method used for the API request, default is GET.
Query Parameters Parameters to customize the API request such as pagination, sorting, and filtering by status.

Output

JSON

  • entities
    • page - Current page number of the results
    • per_page - Number of items per page in the results
    • sort - Sort order applied to the results
    • status - Status filter applied to the results
    • data - Array of bulk import entity objects with details such as status, creation date, and other metadata

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access bulk import data.
  • 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 parameter errors, or network connectivity issues. Resolving these involves checking credentials, parameter values, and network access.

Links

Discussion