GitLab API icon

GitLab API

Gitlab

Actions880

Overview

This node operation allows creating a freeze period for a specific project in GitLab by sending a POST request to the GitLab API endpoint `/api/v4/projects/{id}/freeze_periods`. It is useful for automating the management of freeze periods in projects, such as scheduling times when changes to the project are restricted.

Use Case Examples

  1. Automate setting freeze periods for a project before a release.
  2. Schedule freeze periods to prevent changes during critical deployment windows.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used for the request, default is 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 but POST is used for this operation.
Path Parameters Parameters to be included in the request path, specifically the project ID for this operation.

Output

JSON

  • id - The ID of the created 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.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project 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 create freeze periods.
  • Check the base URL if using a self-hosted GitLab instance instead of gitlab.com.
  • Common error messages include 401 Unauthorized (invalid or missing API key), 404 Not Found (invalid project ID), and 400 Bad Request (invalid request body).

Links

Discussion