GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation updates a specific variable for a pipeline schedule within a GitLab project. It is useful for automating the management of pipeline schedule variables, such as modifying environment variables or configuration settings for scheduled CI/CD pipelines in GitLab projects. For example, it can be used to update a variable key's value to change the behavior of a scheduled pipeline without manual intervention.

Use Case Examples

  1. Updating a variable named 'NEW_VARIABLE' for a pipeline schedule with ID 13 in project ID 18 to change its value.
  2. Automating the update of pipeline schedule variables as part of a larger CI/CD workflow.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request (boolean). Defaults to false.
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 to use for the request, defaulting to GET but can be set to PUT for this operation.
Path Parameters Parameters required in the request path to identify the project, pipeline schedule, and variable key to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the pipeline schedule variable, containing details of the updated variable.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID, pipeline schedule ID, and variable key are correctly specified; incorrect values will cause the API request to fail.
  • Authentication errors may occur if the GitLab API key is missing or invalid; verify the API key credentials.
  • The HTTP method should be set to PUT for this operation to update the variable; using other methods may result in errors.

Links

Discussion