GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows updating a GitLab project by sending a PUT request to the GitLab API endpoint `/api/v4/projects/{id}`. It is useful for modifying project details such as name, description, visibility, or other project settings by specifying the project ID or URL-encoded path and providing the updated data in the request body.

Use Case Examples

  1. Updating the description of a GitLab project by specifying the project ID and new description in the request body.
  2. Changing the visibility level of a project by sending the appropriate parameters in the PUT request to the GitLab API.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated access scenarios.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but for this operation it should be PUT.
Path Parameters Parameters included in the request path, specifically the project ID or URL-encoded path to identify the project to update.

Output

JSON

  • id - The unique identifier of the updated project.
  • name - The name of the updated project.
  • description - The description of the updated project.
  • visibility - The visibility level of the updated project (e.g., private, internal, public).
  • web_url - The web URL to access the updated project on GitLab.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly specified in the path parameters to avoid 404 Not Found errors.
  • Verify that the authentication credentials are valid and have sufficient permissions to update the project to prevent authorization errors.
  • Check the request body schema to ensure all required fields are included and correctly formatted to avoid validation errors from the GitLab API.

Links

Discussion