GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves details of a specific cluster agent associated with a GitLab project. It is useful for scenarios where you need to fetch information about a particular cluster agent by specifying the project ID or URL-encoded path and the agent ID. For example, it can be used to monitor or manage cluster agents in a CI/CD pipeline or infrastructure automation workflow.

Use Case Examples

  1. Fetch details of a cluster agent for a given project to verify its status or configuration.
  2. Integrate with GitLab to automate cluster agent management based on project-specific requirements.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Path Parameters Parameters to specify the project ID or URL-encoded path and the cluster agent ID for the request.

Output

JSON

  • id - The unique identifier of the cluster agent.
  • name - The name of the cluster agent.
  • project_id - The ID of the project the cluster agent belongs to.
  • created_at - Timestamp when the cluster agent was created.
  • updated_at - Timestamp when the cluster agent was last updated.
  • config - Configuration details of the cluster agent.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and agent ID are correctly specified and URL-encoded if necessary.
  • Verify that the GitLab API credentials are valid and have sufficient permissions to access cluster agent details.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion