System Settings JSON

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

application/vnd.org.jfrog.artifactory.system.ImportSettings+json

{
  "importPath" : "/import/path",
  "includeMetadata" : true,
  "verbose" : false,
  "failOnError" : true,
  "failIfEmpty" : true
}

Property

Required

Description

importPath

mandatory

A path to a directory on the local file system of the Artifactory server.

includeMetadata

optional

Determines whether to include metadata during the import. The default value is true.

Note

Docker repositories must have their metadata intact. Maven 2 metadata is unaffected by this setting.

verbose

optional

Determines whether to operate in verbose mode, which provides greater detail at the expense of overall performance. The default value is false.

failOnError

optional

Determines whether the import operation fails as soon as an error occurs. The default value is true.

failIfEmpty

optional

Determines whether the import operation fails if the system detects that the repository is empty. The default value is true.

application/vnd.org.jfrog.artifactory.system.ExportSettings+json

{
  "exportPath" : "/export/path",
  "includeMetadata" : true,
  "createArchive" : false,
  "bypassFiltering" : false,
  "verbose" : false,
  "failOnError" : true,
  "failIfEmpty" : true,
  "m2" : false,
  "incremental" : false,
  "excludeContent" : false
}

Property

Required

Description

exportPath

mandatory

A path to a directory on the local file system of the Artifactory server.

includeMetadata

optional

Determines whether to include metadata during the export. The default value is true.

Note

Docker repositories must have their metadata intact. Maven 2 metadata is unaffected by this setting.

createArchive

optional

Determines whether to create and export to a Zip archive. (This option is slow and CPU-intensive!). The default value is false.

bypassFiltering

optional

Determines whether to ignore existing repository content filtering rules during the export process. The default value is false(meaning the filtering rules are not ignored).

verbose

optional

Determines whether to operate in verbose mode, which provides greater detail at the expense of overall performance. The default value is false.

failOnError

optional

Determines whether the import operation fails as soon as an error occurs. The default value is true.

failIfEmpty

optional

Determines whether the import operation fails if the system detects that the repository is empty. The default value is true.

m2

optional

Determines whether to include Maven 2 repository metadata and checksum files as part of the export. The default value is false.

incremental

optional

Determines whether the export should be incremental, which means only changes from the previous run will be backed up, which results in a faster process. The default value is false.

excludeContent

optional

When performing a full system export, this option determines whether to perform a pure configuration export without content. The default value is false.

application/vnd.org.jfrog.artifactory.system.Version+json

{
  "version" : "2.2.2",
  "revision" : "10427",
  "addons" : [ "build", "ldap", "properties", "rest", ... ]
}

Property

Description

version

The Artifactory version number.

revision

The revision number.

addons

The list of active add-ons.