GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation updates a specific freeze period for a project in GitLab using the GitLab API. It is useful for managing project freeze periods programmatically, such as modifying the start and end dates or other attributes of a freeze period. For example, a user can update the freeze period details of a project to control when changes are restricted during critical phases.

Use Case Examples

  1. Updating the freeze period dates for a project to prevent changes during a release window.
  2. Modifying freeze period attributes to reflect new project timelines.

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, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET but PUT is used for this operation.
Path Parameters Parameters for the API path including project ID and freeze period ID.

Output

JSON

  • response - The JSON response from the GitLab API after updating the freeze period, containing the updated freeze period details.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and freeze period ID are correctly provided and valid to avoid 404 errors.
  • Verify that the API key has sufficient permissions to update freeze periods in the project.
  • Check the request body schema matches the expected structure to prevent validation errors.

Links

Discussion