GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to update (PATCH) a specific package protection rule within a project. It is useful for automating the management of package protection rules in GitLab projects, such as modifying access controls or rule settings programmatically. For example, a user can update the protection rules for packages in a project to enforce new security policies or adjust permissions without manually using the GitLab web interface.

Use Case Examples

  1. Updating a package protection rule to restrict package access to certain user roles.
  2. Modifying the settings of a package protection rule to comply with new organizational policies.

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 key 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 PATCH for this operation.
Path Parameters Parameters required in the URL path to identify the project and the specific package protection rule to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the package protection rule, containing the updated rule details.

Dependencies

  • Requires GitLab API key credentials for authentication.

Troubleshooting

  • Ensure the project ID and package protection rule ID are correct and exist in the GitLab instance.
  • Verify that the API key has sufficient permissions to update package protection rules in the project.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common errors include authentication failures (invalid or missing API key), resource not found (incorrect IDs), and permission denied errors.

Links

Discussion