GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation resumes a batched background migration in a GitLab instance by sending a PUT request to the GitLab API endpoint `/api/v4/admin/batched_background_migrations/{id}/resume`. It is useful for administrators who need to manage and control background migration tasks in GitLab, such as restarting paused or interrupted migrations. For example, if a migration process was halted due to an error or maintenance, this node can be used to resume it programmatically within an automation workflow.

Use Case Examples

  1. Resuming a specific batched background migration by providing its ID to ensure data consistency and system performance.
  2. Automating the management of GitLab background migrations as part of a larger DevOps pipeline.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used for the request, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance to which the request is sent. Defaults to https://gitlab.com.
Method The HTTP method used for the request. For this operation, it is PUT.
Parameter Schema Defines the path parameter 'id' which is the batched background migration ID (integer, required).
Request Body Schema Schema for the request body payload, required for this operation.
Request Path The API endpoint path template for the operation, including the migration ID placeholder.
Path Parameters Collection of path parameters, specifically the 'id' of the batched background migration to resume.

Output

JSON

  • response - The JSON response from the GitLab API after resuming the batched background migration, typically containing status or confirmation details.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the 'id' path parameter is correctly provided and corresponds to an existing batched background migration in GitLab.
  • Verify that the API authentication credentials are valid and have sufficient permissions to perform administrative actions on batched background migrations.
  • 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 401 Unauthorized (invalid credentials), 404 Not Found (invalid migration ID), or 403 Forbidden (insufficient permissions). Resolving these involves correcting credentials, verifying migration ID, and ensuring proper access rights.

Links

Discussion