GitLab API icon

GitLab API

Gitlab

Actions880

Overview

This node operation performs a ping request to the GitLab API endpoint `/api/v4/packages/conan/v1/ping` to check the availability or responsiveness of the Conan packages service within GitLab. It is useful for verifying connectivity and service status before performing further API interactions.

Use Case Examples

  1. A user wants to verify that the GitLab Conan packages API is reachable before attempting to upload or download packages.
  2. A monitoring workflow periodically pings the Conan packages API to ensure the service is operational.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use if authentication is not skipped.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the request to the ping endpoint.

Output

JSON

  • status - The HTTP status code returned by the ping request, indicating success or failure.
  • responseBody - The body of the response returned by the ping endpoint, typically used to confirm service availability.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • If the node fails with an authentication error, verify that the GitLab API credential is correctly configured and has the necessary permissions.
  • If the ping request times out or returns an error status, check the base URL and network connectivity to the GitLab instance.
  • Ensure the HTTP method is set appropriately; typically, GET is used for ping operations.

Links

Discussion