GitLab API

GitlabTool

Actions1095

Projects → getApiV4ProjectsIdJobsArtifactsRefNameDownload

AI-generated

Summary

Download the job artifacts archive for a specific project and branch or tag reference by specifying the project ID or path, the ref name, and the job name.

Inputs

  • id (required) — The ID or URL-encoded path of the project.
  • ref_name (required) — Branch or tag name in repository. HEAD or SHA references are not supported.
  • job (required) — The name of the job whose artifacts you want to download.
  • job_token — Optional token used with triggers for multi-project pipelines, available only on Premium and Ultimate tiers.
  • skipAuthentication — If set to true, disables authentication for this request.
  • baseUrl — The base URL of the GitLab instance; defaults to https://gitlab.com.
  • method — HTTP method to use; defaults to GET.

Output shape

a binary file stream containing the downloaded job artifacts archive

The response is the job artifacts archive binary; workflow authors should handle the binary data for saving or further processing. Authentication is required unless explicitly skipped. The request uses the path /api/v4/projects/{id}/jobs/artifacts/{ref_name}/download with required and optional query parameters.

Examples

Example 1: Download artifacts for a project

Specify project ID or path as 'id', branch or tag as 'ref_name', and job name as 'job' parameter; the node returns the binary archive of the artifacts generated by that job.

Links

Discussion