GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves artifacts for a specific job from the GitLab API (version 4). It is useful for automating the download or access of job artifacts generated during CI/CD pipelines in GitLab. For example, it can be used to fetch build outputs, test results, or deployment packages associated with a particular job ID.

Use Case Examples

  1. Automate downloading build artifacts after a CI job completes.
  2. Fetch test reports generated by a specific GitLab job for further processing.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Parameter Schema Defines the parameters for the API call including job ID (path), token (query), and direct_download flag (query).
Request Body Schema Schema for the request body, null for this operation as it does not require a body.
Request Path The API endpoint path template for fetching job artifacts.
Query Parameters Optional query parameters including token for job authentication and direct_download flag to download directly from remote storage.
Path Parameters Path parameters including the job ID to specify which job's artifacts to retrieve.

Output

JSON

  • artifacts - The artifacts data retrieved from the specified job.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the job ID provided in path parameters is valid and exists in the GitLab project.
  • If authentication is required, verify that the API key or token is correctly configured and has sufficient permissions.
  • Check that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • If using the direct_download option, ensure the job's artifacts are accessible via remote storage and the token is valid if required.

Links

Discussion