GitLab API

GitlabTool
Join our community

Actions1000

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 specify a group ID and optionally a relation name to get the current export status of that group's relations.

Use Case Examples

  1. Check the export relations status of a group by providing the group ID.
  2. Optionally filter the export relations status by specifying a relation name in the query parameters.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to which the request is sent.
Method The HTTP method used for the request, default is 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.

Output

JSON

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

Dependencies

  • GitLab API authentication

Troubleshooting

  • Ensure the group ID ('id') path parameter is provided and valid, as it is required for the request.
  • If authentication is not skipped, ensure valid GitLab API credentials are configured.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • Verify that the HTTP method is set to GET, as this operation is designed to retrieve data.

Discussion