GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates a remote mirror of a GitLab project using the GitLab API. It is useful for managing remote mirrors of projects hosted on GitLab, allowing users to modify mirror settings or details by specifying the project ID and mirror ID. For example, it can be used to update the URL or configuration of a remote mirror to keep it in sync with the main repository.

Use Case Examples

  1. Updating the URL of a remote mirror for a specific GitLab project.
  2. Changing the mirror settings such as enabling or disabling mirroring for a project.

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 PUT for this operation.
Parameter Schema Defines the required path parameters and request body schema for the operation, including project ID, mirror ID, and the body payload for updating the mirror.
Request Body Schema The schema of the request body used to update the remote mirror.
Request Path The API endpoint path for updating a remote mirror, with placeholders for project ID and mirror ID.
Path Parameters Collection of path parameters including the project ID and mirror ID required to identify the remote mirror to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the remote mirror, containing details of the updated mirror.

Dependencies

  • Requires GitLab API key authentication unless skipping authentication is enabled.

Troubleshooting

  • Ensure the project ID and mirror ID are correctly specified and URL-encoded if necessary.
  • Verify that the API key has sufficient permissions to update remote mirrors on the GitLab project.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • Common errors include authentication failures, invalid project or mirror IDs, and insufficient permissions.

Links

Discussion