GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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. Registering a new runner for a project to enable CI/CD pipelines.
  2. Automating runner management in GitLab projects as part of a DevOps workflow.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication 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 request is sent, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET but settable to POST, PUT, DELETE, HEAD, or PATCH.
Path Parameters The path parameters for the API request, specifically the project ID or URL-encoded path owned by the authenticated user.

Output

JSON

  • id - The 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.
  • name - Name of the runner.
  • online - Indicates if the runner is currently online.
  • status - Current status of the runner.

Dependencies

  • GitLab API authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible by the authenticated user.
  • Verify that the authentication credentials are valid and have the necessary permissions to register runners.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • Common error messages may include authentication failures, permission denied errors, or invalid project ID errors. Resolving these typically involves verifying credentials, permissions, and input parameters.

Links

Discussion