Octopus.Certificate.Import exported 2026-07-22 by Octopus Deploy belongs to ‘Certificate’ category.
Import a certificate into the Windows Certificate Store.
Parameters
When this step is included in a project’s deployment process, the parameters below can be set.
Certificate variable
Octopus.Action.Certificate.Variable (required)
The certificate variable to be imported.
Store location
Octopus.Action.Certificate.StoreLocation
The location of the certificate store.
Allowed values: LocalMachine, CurrentUser, Custom User
Default: LocalMachine
Custom user
Octopus.Action.Certificate.StoreUser
A user to use as the certificate store location when Store Location is set to Custom User.
Example: DomainB\UserB
Store name
Octopus.Action.Certificate.StoreName
The name of the Windows certificate store. Use one of the pre-defined stores, or enter a custom store name.
Allowed values: My, Root, CA, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook
Default: My
Private key exportable
Octopus.Action.Certificate.PrivateKeyExportable
If the certificate includes a private key, it will be marked as exportable.
Allowed values: True, False
Default: False
Private key access rules
Octopus.Action.Certificate.PrivateKeyAccessRules
A JSON array defining who has access to the private key on the target machine. Each rule specifies an Identity and an Access type (ReadOnly or FullControl). By default, the machine Administrators group and the Tentacle service account are granted access.
Default: []
Step configuration using OCL
Example in Octopus Configuration Language (OCL):
step "import-certificate" {
name = "Import Certificate"
properties = {
Octopus.Action.TargetRoles = "web-server"
}
action {
action_type = "Octopus.Certificate.Import"
properties = {
Octopus.Action.Certificate.PrivateKeyAccessRules = "[]"
Octopus.Action.Certificate.PrivateKeyExportable = "False"
Octopus.Action.Certificate.StoreLocation = "LocalMachine"
Octopus.Action.Certificate.StoreName = "My"
Octopus.Action.Certificate.Variable = "Certificates-MyCert"
Octopus.Action.RunOnServer = "false"
}
}
}Page updated on Wednesday, July 22, 2026