GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves freeze periods for a specific project from the GitLab API (v4). It is useful for users who want to programmatically access information about freeze periods configured in their GitLab projects, such as for automation or reporting purposes. For example, a DevOps engineer might use this node to fetch freeze periods to integrate with a deployment pipeline or monitoring system.

Use Case Examples

  1. Fetch freeze periods for a project with ID '123' to check scheduled freeze times before deployments.
  2. Retrieve paginated freeze periods data to display in a custom dashboard.

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 to send the request to, default is https://gitlab.com.
Method The HTTP method used for the request, default is GET.
Query Parameters Optional query parameters for pagination such as page number and items per page.
Path Parameters Path parameters including the project ID or URL-encoded path to specify which project's freeze periods to retrieve.

Output

JSON

  • freeze_periods - Array of freeze period objects returned from the GitLab API for the specified project.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID path parameter is correctly set and URL-encoded if necessary.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access project freeze periods.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure the correct API endpoint is targeted.
  • Common error messages include 401 Unauthorized (invalid or missing API key) and 404 Not Found (incorrect project ID or insufficient permissions).

Links

Discussion