GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API to update a project by its ID using the HTTP PUT method. It is useful for automating project management tasks in GitLab, such as modifying project settings or metadata programmatically. For example, it can be used to update project visibility, description, or other attributes without manual intervention in the GitLab UI.

Use Case Examples

  1. Updating a GitLab project description by specifying the project ID and new description in the request body.
  2. Changing project visibility settings for a specific project using its ID.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the request is sent, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET but set to PUT for this operation.
Parameter Schema Defines the parameters for the request, including the project ID in the path and the request body schema for updating the project.
Request Body Schema Schema defining the structure of the request body for updating the project.
Request Path The API endpoint path for updating a project by ID, set to /api/v4/projects/{id}.
Path Parameters Collection of path parameters, specifically the project ID required to identify which project to update.

Output

JSON

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

Dependencies

  • Requires GitLab API key authentication unless skipping authentication is enabled.

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and exists in the GitLab instance.
  • Verify that the API key used for authentication has sufficient permissions to update projects.
  • Check that the request body conforms to the expected schema for updating a project to avoid validation errors.
  • If skipping authentication, ensure the GitLab instance allows unauthenticated requests for this operation, which is uncommon.

Links

Discussion