GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows users to export relations of a specific project in GitLab by making a POST request to the GitLab API endpoint `/api/v4/projects/{id}/export_relations`. It is useful for scenarios where users need to export project-related data programmatically, such as for backups, migrations, or integrations with other systems.

Use Case Examples

  1. Exporting relations of a project with a given project ID to back up project data.
  2. Automating the export of project relations for integration with external reporting tools.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but POST is used for this operation.
Path Parameters Collection of path parameters required for the request, specifically the project ID or URL-encoded path.

Output

JSON

  • response - The JSON response from the GitLab API after exporting project relations.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the authenticated user.
  • If authentication is skipped, verify that the endpoint supports unauthenticated access or the request will fail.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common errors include 404 Not Found if the project ID is invalid, 401 Unauthorized if authentication fails, and 400 Bad Request if the request body or parameters are malformed.

Links

Discussion