GitLab API

GitlabTool
Join our community

Actions1000

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 CI/CD automation.
  2. Create runners programmatically as part of infrastructure provisioning scripts.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, hidden unless Skip Authentication is false.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method to use for the API request, default is GET but POST is used for this operation.

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).
  • tags - Tags associated with the runner.
  • created_at - Timestamp when the runner was created.

Dependencies

  • GitLab API authentication credential

Troubleshooting

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

Discussion