GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation deletes a specific pipeline schedule from a project in GitLab using the GitLab API. It is useful for automating the management of CI/CD pipeline schedules by programmatically removing schedules that are no longer needed or relevant. For example, a user can delete a pipeline schedule by specifying the project ID and the pipeline schedule ID, which helps maintain clean and efficient project configurations.

Use Case Examples

  1. Deleting a pipeline schedule from a project to stop automated pipeline runs for a deprecated feature branch.
  2. Removing an outdated pipeline schedule to prevent unnecessary resource usage in a CI/CD environment.

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, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET but set to DELETE for this operation.
Path Parameters Parameters required in the request path to identify the project and pipeline schedule to delete.

Output

JSON

  • success - Indicates whether the pipeline schedule was successfully deleted.
  • statusCode - HTTP status code returned by the API after the delete operation.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and pipeline schedule ID are correct and exist in the GitLab instance to avoid 404 Not Found errors.
  • Verify that the authentication credentials have sufficient permissions to delete pipeline schedules in the specified project.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion