GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation triggers a synchronization of a remote mirror for a specific project in GitLab. It is useful for developers or DevOps engineers who manage GitLab projects with remote mirrors and need to manually sync the mirror to ensure it is up-to-date. For example, after pushing changes to a repository, this operation can be used to sync the remote mirror to reflect those changes.

Use Case Examples

  1. Sync a remote mirror of a GitLab project by specifying the project ID and the mirror ID to ensure the mirror repository is current.
  2. Trigger a manual sync of a remote mirror when automatic syncing is disabled or delayed.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET but POST is used for this operation.
Path Parameters Parameters for the API path including project ID and remote mirror ID.

Output

JSON

  • status - The status of the sync operation.
  • message - Any message returned from the sync operation, such as success or error details.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and mirror ID are correct and exist in the GitLab instance.
  • Verify that the API key used for authentication has sufficient permissions to trigger mirror syncs.
  • Check network connectivity to the GitLab instance, especially if using a self-hosted GitLab with a custom base URL.
  • If the operation fails, review the error message returned in the response for clues, such as permission denied or resource not found.

Links

Discussion