GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation updates a GitLab runner by sending a PUT request to the GitLab API endpoint `/api/v4/runners/{id}`. It is useful for managing and modifying runner configurations in GitLab projects, such as changing runner details or settings. For example, a DevOps engineer can automate updating runner tags or descriptions using this node.

Use Case Examples

  1. Updating a runner's description or tags in GitLab to reflect new project requirements.
  2. Automating the modification of runner settings as part of a CI/CD pipeline setup.

Properties

Name Meaning
Skip Authentication If true, the node will skip using authentication for the request.
Authentication The authentication method used for the request, defaulting to GitLab API 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 PUT for this operation.
Path Parameters The path parameters for the request, specifically the runner ID to update.

Output

JSON

  • id - The unique identifier of the runner.
  • description - Description of the runner.
  • active - Indicates if the runner is active.
  • is_shared - Indicates if the runner is shared across projects.
  • runner_type - Type of the runner.
  • tags - Tags associated with the runner.
  • status - Current status of the runner.

Dependencies

  • GitLab API credentials for authentication

Troubleshooting

  • Ensure the runner ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API credentials have sufficient permissions to update runners.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • If skipping authentication, ensure the endpoint allows unauthenticated requests, otherwise the request will fail.

Links

Discussion