GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation allows pausing a specific batched background migration in GitLab 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 apply updates.

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, which is 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 enabled, verify that the GitLab API key credential is valid and has sufficient permissions to pause 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 '404 Not Found' if the migration ID does not exist, or '403 Forbidden' if the API key lacks necessary permissions.

Links

Discussion