GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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 relations for a project with ID '12345' to monitor export progress.
  2. Retrieve the export status of a specific relation within a project by specifying the relation name in the query parameters.

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, default is GET.
Query Parameters Optional query parameters for the API request, including the 'relation' parameter to specify the project relation name.
Path Parameters Path parameters for the API request, including the required 'id' parameter which is the ID or URL-encoded path of the project.

Output

JSON

  • status - The status of the export relations for the specified project.
  • relation - The name of the project relation queried.
  • projectId - The ID of the project for which the export relations status is retrieved.

Dependencies

  • GitLab API authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the provided authentication.
  • Verify that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • If skipping authentication, ensure the API endpoint is accessible without authentication, otherwise requests will fail.
  • Common error messages include 401 Unauthorized (authentication issues), 404 Not Found (invalid project ID or relation), and 400 Bad Request (invalid parameters). Verify parameters and authentication to resolve these.

Links

Discussion