GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

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 remove 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, useful for public or unauthenticated API calls.
Authentication Type of authentication used, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method for the API request, default is GET but DELETE is used for this operation.
Path Parameters Parameters required in the API 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 message).

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID, pipeline schedule ID, and variable key are correct and exist in GitLab; otherwise, the API will return an error.
  • Authentication errors may occur if the API key is missing, invalid, 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