GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation allows users to create a new runner in GitLab by sending a POST request to the /api/v4/runners endpoint. It is useful for automating the registration of runners in GitLab CI/CD pipelines, enabling continuous integration and deployment workflows.

Use Case Examples

  1. Automatically register a new GitLab runner when setting up a new project.
  2. Integrate runner creation into a DevOps automation pipeline.

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 request is sent.
Method HTTP method to use for the API request, default is POST for this operation.
Parameter Schema Defines the schema for the parameters sent in the request body for creating a runner.
Request Body Schema Schema for the request body, defining the data structure required to create a runner.
Request Path The API endpoint path for creating a runner, fixed to /api/v4/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 (e.g., instance, group, project).
  • status - Current status of the runner.
  • tags - Tags associated with the runner.
  • created_at - Timestamp when the runner was created.

Dependencies

  • Requires GitLab API key credential for authentication.

Troubleshooting

  • Ensure the GitLab API key has sufficient permissions to create runners.
  • Verify the baseUrl is correct and accessible.
  • Check the request body matches the expected schema for runner creation.
  • Common errors include authentication failures, invalid request body, or insufficient permissions.

Links

Discussion