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 runners via the POST /api/v4/runners endpoint. It is useful for automating the management of GitLab runners, which are agents that run CI/CD jobs. For example, it can be used to programmatically add new runners to a GitLab instance as part of a DevOps automation workflow.

Use Case Examples

  1. Automate the registration of new GitLab runners when scaling CI/CD infrastructure.
  2. Integrate runner management into a larger GitLab project setup automation.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use for the API request, 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 to use 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 postApiV4Runners operation.
Request Body Schema Defines the schema for the request body for the postApiV4Runners operation.
Request Path The API endpoint path for the postApiV4Runners operation, fixed to /api/v4/runners.

Output

JSON

  • response - The JSON response from the GitLab API after creating or registering a runner.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to register runners.
  • Verify the baseUrl is correct and accessible from the n8n instance.
  • Check that the request body matches the expected schema for the runner registration endpoint to avoid validation errors.

Links

Discussion