---
title: "Artifacts"
url: https://docs.catalyst.zoho.com/en/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/artifacts/
description: "Learn about the Catalyst Pipelines artifacts in detail, the associated keywords and sample code snippets."
last_updated: 2026-08-28T06:26:16Z
service: Pipelines
type: general
related_links:
  - name: "Configure the Pipeline"
    url: /en/pipelines/help/catalyst-pipelines.yaml/implementation
---

# Artifacts

# Introduction

An artifact is a file or zip generated upon the application build process during the execution of the pipeline. These artifacts are deployable entities, which include infrastructure and apps. You can store and retrieve the artifacts during the pipeline execution in the Catalyst Stratus service.

There are two types of artifacts : 

* **A single artifact file :** This build file can be directly uploaded to a bucket in Catalyst Stratus and then downloaded when required.

* **An artifact zip :** This type includes configuring regular expressions to pick the relevant files, zip them and upload to a bucket in Catalyst Stratus and then download the zip when required.

You can define the required artifacts for the pipeline as key-value pairs using the `artifacts` key. These artifacts can be included as a part of the jobs created using steps, in the Catalyst console. You can refer to [this help section](https://docs.catalyst.zoho.com/en/pipelines/help/catalyst-pipelines.yaml/implementation/) to learn more about artifact configuration in jobs. However they are not applicable to [parallel](https://docs.catalyst.zoho.com/en/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/parallel-job/) and [approval](https://docs.catalyst.zoho.com/en/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/approval-job/) jobs. 

### Properties of an Artifact

#### Upload 

<table class="content-table">
        <thead>
            <tr>
                <th>Key</th>
                <th>Value</th>
                <th>is Mandatory</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>`upload`</td>
                <td>This key contains the configurations required for the artifact upload process.</td>
                <td>Yes</td>
            </tr>
            <tr>
                <td>`type`</td>
                <td>Provide the value as either `file` or `zip`.</td>
                <td>Yes</td>
            </tr>
            <tr>
                <td>`name`</td>
                <td>The name of the artifact. (file name or zip name)
                For example : 
                SNAPSHOT.jar (for file type)
                Build.zip (for zip type)
                </td>
                <td>Yes</td>
            </tr>
            <tr>
                <td>`file`</td>
                <td>The source path of the artifact file. 
                For example : target/demo-0.0.1-SNAPSHOT.jar
                </td>
                <td>Yes (if the artifact type is file)</td>
            </tr>
            <tr>
                <td>`regex`</td>
                <td>The regular expression pattern that identifies files and compresses all the matching ones.
                For example :
                - /catalyst/node_modules/**/
                </td>
                <td>Yes (if the artifact type is zip)</td>
            </tr>
            <tr>
                <td>`location`</td>
                <td>The location path in Stratus where the file or zip has to be uploaded. 
                For example :
                stratus://<<env.BUCKET_NAME >>/ (destination)
                </td>
                <td>Yes</td>
            </tr>
            </tbody>
</table>

#### Download

<table class="content-table">
        <thead>
            <tr>
                <th>Key</th>
                <th>Value</th>
                <th>is Mandatory</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>`download`</td>
                <td>This key contains the configurations required for the artifact download process.</td>
                <td>Yes</td>
            </tr>
            <tr>
                <td>`type`</td>
                <td>file or zip. Provide this value based on your preference.</td>
                <td>Yes</td>
            </tr>
            <tr>
                <td>`name`</td>
                <td>The name of the artifact in Stratus.
                For example : 
                SNAPSHOT.jar (for file type)
                Build.zip (for zip type)
                </td>
                <td>Yes</td>
            </tr>
            <tr>
                <td>`file`</td>
                <td>The destination path where the file has to be downloaded. 
                For example : /SNAPSHOT.jar.
                </td>
                <td>Yes (if the artifact type is file)</td>
            </tr>
            <tr>
                <td>`location`</td>
                <td>The Stratus location from which the file has to be downloaded. 
                For example : 
                stratus://<<env.BUCKET_NAME >>/ artifact name
                </td>
                <td>Yes</td>
            </tr>
            </tbody>
</table>

> **Note:**

If the artifact type is set to zip, the zip file will be downloaded to the root directory by default. 

Refer to [this section](https://docs.catalyst.zoho.com/en/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/introduction) for a sample YAML code snippet configured with artifacts.