GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation deletes a specific pipeline schedule from a project in GitLab. It is useful for automating the management of CI/CD pipeline schedules by removing outdated or unnecessary schedules programmatically. For example, a user can automate cleanup of pipeline schedules for projects that are no longer active or need schedule adjustments.

Use Case Examples

  1. Deleting a pipeline schedule by specifying the project ID and the pipeline schedule ID to remove scheduled CI/CD runs.
  2. Automating project maintenance by removing pipeline schedules that are no longer needed.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET but DELETE is used for this operation.
Path Parameters Parameters required in the URL 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

  • Requires GitLab API key credential for authentication.

Troubleshooting

  • Ensure the project ID and pipeline schedule ID are correct and exist in the GitLab instance.
  • Authentication errors may occur if the API key is missing or invalid; verify credentials.
  • Permission errors may occur if the API key does not have sufficient rights to delete pipeline schedules.

Links

Discussion