GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation allows creating a freeze period for a specific project in GitLab via the GitLab API. It is useful for automating project management tasks where you need to define periods during which changes to the project are restricted, such as during release freezes or critical maintenance windows. For example, a user can specify the project ID and the freeze period details to programmatically set these restrictions without manual intervention in the GitLab UI.

Use Case Examples

  1. Automate setting freeze periods for projects before major releases to prevent changes.
  2. Integrate with CI/CD pipelines to enforce freeze periods during deployment windows.

Properties

Name Meaning
Skip Authentication Option to skip API authentication for the request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but POST is used for this operation.
Path Parameters Parameters included in the request path, specifically the project ID for this operation.

Output

JSON

  • response - The JSON response from the GitLab API after creating the freeze period, typically including details of the created freeze period such as start and end dates, and project ID.

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 request body for the freeze period is correctly structured according to the GitLab API schema.
  • Check network connectivity and base URL correctness if the API request fails to reach the GitLab server.
  • Authentication errors may occur if the API key is missing, invalid, or lacks necessary permissions.

Links

Discussion