GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node interacts with the GitLab API to stop stale environments for a specific project. It is useful in scenarios where you want to programmatically manage and clean up environments that are no longer active or needed in a GitLab project. For example, it can be used in CI/CD pipelines to automatically stop stale environments to save resources and maintain project hygiene.

Use Case Examples

  1. Automatically stop stale environments in a GitLab project after a deployment.
  2. Integrate with a workflow to clean up environments that have not been used for a certain period.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance to which the API requests are sent.
Method The HTTP method to use for the API request (GET, POST, PUT, DELETE, HEAD, PATCH).
Path Parameters Parameters to specify the project ID or URL-encoded path for the GitLab project whose stale environments are to be stopped.

Output

JSON

  • success - Indicates whether the operation to stop stale environments was successful.
  • message - Additional information or message returned from the API about the operation.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible by the authenticated user.
  • Verify that the authentication credentials (API key) are valid and have sufficient permissions to stop environments.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • Common error messages may include authentication failures, permission denied, or invalid project ID. Resolving these typically involves correcting credentials, permissions, or input parameters.

Links

Discussion