GitLab API

GitlabTool
Join our community

Actions1000

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 projects during critical release phases.
  2. Integrate with CI/CD pipelines to programmatically manage freeze periods based on deployment schedules.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Type of authentication to use, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, defaulting to GET but can be set to POST 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 provided in the path parameters is correct and accessible with the authenticated user.
  • Verify that the base URL is correct and points to a valid GitLab instance.
  • Check that the authentication credentials are valid and have sufficient permissions to create freeze periods.
  • Common error messages include 401 Unauthorized (invalid or missing credentials), 404 Not Found (invalid project ID), and 400 Bad Request (invalid request body).

Links

Discussion