GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

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 for a group, such as checking if the export process is complete or still in progress. Practical examples include automating workflows that depend on the export status of group data in GitLab.

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 status.
  2. Use this operation in automation to trigger subsequent actions based on the export status of a group in GitLab.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET.
Parameter Schema Defines the path and query parameters for the request, including the group ID and optional relation name.
Request Body Schema Schema for the request body, which is null for this GET operation.
Request Path The API endpoint path for the operation, with a placeholder for the group ID.
Query Parameters Optional query parameters for the request, including the relation name to filter export relations status.
Path Parameters Path parameters for the request, specifically the group ID.

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 parameters.
  • 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 used for authentication has sufficient permissions to access group export relations status.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If the relation query parameter is used, ensure it matches a valid relation name for the group export relations.

Links

Discussion