GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation interacts with the GitLab API to retrieve the status of export relations for a specific project. It is useful for monitoring the export process of project relations, such as dependencies or linked resources, within GitLab projects. For example, a user can check if the export of related project data has completed or is still in progress by providing the project ID and optionally specifying a particular relation name.

Use Case Examples

  1. Check the export status of all relations for a project by providing the project ID.
  2. Query the export status of a specific relation within a project by specifying both the project ID and the relation name.

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 authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Optional query parameters for the API request, including the relation name to filter the export status.
Path Parameters Path parameters for the API request, including the project ID or URL-encoded path.

Output

JSON

  • status - The status of the export relations for the specified project.
  • relation - The name of the project relation queried (if specified).
  • projectId - The ID or URL-encoded path of the project for which the export status is retrieved.

Dependencies

  • GitLab API authentication

Troubleshooting

  • Ensure the project ID is correctly provided and URL-encoded if necessary to avoid 404 errors.
  • Verify that the authentication credentials are valid and have sufficient permissions to access the project export relations.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If the relation parameter is used, confirm that the relation name is valid and exists for the project to avoid empty or error responses.

Links

Discussion