GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves details of a specific cluster associated with a project in GitLab using the GitLab API. It is useful for scenarios where you need to fetch cluster information such as configuration or status for a given project and cluster ID. For example, it can be used in DevOps workflows to monitor or manage Kubernetes clusters linked to GitLab projects.

Use Case Examples

  1. Fetch cluster details for project ID '123' and cluster ID '456' to monitor cluster status.
  2. Retrieve configuration of a specific cluster in a GitLab project for auditing or automation purposes.

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 GET.
Path Parameters Parameters required in the API request path to specify the project and cluster IDs.

Output

JSON

  • id - The unique identifier of the cluster.
  • name - The name of the cluster.
  • environment_scope - The environment scope associated with the cluster.
  • platform_kubernetes_api_url - The Kubernetes API URL of the cluster.
  • status - The current status of the cluster.
  • created_at - Timestamp when the cluster was created.
  • updated_at - Timestamp when the cluster was last updated.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and cluster ID are correctly specified and exist in GitLab to avoid 404 errors.
  • If authentication is enabled, verify that the API key credential is valid and has sufficient permissions to access cluster information.
  • Check the base URL if using a self-hosted GitLab instance to ensure the API endpoint is reachable.

Links

Discussion