GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation allows resuming a specific batched background migration in GitLab 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 control and manage background migrations in their GitLab instance, such as resuming paused or interrupted migrations to ensure data consistency and system performance.

Use Case Examples

  1. An admin wants to resume a paused batched background migration with a specific ID to continue processing data changes in the GitLab database.
  2. Automating the resumption of background migrations as part of a maintenance workflow to reduce manual intervention.

Properties

Name Meaning
Skip Authentication Determines whether to skip API authentication for the request.
Authentication Specifies the authentication method to use for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET but here it should be PUT for this operation.
Path Parameters The path parameter 'id' specifies the unique identifier of the batched background migration to resume.

Output

JSON

  • id - The unique identifier of the batched background migration.
  • status - The current status of the batched background migration after resuming.
  • message - Any message returned by the API regarding the resume operation.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the 'id' path parameter is correctly set to a valid batched background migration ID; otherwise, the API will return an error.
  • If authentication is skipped, the request may fail due to lack of proper authorization.
  • Verify the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • Common error messages include 401 Unauthorized (authentication issues), 404 Not Found (invalid migration ID), and 400 Bad Request (invalid request format). Resolving these involves checking credentials, IDs, and request structure.

Links

Discussion