GitLab API

GitlabTool
Join our community

Actions1000

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 execution.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication process for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, default is GET but can be set to PUT for this operation.
Path Parameters Parameters included in the API request path, specifically the runner ID to identify which runner 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.
  • tags - Tags associated with the runner.
  • runner_type - Type of the runner.
  • status - Current status of the runner.
  • ip_address - IP address of the runner.
  • name - Name of the runner.
  • online - Indicates if the runner is currently online.

Dependencies

  • GitLab API authentication credential

Troubleshooting

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

Links

Discussion