GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves the export relations status of a specific group in GitLab using the GitLab API. It is useful for monitoring the status of export relations for a group, such as checking if an export process has completed or is still in progress. For example, a user can use this node to programmatically check the export status of a group by providing the group's ID and optionally specifying a relation name.

Use Case Examples

  1. Check the export relations status of a GitLab group by providing the group ID.
  2. Monitor the progress of a group export operation by querying the export relations status.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request (boolean). Defaults to false.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent. Defaults to https://gitlab.com.
Method The HTTP method used for the API request. Defaults to GET.
Query Parameters Optional query parameters for the API request, including 'relation' which specifies the group relation name.
Path Parameters Path parameters for the API 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 group relation name if specified in the query parameters.
  • id - The ID of the group for which the export relations status is retrieved.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group ID ('id' path parameter) is provided and valid; missing or invalid ID will cause errors.
  • If authentication is required and skipped, the request may fail due to lack of authorization.
  • Verify the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • Check that the HTTP method is set to GET as expected for this operation; other methods may not be supported.

Links

Discussion