GitLab API

GitlabTool
Join our community

Actions1000

Overview

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

Use Case Examples

  1. Trigger synchronization of a remote mirror for project ID '123' and mirror ID '456' to ensure the mirror is up to date.
  2. Automate remote mirror syncs in GitLab projects as part of a scheduled workflow.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use if not skipping authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request.
Path Parameters Parameters used in the API request path to specify the project and remote mirror IDs.

Output

JSON

  • status - The status of the synchronization request
  • message - Any message returned from the API regarding the sync operation

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the project ID and mirror ID are correctly specified and exist in the GitLab instance.
  • Verify that the authentication credentials are valid and have sufficient permissions to trigger remote mirror syncs.
  • Check the base URL to confirm it points to the correct GitLab instance.
  • Common error messages may include authentication failures, resource not found (invalid project or mirror ID), or permission denied errors. Resolving these typically involves correcting IDs, updating credentials, or adjusting permissions.

Links

Discussion