GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation deletes a remote mirror from a specified GitLab project using the GitLab API. It is useful for managing project mirrors by removing outdated or unnecessary remote mirrors. For example, if a project has a remote mirror that is no longer needed or is misconfigured, this operation can be used to delete it by specifying the project ID and the mirror ID.

Use Case Examples

  1. Deleting a remote mirror from a GitLab project to stop synchronization with an external repository.
  2. Removing a remote mirror that was created by mistake or is no longer valid.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method used for the request, defaulting to GET but can be set to DELETE for this operation.
Parameter Schema Defines the required path parameters for the operation: project ID and mirror ID.
Request Body Schema Schema for the request body, which is null for this delete operation.
Request Path The API endpoint path template for deleting a remote mirror from a project.
Path Parameters Collection of path parameters including the project ID and the mirror ID to identify the remote mirror to delete.

Output

JSON

  • response - The response from the GitLab API after attempting to delete the remote mirror, typically indicating success or failure.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and mirror ID are correct and exist in the GitLab instance.
  • Verify that the API key used has sufficient permissions to delete remote mirrors on the project.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 404 Not Found if the project or mirror does not exist, and 403 Forbidden if the API key lacks permissions.

Links

Discussion