GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves a raw artifact file from a specific job in a GitLab project. It is useful for accessing build or test artifacts stored in GitLab CI/CD pipelines, such as logs, reports, or compiled binaries. For example, you can use it to download a test coverage report artifact from a particular branch and job in your project.

Use Case Examples

  1. Download a raw artifact file from a job in the 'main' branch of a GitLab project by specifying the project ID, branch name, job name, and artifact file path.
  2. Fetch a specific artifact file from a CI job in a GitLab project to use it in further automation workflows.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is GET.
Parameter Schema Defines the required path and query parameters for the API call, including project ID, branch or tag name, job name, artifact path, and optional job token.
Request Body Schema Schema for the request body, which is null for this operation.
Request Path The API endpoint path template for retrieving the raw artifact file.
Query Parameters Collection of query parameters including job name, artifact path, and optional job token for multi-project pipelines.
Path Parameters Collection of path parameters including project ID and branch or tag name.

Output

Binary

The node outputs the raw artifact file as binary data, allowing further processing or saving of the artifact file.

JSON

  • data - The raw artifact file content as binary data.

Dependencies

  • Requires GitLab API key authentication unless skipping authentication is enabled.

Troubleshooting

  • Ensure the project ID and branch/tag name are correct and URL-encoded if necessary.
  • Verify the job name and artifact path exist in the specified job's artifacts.
  • If using job_token, ensure your GitLab tier supports it (Premium or Ultimate).
  • Authentication errors may occur if the API key is invalid or missing; check credentials configuration.

Links

Discussion