GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

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 request.
Authentication The authentication method used for the request, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET but here it will be DELETE for this operation.
Path Parameters Parameters required in the request path to identify the project and the remote mirror to delete.

Output

JSON

  • statusCode - The HTTP status code returned by the API indicating the result of the delete operation.
  • body - The response body from the API, typically empty for a successful delete operation.

Dependencies

  • GitLab API authentication credential

Troubleshooting

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

Links

Discussion