GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation restores a deleted GitLab group by making a POST request to the GitLab API endpoint `/api/v4/groups/{id}/restore`. It is useful in scenarios where a previously deleted group needs to be recovered without recreating it from scratch. For example, if a group was accidentally deleted, this operation can restore it by specifying the group's ID.

Use Case Examples

  1. Restoring a deleted GitLab group by providing its ID to the node.
  2. Automating group restoration in GitLab workflows after accidental deletions.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for testing or public endpoints.
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 POST is used for this operation.
Path Parameters Parameters to be included in the request path, specifically the group ID to restore.

Output

JSON

  • id - The unique identifier of the restored group.
  • name - The name of the restored group.
  • path - The path of the restored group.
  • description - Description of the restored group.
  • visibility - Visibility level of the restored group (e.g., private, internal, public).
  • lfs_enabled - Indicates if Large File Storage (LFS) is enabled for the group.
  • avatar_url - URL to the group's avatar image.
  • web_url - URL to access the group on GitLab.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the group 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 restore groups.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab.
  • Common error messages include 404 Not Found if the group ID does not exist or 403 Forbidden if the API key lacks permissions. Verify these and adjust accordingly.

Links

Discussion