GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves information about a specific project upload from the GitLab API. It is useful for scenarios where you need to access details of a file uploaded to a GitLab project, such as verifying upload status or metadata. For example, it can be used in automation workflows to fetch upload details for project documentation or asset management.

Use Case Examples

  1. Fetch details of a specific upload in a GitLab project to verify its existence and metadata.
  2. Automate retrieval of project upload information for audit or reporting purposes.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used for the request, defaulting to GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Parameter Schema Defines the required path parameters for the request, including project ID and upload ID.
Request Body Schema Schema for the request body, not used in this GET operation.
Request Path API endpoint path template for the request.
Path Parameters Collection of path parameters including upload_id and project id to specify the resource.

Output

JSON

  • id - The unique identifier of the upload.
  • url - The URL to access the uploaded file.
  • alt - Alternative text or description of the upload.
  • created_at - Timestamp when the upload was created.
  • markdown - Markdown representation of the upload for embedding.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and upload ID are correct and exist in the GitLab instance.
  • Verify that the API key credential has sufficient permissions to access project uploads.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 404 Not Found if the upload or project does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion