GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation updates a specific GitLab runner by its ID using the GitLab API. It is useful for managing and modifying runner configurations programmatically within GitLab projects or CI/CD pipelines. For example, you can update runner details such as tags, description, or active status by providing the runner ID and the updated data.

Use Case Examples

  1. Updating a runner's description and tags to better organize CI/CD runners.
  2. Changing the active status of a runner to disable or enable it for job processing.

Properties

Name Meaning
Skip Authentication Option to skip API authentication for the request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET but can be set to PUT for this operation.
Path Parameters Parameters to specify the path variables, here the runner ID to update.

Output

JSON

  • id - The ID of the runner that was updated.
  • description - The updated description of the runner.
  • active - The updated active status of the runner.
  • tags - The updated tags associated with the runner.
  • status - The current status of the runner after update.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the runner ID provided in path parameters is valid and exists in the GitLab instance.
  • Verify that the authentication credentials are correctly configured and have sufficient permissions to update runners.
  • Check that the request body schema matches the expected format for updating a runner to avoid validation errors.

Links

Discussion