GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation cancels a bulk import process in GitLab by sending a POST request to the GitLab API endpoint `/api/v4/bulk_imports/{import_id}/cancel`. It is useful for users who want to stop an ongoing GitLab migration or bulk import by specifying the import ID.

Use Case Examples

  1. Cancel a bulk import migration in GitLab by providing the import ID to stop the process.
  2. Use this node to programmatically manage and control bulk import operations in GitLab workflows.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL for the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method for the API request, defaulting to GET but set to POST for this operation.
Parameter Schema Defines the path parameter `import_id` which is the ID of the user's GitLab migration to be cancelled.
Request Body Schema Schema for the request body, which is null for this operation (no body required).
Request Path The API endpoint path `/api/v4/bulk_imports/{import_id}/cancel` used to cancel the bulk import.
Path Parameters Collection of path parameters including `import_id` which must be provided to identify the import to cancel.

Output

JSON

  • response - The JSON response from the GitLab API after attempting to cancel the bulk import.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the `import_id` path parameter is correctly provided and valid, otherwise the API will return an error.
  • If authentication is skipped or invalid, the API request will fail with an authentication error.
  • Check the base URL if using a self-hosted GitLab instance to ensure the request is sent to the correct server.

Links

Discussion