GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves details of a specific freeze period for a given project in GitLab using the GitLab API. It is useful for scenarios where users need to fetch information about freeze periods, such as maintenance windows or restricted times, associated with a project. For example, a DevOps engineer might use this to check freeze period details before scheduling deployments.

Use Case Examples

  1. Fetch freeze period details for project ID '123' and freeze period ID '456' to verify maintenance schedules.
  2. Retrieve freeze period information to display in a project management dashboard.

Properties

Name Meaning
Skip Authentication Option to skip API authentication, useful for public or unauthenticated requests.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method used for the API request, default is GET.
Path Parameters Parameters to specify the project ID and freeze period ID for the API request.

Output

JSON

  • id - The unique identifier of the freeze period.
  • start_date - The start date of the freeze period.
  • end_date - The end date of the freeze period.
  • duration - Duration of the freeze period.
  • description - Description or notes about the freeze period.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and freeze period ID are correctly provided and exist in GitLab to avoid 404 errors.
  • Check API authentication credentials if receiving 401 Unauthorized errors.
  • Verify the base URL is correct, especially if using a self-hosted GitLab instance.
  • If skipping authentication, ensure the API endpoint supports unauthenticated access.

Links

Discussion