GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation allows users to create or register a new runner for the authenticated user in GitLab via the GitLab API. It is useful for automating the management of CI/CD runners associated with a user account, enabling continuous integration workflows to be dynamically configured or updated.

Use Case Examples

  1. Automatically register a new GitLab runner for a user when a new project is created.
  2. Manage user-specific runners programmatically as part of a DevOps pipeline setup.

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 key 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 POST, PUT, DELETE, HEAD, or PATCH.
Parameter Schema Defines the schema for the parameters sent in the request body, specifically for the postApiV4UserRunners operation.
Request Body Schema Schema for the request body, which is used to send data when creating a new runner for the user.
Request Path The API endpoint path for the operation, fixed to /api/v4/user/runners.

Output

JSON

  • id - The unique identifier of the created 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 GitLab API key credential is correctly configured and has sufficient permissions to create user runners.
  • Verify the base URL is correct and accessible.
  • Check that the request body conforms to the expected schema for creating a runner.
  • Common error messages may include authentication failures, permission denied, or invalid request body format. Resolving these involves verifying credentials, permissions, and request data format.

Links

Discussion