GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves the export relations status of a specific group in GitLab using the GitLab API v4. It is useful for monitoring the status of export relations associated with a group, such as checking if an export process has completed or is still in progress. Practical examples include automating workflows that depend on the export status of group data or integrating GitLab group export status checks into broader DevOps pipelines.

Use Case Examples

  1. Check the export relations status of a GitLab group by providing the group ID and optionally specifying a relation name to filter the results.
  2. Automate monitoring of group export processes to trigger subsequent actions once the export is complete.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the API request, useful for public or unauthenticated endpoints.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, defaulting to GET.
Query Parameters Optional query parameters for the request, including 'relation' to specify the group relation name.
Path Parameters Path parameters for the request, including 'id' which is the ID of the group to query.

Output

JSON

  • status - The status of the export relations for the specified group.
  • relation - The name of the group relation if specified in the query.
  • id - The ID of the group for which the export relations status is retrieved.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the group ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API key credential has sufficient permissions to access group export information.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If skipping authentication, confirm that the endpoint supports unauthenticated access, otherwise the request will fail with an authentication error.

Links

Discussion