GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows users to register a new runner for a specific project in GitLab by making a POST request to the GitLab API endpoint `/api/v4/projects/{id}/runners`. It is useful for automating the management of CI/CD runners associated with GitLab projects, enabling continuous integration workflows to be dynamically configured or updated.

Use Case Examples

  1. Automatically add a new runner to a project when setting up CI/CD pipelines.
  2. Manage runners programmatically for multiple projects in GitLab.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used for the 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 POST is used for this operation.
Path Parameters Parameters to specify the project ID or URL-encoded path for which the runner is registered.

Output

JSON

  • id - ID of the registered 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.
  • created_at - Timestamp when the runner was created.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible by the authenticated user.
  • Verify that the authentication credentials (GitLab API key) are valid and have sufficient permissions to register runners.
  • Check the request body schema to ensure all required fields for registering a runner are included and correctly formatted.
  • Common error messages include 401 Unauthorized (invalid or missing authentication), 404 Not Found (project ID does not exist or is inaccessible), and 400 Bad Request (invalid request body).

Links

Discussion