GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation deletes a specific variable from a pipeline schedule within a GitLab project. It is useful for managing CI/CD pipeline configurations by removing environment variables that are no longer needed or should be revoked. For example, if a variable used in a scheduled pipeline is outdated or compromised, this operation can delete it to maintain security and proper pipeline behavior.

Use Case Examples

  1. Deleting a variable named 'NEW_VARIABLE' from a pipeline schedule with ID 13 in project 18 to revoke its usage in scheduled pipelines.
  2. Removing sensitive or deprecated variables from pipeline schedules to ensure secure and clean CI/CD configurations.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, typically used for public or unauthenticated endpoints.
Authentication Type of authentication used, here it is GitLab API authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method 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, pipeline schedule, and variable key to delete.

Output

JSON

  • success - Indicates whether the variable was successfully deleted (typically a status or confirmation response from the API)

Dependencies

  • GitLab API credentials for authentication

Troubleshooting

  • Ensure the project ID, pipeline schedule ID, and variable key are correct and exist in GitLab to avoid 404 errors.
  • Authentication errors may occur if the API token is missing, expired, or lacks sufficient permissions to delete pipeline schedule variables.
  • Network or base URL misconfiguration can cause connection failures; verify the baseUrl is correct for your GitLab instance.

Links

Discussion