Transfer a Package

Octopus.TransferPackage exported 2026-07-22 by Octopus Deploy belongs to ‘Package’ category.

Transfer a package to a target via an external or built-in feed.

Parameters

When this step is included in a project’s deployment process, the parameters below can be set.

Package ID

Octopus.Action.Package.PackageId (required)

The ID of the package to transfer.

Example: OctoFx.RateService

Feed

Octopus.Action.Package.FeedId (required)

The ID of the package feed from which the package will be sourced.

Example: feeds-123

Package version

Octopus.Action.Package.PackageVersion

The version of the package to transfer.

Example: 1.2.3

Transfer path

Octopus.Action.Package.TransferPath (required)

The location that the package should be moved to once it is uploaded to the remote target.

Example: C:\temp\MyDir

Download on target

Octopus.Action.Package.DownloadOnTentacle

If true, the package will be downloaded by the Tentacle, rather than pushed by the Octopus Server.

Allowed values: True, False

Default: False

Step configuration using OCL

Example in Octopus Configuration Language (OCL):

step "transfer-package" {
    name = "Transfer Package"
    properties = {
        Octopus.Action.TargetRoles = "app-server"
    }

    action {
        action_type = "Octopus.TransferPackage"
        properties = {
            Octopus.Action.Package.DownloadOnTentacle = "False"
            Octopus.Action.Package.FeedId = "octopus-server-built-in"
            Octopus.Action.Package.PackageId = "MyApp"
            Octopus.Action.Package.TransferPath = "C:\\Packages"
            Octopus.Action.RunOnServer = "false"
        }

        packages {
            acquisition_location = "Server"
            feed = "octopus-server-built-in"
            package_id = "MyApp"
        }
    }
}

Page updated on Wednesday, July 22, 2026