GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation triggers a synchronization of a specific remote mirror for a GitLab project. It is useful for automating the process of syncing remote mirrors in GitLab projects, ensuring that the mirrored repositories are up-to-date. For example, it can be used in CI/CD pipelines or project maintenance workflows to programmatically sync remote mirrors without manual intervention.

Use Case Examples

  1. Triggering a sync for a remote mirror of a project after a code update.
  2. Automating remote mirror synchronization as part of a scheduled maintenance task.

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, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to POST.
Path Parameters Parameters for the API path, including the project ID or URL-encoded path and the remote mirror ID.

Output

JSON

  • status - The status of the sync operation.
  • message - Any message returned from the sync operation.

Dependencies

  • GitLab API authentication token

Troubleshooting

  • Ensure the project ID and mirror ID are correctly specified and URL-encoded if necessary.
  • Verify that the authentication token has sufficient permissions to trigger remote mirror syncs.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • Common error messages include authentication failures, invalid project or mirror IDs, and permission denied errors. Resolving these typically involves correcting credentials, parameters, or access rights.

Links

Discussion