GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API to perform operations related to user runners, specifically allowing the creation of new user runners via a POST request to the /api/v4/user/runners endpoint. It is useful for automating the management of GitLab CI/CD runners associated with a user account, such as registering new runners programmatically.

Use Case Examples

  1. Automatically register a new GitLab runner for a user when a new project is created.
  2. Integrate runner management into a CI/CD pipeline setup process.

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 requests are sent, defaulting to https://gitlab.com.
Method The HTTP method to use for the API request, defaulting to GET but set to POST for this operation.
Parameter Schema Defines the schema for the parameters sent in the request body, required for the POST operation to create a user runner.
Request Body Schema Defines the schema for the request body content, specifying the data structure required to create a user runner.
Request Path The API endpoint path for the operation, fixed to /api/v4/user/runners for creating user runners.

Output

JSON

  • response - The JSON response from the GitLab API after creating a user runner, containing details about the newly created runner.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to create user runners.
  • Verify the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • Check that the request body conforms to the required schema for creating a user runner; missing or invalid fields will cause errors.
  • Common error messages include authentication failures (401 Unauthorized), permission denied (403 Forbidden), and validation errors (400 Bad Request). Resolving these involves checking credentials, permissions, and request data format.

Links

Discussion