Replication Configuration JSON

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Local Repository

application/vnd.org.jfrog.artifactory.replications.ReplicationConfigRequest+json

{
  "username" : "admin",
  "password" : "password",
  "cronExp" : "0 0 12 * * ?" ,
  "url" : "http://localhost:8081/artifactory/remote-repo",
  "repoKey" : "libs-release-local",
  "proxy" : "proxy-key", 
  "disableProxy" : false, 
  "socketTimeoutMillis" : 15000,
  "enableEventReplication" : false,
  "enabled" : false,
  "syncDeletes" : false,
  "syncProperties" : true,
  "syncStatistics" : false,
  "pathPrefix" : "/path/to/repo",
  "includePathPrefixPattern" : "**/*",
  "excludePathPrefixPattern" : ""
}

Property

Required

Description

username

mandatory

The HTTP authentication username.

password

mandatory

Use either the HTTP authentication password or an identity token.Generate Identity Token

cronExp

mandatory

The cron expression that defines the replication task schedule.

url

mandatory

The URL of the target local repository on a remote Artifactory server. Use the format: https://<artifactory_url>/artifactory/<repository_name>

repoKey

optional

The name of the repo key to replicate.

proxy

optional

If this is not specified, it can be assigned the global default proxy.

disableProxy

optional

When set to true, the proxy field will be ignored (from version 7.41.7). The default value is false.

socketTimeoutMillis

optional

The network timeout in milliseconds to use for remote operations. The default value is 15000 milliseconds.

enableEventReplication

optional

When set, each event will trigger replication of the artifacts changed in this event. This can be any type of event on artifact, e.g. add, deleted or property change. The default value is false.

enabled

optional

When set, enables the replication of the specified repository to the specified target. The default value is false.

syncDeletes

optional

When set, items that were deleted locally should also be deleted remotely (also applies to properties metadata). The default value is false.

Warning

Enabling this option will delete artifacts on the target that do not exist in the source repository.

syncProperties

optional

When set, the task also synchronizes the properties of replicated artifacts. The default value is true.

syncStatistics

optional

When set, the task also synchronizes artifact download statistics. Set to avoid inadvertent cleanup at the target instance when setting up replication for disaster recovery. The default value is false.

pathPrefix

optional

When set, only artifacts located in the path that matches the subpath within the repository will be replicated.

includePathPrefixPattern

optional

Defines a pattern of artifacts to include in the path prefix.

excludePathPrefixPattern

optional

Defines a pattern of artifacts to exclude from the path prefix.

Remote Repository

application/vnd.org.jfrog.artifactory.replications.ReplicationConfigRequest+json

{
  "cronExp" : "0 0 12 * * ?" ,
  "repoKey" : "libs-release-local",
  "enableEventReplication" : false,
  "enabled" : false,
  "syncDeletes" : false,
  "syncProperties" : true,
  "syncStatistics" : false,
  "pathPrefix" : "/path/to/repo"
  "includePathPrefixPattern" : "**/*",
  "excludePathPrefixPattern" : ""
}

Property

Required

Description

cronExp

mandatory

The cron expression that defines the replication task schedule.

repoKey

optional

The name of the repo key to replicate.

enableEventReplication

optional

When set, each event will trigger replication of the artifacts changed in this event. This can be any type of event on artifact, e.g. add, deleted or property change. The default value is false.

enabled

optional

When set, enables the replication of the specified repository to the specified target. The default value is false.

syncDeletes

optional

When set, items that were deleted locally should also be deleted remotely (also applies to properties metadata). The default value is false.

Warning

Enabling this option will delete artifacts on the target that do not exist in the source repository.

syncProperties

optional

When set, the task also synchronizes the properties of replicated artifacts. The default value is true.

syncStatistics

optional

When set, the task also synchronizes artifact download statistics. Set to avoid inadvertent cleanup at the target instance when setting up replication for disaster recovery. The default value is false.

pathPrefix

optional

When set, only artifacts located in the path that matches the subpath within the repository will be replicated.

includePathPrefixPattern

optional

Defines a pattern of artifacts to include in the path prefix.

excludePathPrefixPattern

optional

Defines a pattern of artifacts to exclude from the path prefix.