GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API, specifically supporting the operation to POST to the /api/v4/geo/status endpoint. It is useful for updating or sending status information related to GitLab Geo nodes, which are used for replication and disaster recovery in GitLab setups. Practical applications include automating status updates or monitoring Geo node health programmatically.

Use Case Examples

  1. Automate sending Geo node status updates to GitLab for monitoring purposes.
  2. Integrate Geo status updates into a larger CI/CD pipeline to ensure replication health.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method to use for the API request, defaulting to GET but supporting POST, PUT, DELETE, HEAD, and PATCH.
Parameter Schema Defines the schema for the parameters sent in the body of the POST request to /api/v4/geo/status.
Request Body Schema Defines the schema for the request body sent to the /api/v4/geo/status endpoint.
Request Path The API endpoint path for the Geo status POST request, 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 for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to post Geo status.
  • Verify the baseUrl is correctly set to the target GitLab instance URL.
  • Check that the request body matches the expected schema for the /api/v4/geo/status endpoint to avoid validation errors.

Links

Discussion