GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API, specifically targeting the Conan packages API endpoint to perform a ping operation. It is useful for checking the availability or responsiveness of the GitLab Conan packages service. For example, it can be used in automation workflows to verify that the Conan package service is up before proceeding with package management tasks.

Use Case Examples

  1. Check the availability of the GitLab Conan packages API before triggering package upload workflows.
  2. Monitor the health of the GitLab Conan packages service by periodically pinging the API endpoint.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication when making the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication, hidden if Skip Authentication is true.
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 GET.

Output

JSON

  • status - The status of the ping response from the GitLab Conan packages API.
  • message - A message returned by the ping endpoint, typically indicating success or failure.

Dependencies

  • GitLab API authentication credentials

Troubleshooting

  • If authentication fails, ensure the GitLab API credentials are correctly configured and have the necessary permissions.
  • If the ping request times out or fails, verify the baseUrl is correct and the GitLab instance is reachable.
  • HTTP method should be GET for the ping operation; using other methods may result in errors.

Links

Discussion