GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves details of a specific freeze period for a given project in GitLab. 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 authentication for the request.
Authentication Type of authentication used, defaulting to GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Path Parameters Parameters for the API path including project ID and freeze period ID.

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.
  • created_at - Timestamp when the freeze period was created.
  • updated_at - Timestamp when the freeze period was last updated.
  • project_id - The ID of the project associated with the freeze period.
  • description - Description or notes about the freeze period.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and freeze period ID are correctly provided and exist in GitLab to avoid 404 errors.
  • If authentication is enabled, verify that the GitLab API key is valid and has sufficient permissions to access freeze period data.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct and reachable.

Links

Discussion