GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation updates a remote mirror for a specific project in GitLab using the GitLab API. It is useful for managing remote mirrors of GitLab projects, such as modifying mirror settings or updating mirror details. For example, a user can update the URL or authentication settings of a remote mirror associated with a project.

Use Case Examples

  1. Updating the URL of a remote mirror for a project.
  2. Changing authentication settings for a remote mirror.

Properties

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

Output

JSON

  • response - The JSON response from the GitLab API after updating the remote mirror.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and mirror ID are correctly specified and URL-encoded if necessary.
  • Verify that the GitLab API key has sufficient permissions to update remote mirrors.
  • Check the base URL is correct for the GitLab instance being accessed.
  • Common errors include authentication failures, invalid project or mirror IDs, and permission denied errors.

Links

Discussion