GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to create a cluster agent for a specified project. It is useful for automating the management of Kubernetes cluster agents within GitLab projects, enabling DevOps workflows to programmatically add cluster agents to projects for deployment and management purposes.

Use Case Examples

  1. Creating a new cluster agent for a project to automate Kubernetes cluster management.
  2. Integrating GitLab cluster agent creation into CI/CD pipelines for dynamic environment setup.

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 The HTTP method used for the API request, defaulting to POST for creating a cluster agent.
Path Parameters Parameters included in the API request path, specifically the project ID or URL-encoded path to identify the project for which the cluster agent is created.

Output

JSON

  • id - The unique identifier of the created cluster agent.
  • name - The name of the created cluster agent.
  • token - The token associated with the cluster agent for authentication.
  • created_at - Timestamp when the cluster agent was created.
  • updated_at - Timestamp when the cluster agent was last updated.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly provided; otherwise, the API will return an error indicating the project was not found.
  • Authentication errors may occur if the GitLab API key is missing or invalid; verify the API key credentials are correctly configured.
  • Check the base URL if connecting to a self-hosted GitLab instance to avoid connection errors.

Links

Discussion