GitLab API

GitlabTool
Join our community

Actions905

Overview

This node performs an HTTP request to the GitLab API endpoint for Conan packages, specifically the 'ping' endpoint at '/api/v4/packages/conan/v1/ping'. It is useful for checking the availability or status of the Conan package service in GitLab. Typical use cases include monitoring the service health or verifying connectivity before performing further package operations.

Use Case Examples

  1. Check the status of the Conan package service in GitLab by sending a GET request to the ping endpoint.
  2. Use the node to verify authentication and connectivity to the GitLab Conan package API before executing package management workflows.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the request.
Authentication The authentication method to use for the request, hidden unless Skip Authentication is false.
baseUrl The base URL of the GitLab instance to which the request is sent, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, such as GET, POST, PUT, DELETE, HEAD, or PATCH.
Parameter Schema Hidden property for the parameter schema of the request, specific to the operation.
Request Body Schema Hidden property for the request body schema, specific to the operation.
Request Path Hidden property specifying the API path for the ping endpoint: /api/v4/packages/conan/v1/ping.

Output

JSON

  • statusCode - HTTP status code returned by the API request
  • headers - HTTP response headers from the API request
  • body - The JSON response body from the ping endpoint, typically indicating service status or availability

Dependencies

  • GitLab API authentication credentials

Troubleshooting

  • If authentication is enabled but credentials are missing or invalid, the request will fail with an authentication error. Ensure valid GitLab API credentials are provided.
  • If the baseUrl is incorrect or the GitLab instance is unreachable, the request will fail with a network or connection error. Verify the baseUrl and network connectivity.
  • If the HTTP method is not supported by the endpoint, the API may return a method not allowed error. Use the GET method for the ping endpoint as recommended.

Links

Discussion