GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node interacts with the GitLab API to post the Geo status at the endpoint `/api/v4/geo/status`. It is useful for scenarios where you need to update or report the status of a Geo node in a GitLab instance, such as monitoring or managing Geo replication status in a GitLab environment.

Use Case Examples

  1. Updating Geo node status in a GitLab instance to reflect current replication health.
  2. Automating Geo status reporting as part of a GitLab maintenance workflow.

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 used for the request, default is GET but can be POST, PUT, DELETE, HEAD, or PATCH.
Parameter Schema Defines the schema for the parameters sent in the request body, specifically for the postApiV4GeoStatus operation.
Request Body Schema Defines the schema for the request body, which is required for the postApiV4GeoStatus operation.
Request Path The API endpoint path for posting Geo status, fixed to `/api/v4/geo/status`.

Output

JSON

  • response - The JSON response 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 the necessary permissions to post Geo status.
  • Verify the baseUrl is correctly set to the GitLab instance URL.
  • Check that the request body conforms to the expected schema for the postApiV4GeoStatus operation to avoid validation errors.
  • Common error messages may include authentication failures, invalid request body format, or endpoint not found errors. Resolving these involves verifying credentials, request structure, and endpoint correctness.

Links

Discussion