GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node performs a ping operation to the GitLab API endpoint `/api/v4/packages/conan/v1/ping` under the Conan packages resource. It is used to check the availability or responsiveness of the Conan packages API in GitLab. This can be useful for monitoring or validating the connection to the GitLab Conan packages service before performing further operations.

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 up and running.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
baseUrl The base URL of the GitLab instance to which the request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the request, defaulting to GET. Options include GET, POST, PUT, DELETE, HEAD, and PATCH.

Output

JSON

  • status - The HTTP status code returned by the ping request.
  • responseBody - The body of the response returned by the ping request, typically indicating the API's availability.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • If authentication is required but skipped, the request may fail with an authorization error. Ensure authentication is enabled or provide valid credentials.
  • If the base URL is incorrect or the GitLab instance is unreachable, the request will fail. Verify the base URL and network connectivity.
  • If the HTTP method is not supported by the endpoint, the request may return an error. Use the GET method as default for the ping operation.

Discussion