GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API, specifically supporting the operation to create or register user runners via the POST /api/v4/user/runners endpoint. It is useful for automating the management of GitLab CI/CD runners associated with a user, enabling workflows that require dynamic runner registration or configuration.

Use Case Examples

  1. Automate the registration of new GitLab runners for a user in a CI/CD pipeline setup.
  2. Integrate runner management into a DevOps workflow to programmatically add runners based on project needs.

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 key authentication.
baseUrl The base URL of the GitLab instance to which the API requests are sent.
Method The HTTP method used for the API request, defaulting to GET but supporting POST, PUT, DELETE, HEAD, and PATCH.
Parameter Schema Defines the schema for the parameters sent in the request body for the postApiV4UserRunners operation.
Request Body Schema Defines the schema for the request body for the postApiV4UserRunners operation.
Request Path The API endpoint path for the postApiV4UserRunners operation, fixed to /api/v4/user/runners.

Output

JSON

  • id - The unique identifier of the created or 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 (e.g., instance, group, project).
  • tags - Tags associated with the runner.
  • created_at - Timestamp when the runner was created.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Authentication errors due to invalid or missing API key. Ensure the GitLab API key credential is correctly configured.
  • Invalid request body schema or missing required fields can cause API errors. Validate the request body against the expected schema for the /api/v4/user/runners endpoint.
  • Network or base URL misconfiguration can lead to connection failures. Verify the baseUrl property is correctly set to the GitLab instance URL.

Links

Discussion