GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation archives a specific project in GitLab by sending a POST request to the GitLab API endpoint `/api/v4/projects/{id}/archive`. It is useful for automating project management tasks such as archiving projects that are no longer active or needed, helping to keep the project list organized. For example, a user can archive completed projects automatically as part of a workflow.

Use Case Examples

  1. Automatically archive a project after its completion status is updated.
  2. Batch archive multiple projects based on certain criteria using an automated workflow.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the request, default is GET but POST is used for this operation.
Path Parameters Parameters included in the URL path, specifically the project ID or URL-encoded path to identify the project to archive.

Output

JSON

  • id - The ID or URL-encoded path of the project to be archived.

Dependencies

  • GitLab API credentials for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the authenticated user.
  • If authentication is skipped, the request may fail due to lack of permissions.
  • Verify the base URL is correct and points to a valid GitLab instance.
  • Check that the HTTP method is set to POST for archiving the project, as other methods may not work.

Links

Discussion