GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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 freeze periods in their projects, such as automating project management workflows or integrating freeze period data into other systems. For example, a user can fetch freeze periods to display them in a dashboard or trigger notifications based on freeze period status.

Use Case Examples

  1. Fetch freeze periods for a project with ID '123' to monitor when the project is frozen.
  2. Automate retrieval of freeze periods to integrate with a CI/CD pipeline to prevent deployments during freeze times.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated access.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the API requests are sent.
Method HTTP method used for the API request, default is GET.
Query Parameters Optional query parameters for pagination, including 'page' for current page number and 'per_page' for number of items per page.
Path Parameters Path parameter 'id' representing the ID or URL-encoded path of the project whose freeze periods are being retrieved.

Output

JSON

  • freeze_periods - Array of freeze period objects retrieved from the GitLab project
  • pagination
    • page - Current page number of the results
    • per_page - Number of items per page in the results
    • total_pages - Total number of pages available
    • total_items - Total number of freeze period items available

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID ('id') path parameter is correctly provided 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 base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If pagination parameters ('page' and 'per_page') are used, ensure they are valid integers and within acceptable ranges.

Links

Discussion