GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation resumes a specific batched background migration in a GitLab instance by making 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 migration tasks within GitLab, such as restarting paused or interrupted migrations.

Use Case Examples

  1. An administrator wants to resume a paused background migration with a specific ID to ensure data consistency.
  2. Automating the resumption of background migrations after maintenance or downtime.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, typically a GitLab API key.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, default is GET but can be set to 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 response from the GitLab API after attempting to resume the batched background migration.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the provided migration ID is valid and exists in the GitLab instance to avoid 404 errors.
  • Verify that the API key has sufficient permissions to perform administrative actions on batched background migrations.
  • Check network connectivity and the correctness of the base URL to prevent request failures.

Links

Discussion