GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to pause a specific batched background migration by its ID. It is useful for administrators who need to manage and control background migration tasks within GitLab, such as temporarily halting a migration process for maintenance or troubleshooting purposes.

Use Case Examples

  1. Pausing a batched background migration with a given ID to prevent it from running temporarily.
  2. Automating the control of background migrations in GitLab as part of a larger workflow for system maintenance.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, defaulting to PUT for this operation.
Path Parameters Parameters included in the API request path, specifically the ID of the batched background migration to pause.

Output

JSON

  • response - The JSON response from the GitLab API after attempting to pause the batched background migration, typically including status and details of the migration.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the provided migration ID is valid and exists in the GitLab instance to avoid 404 errors.
  • Verify that the API authentication credentials are correct and have sufficient permissions to pause migrations.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion