GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to retrieve information about batched background migrations in a GitLab instance. It is useful for administrators who need to monitor or manage background migration tasks that are processed in batches within GitLab. For example, an admin can use this node to query the status or details of these migrations across different databases such as main, ci, or geo.

Use Case Examples

  1. An admin wants to check the status of batched background migrations on the main database to ensure all migrations are running smoothly.
  2. A DevOps engineer uses the node to fetch migration details from the ci database to troubleshoot migration issues during continuous integration.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication when making 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.
Parameter Schema Defines the query parameter 'database' to specify which database's migrations to query, with options like main, ci, sec, embedding, and geo.
Request Body Schema Schema for the request body, which is null for this GET operation.
Request Path The API endpoint path for fetching batched background migrations.
Query Parameters Collection of query parameters, including 'database' to specify the target database for the migration query.

Output

JSON

  • response - The JSON response from the GitLab API containing details about the batched background migrations.

Dependencies

  • GitLab API key credential

Troubleshooting

  • If authentication fails, ensure the GitLab API key credential is correctly configured and has sufficient permissions.
  • If the API request returns an error, verify the baseUrl is correct and the specified database parameter is valid.
  • Network issues or incorrect baseUrl can cause request failures; check connectivity and URL correctness.

Links

Discussion