GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API, specifically supporting the Geo resource's postApiV4GeoStatus operation. It allows users to send a POST request to the /api/v4/geo/status endpoint to update or retrieve the status of a Geo node in GitLab. This is useful for automating GitLab Geo status checks or updates within workflows.

Use Case Examples

  1. Automate the monitoring of GitLab Geo node status by periodically posting status updates.
  2. Integrate GitLab Geo status updates into a larger DevOps pipeline to trigger alerts or actions based on Geo node health.

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, defaulting to GitLab API key authentication.
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, defaulting to GET but supporting POST, PUT, DELETE, HEAD, PATCH.
Parameter Schema The schema defining the parameters for the postApiV4GeoStatus operation, required in the request body.
Request Body Schema The schema defining the structure of the request body for the postApiV4GeoStatus operation.
Request Path The API endpoint path for the postApiV4GeoStatus operation, fixed to /api/v4/geo/status.

Output

JSON

  • response - The JSON response returned from the GitLab API after posting the Geo status.

Dependencies

  • GitLab API key credential

Troubleshooting

  • If authentication is skipped but the GitLab instance requires it, the request will fail with an authentication error. Ensure the correct API key is provided or skipAuthentication is false.
  • Incorrect baseUrl can lead to connection errors or 404 responses. Verify the GitLab instance URL is correct.
  • The request body must conform to the postApiV4GeoStatus schema; otherwise, the API may return validation errors.

Links

Discussion