GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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.

Use Case Examples

  1. Automatically archive completed projects in GitLab to keep the workspace clean.
  2. Integrate with a workflow that archives projects after a certain status or milestone is reached.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for testing or if authentication is handled externally.
Authentication Selects the authentication method to use, defaulting to GitLab API 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 project ID or URL-encoded path to identify the project to archive.

Output

JSON

  • id - The ID of the archived project.
  • name - The name of the archived project.
  • archived - Boolean indicating if the project is archived.
  • message - Response message confirming the archive action.

Dependencies

  • GitLab API authentication token or credentials

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.
  • Check that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • Common error messages include 404 Not Found if the project does not exist, 401 Unauthorized if authentication fails, and 403 Forbidden if the user lacks permission to archive the project.

Links

Discussion