GitLab API

GitlabTool
Join our community

Actions1000

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 the pipeline schedule with ID 13 in project ID 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 for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method used 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

  • statusCode - HTTP status code of the delete operation response.
  • responseBody - Response body returned from the GitLab API after attempting to delete the variable, typically empty or confirmation message.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID, pipeline schedule ID, and variable key are correct and exist in the GitLab instance.
  • Verify that the API key used has sufficient permissions to delete pipeline schedule variables.
  • Check the base URL to confirm it points to the correct GitLab instance.
  • Common error messages include 404 Not Found if the resource does not exist, and 403 Forbidden if the API key lacks permissions.

Links

Discussion