GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation deletes a specific pipeline schedule from a GitLab project using the GitLab API. It is useful for automating the management of CI/CD pipeline schedules in GitLab projects, such as removing outdated or unnecessary pipeline schedules programmatically.

Use Case Examples

  1. Automatically delete a pipeline schedule when a project is archived or deleted.
  2. Remove pipeline schedules that are no longer needed as part of a cleanup workflow.

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 key 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 required in the API 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 request.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and pipeline schedule ID are correct and exist in the GitLab instance.
  • Verify that the API key used has sufficient permissions to delete pipeline schedules in the project.
  • Check the base URL to ensure it points to the correct GitLab instance if using a self-hosted GitLab server.
  • Common error messages include 404 Not Found if the project or pipeline schedule does not exist, and 403 Forbidden if the API key lacks permissions.

Links

Discussion