GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

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 by specifying the migration ID.

Use Case Examples

  1. An admin wants to resume a specific background migration that was paused due to an error or maintenance.
  2. Automating the resumption of background migrations after a system update or downtime.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication Select the authentication method to use for the API request (GitLab API key).
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method HTTP method used for the API request, default is PUT for this operation.
Path Parameters Parameters included in the API request path, 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 including status and details of the resumed migration.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the migration ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API key used has sufficient permissions to resume background migrations.
  • Check the base URL to confirm it points to the correct GitLab instance.
  • Common error messages include 404 Not Found if the migration ID does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion