GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves freeze periods for a specific project in GitLab using the GitLab API. It is useful for scenarios where users need to manage or monitor project freeze periods, such as automating project maintenance windows or enforcing deployment restrictions during freeze times. For example, a DevOps engineer might use this node to fetch freeze periods to integrate with a CI/CD pipeline to prevent deployments during those times.

Use Case Examples

  1. Fetch freeze periods for a project with ID '123' to check when deployments are restricted.
  2. Automate notifications to a team about upcoming freeze periods in a project.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key.
baseUrl Base URL of the GitLab instance to which the API request is sent.
Method HTTP method used for the API request, default is GET.
Query Parameters Optional query parameters for pagination, including page number and items per page.
Path Parameters Path parameters specifying the project ID or URL-encoded path to identify the project.

Output

JSON

  • freeze_periods - Array of freeze period objects retrieved from the GitLab project.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in path parameters is correct and accessible with the provided authentication.
  • Verify that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • Check API rate limits and permissions associated with the GitLab API key to avoid authorization errors.

Links

Discussion