GitLab API icon

GitLab API

Gitlab

Actions880

Overview

This node operation allows users to create a new runner for their GitLab user account by sending a POST request to the GitLab API endpoint `/api/v4/user/runners`. It is useful for automating the management of GitLab runners, which are used to run CI/CD jobs. For example, a DevOps engineer can use this node to programmatically register new runners without manually interacting with the GitLab UI.

Use Case Examples

  1. Automate the registration of new GitLab runners for CI/CD pipelines.
  2. Integrate runner creation into a larger workflow for managing GitLab projects and resources.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to POST for this operation.

Output

JSON

  • id - The unique identifier of the created runner.
  • description - The description of the runner.
  • active - Indicates if the runner is active.
  • is_shared - Indicates if the runner is shared across projects.
  • runner_type - The 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 runners.
  • Verify the baseUrl is correct and accessible from the n8n environment.
  • Check that the request body conforms to the expected schema for creating a runner, including required fields.
  • Common error messages include authentication failures (401 Unauthorized) and validation errors (400 Bad Request) if required parameters are missing or invalid.

Links

Discussion