GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation deletes a specific deployment from a GitLab project using the GitLab API. It is useful for automating the removal of deployments in a project, for example, cleaning up old or obsolete deployments programmatically.

Use Case Examples

  1. Deleting a deployment by specifying the project ID and deployment ID to keep the project environment clean.
  2. Automating deployment management by removing deployments that are no longer needed after a release.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to DELETE for this operation.
Path Parameters Parameters used in the API request path to identify the project and deployment to delete.

Output

JSON

  • success - Indicates whether the deployment was successfully deleted.
  • statusCode - HTTP status code returned by the API after the delete request.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and deployment ID are correct and exist in the GitLab instance.
  • Verify that the authentication credentials have sufficient permissions to delete deployments.
  • If skipping authentication, the API request may fail due to lack of authorization.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion