GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows pausing a specific batched background migration in a GitLab instance by sending a PUT request to the GitLab API endpoint `/api/v4/admin/batched_background_migrations/{id}/pause`. It is useful for administrators who need to control the execution of background migrations, for example, to temporarily halt a migration process for maintenance or troubleshooting purposes.

Use Case Examples

  1. Pausing a batched background migration with ID 123 to prevent it from running during system maintenance.
  2. Temporarily stopping a background migration to investigate issues or conflicts before resuming it later.

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 credential.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the request, defaulting to PUT for this operation.
Path Parameters The path parameter 'id' specifies the ID of the batched background migration to pause.

Output

JSON

  • id - The ID of the batched background migration that was paused.
  • status - The status of the batched background migration after the pause operation.
  • message - Any message returned by the API regarding the pause 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 correctly set to the GitLab instance URL where the migration exists.
  • Common error messages include 401 Unauthorized (authentication issues), 404 Not Found (invalid migration ID), and 400 Bad Request (invalid parameters). Resolving these involves checking credentials, IDs, and request formatting.

Links

Discussion