GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation updates a CI variable in GitLab using the Admin API. It is useful for managing CI/CD variables programmatically, such as modifying environment variables for automated pipelines in GitLab projects or groups. For example, an admin can update a secret key or configuration variable without manually accessing the GitLab UI.

Use Case Examples

  1. Updating a CI variable's value for a GitLab project to change deployment settings.
  2. Automating the update of environment variables across multiple GitLab projects via API calls.

Properties

Name Meaning
Skip Authentication Option to skip API authentication, useful for testing or when authentication is handled externally.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but can be set to PUT for this operation.
Parameter Schema Defines the path and body parameters for the API call, including the variable key and the request body schema.
Request Body Schema Schema for the request body payload, defining the structure of the variable update data.
Request Path The API endpoint path for updating a CI variable, with a placeholder for the variable key.
Path Parameters Collection of path parameters, specifically the 'key' of the CI variable to update.

Output

JSON

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

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the 'key' path parameter is correctly set to the variable key to update; otherwise, the API call will fail.
  • Verify that the API authentication token is valid and has admin permissions to update CI variables.
  • Check that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab server.
  • Common error messages include 401 Unauthorized (invalid or missing authentication), 404 Not Found (variable key does not exist), and 400 Bad Request (invalid request body). Resolving these involves correcting authentication, verifying variable existence, and ensuring request body schema compliance.

Links

Discussion