GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation downloads job artifacts from a specific project in GitLab using the GitLab API. It is useful for automating the retrieval of build or test artifacts generated by CI/CD jobs in a GitLab project. For example, it can be used to fetch artifacts from a particular branch or tag for further processing or storage.

Use Case Examples

  1. Download artifacts from a CI job in a GitLab project to use in a deployment pipeline.
  2. Automate the retrieval of test reports generated by GitLab CI jobs for analysis.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, default is 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.
Query Parameters Parameters sent as query string in the request URL.
Path Parameters Parameters sent as part of the URL path.

Output

Binary

The node outputs the downloaded job artifact file as binary data.

JSON

  • statusCode - HTTP status code of the response.
  • headers - HTTP response headers.
  • body - The binary content of the downloaded artifact file.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and ref_name are correctly specified and URL-encoded if necessary.
  • Verify that the job name exists and has artifacts available for download.
  • If using job_token, ensure the GitLab tier supports it and the token is valid.
  • Check network connectivity and baseUrl correctness if the request fails.

Links

Discussion