GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves the list of protected tags for a specific project in GitLab using the GitLab API v4. It is useful for users who want to manage or audit protected tags within their GitLab projects, such as ensuring certain tags are safeguarded from deletion or modification. For example, a DevOps engineer might use this node to fetch protected tags to verify compliance with release management policies.

Use Case Examples

  1. Fetch protected tags for a project to display in a dashboard.
  2. Automate auditing of protected tags to ensure critical tags are not accidentally removed.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the API request.
Authentication Select the authentication method to use for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Optional query parameters for pagination, including page number and number of items per page.
Path Parameters Path parameters required for the API endpoint, specifically the project ID or URL-encoded path.

Output

JSON

  • id - The unique identifier of the protected tag.
  • name - The name of the protected tag.
  • create_access_levels - Access levels that are allowed to create the protected tag.
  • update_access_levels - Access levels that are allowed to update the protected tag.
  • delete_access_levels - Access levels that are allowed to delete the protected tag.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly provided; otherwise, the API will return an error.
  • If authentication is skipped, the API may reject the request due to lack of permissions.
  • Pagination parameters (page and per_page) should be set correctly to avoid missing data or excessive data retrieval.
  • Common error messages include 401 Unauthorized (check API key), 404 Not Found (check project ID), and 400 Bad Request (check parameter formats).

Links

Discussion