Try JFrog
Guides
Contact SupportTry JFrog
Start typing to search…
  1. Integrations
  2. JFrog API

Configuration JSON Files

The configuration files in this section define the structured JSON payloads used as the request body for various JFrog REST APIs. While the API reference guides you on how to call an endpoint, these configuration files provide the specific schemas required to define repository settings, security policies, and system behaviors. They serve as the modular 'blueprints' that the platform consumes to execute complex management tasks.

Replication Configuration JSON

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.

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.

Repository Configuration JSON

Legend

Element

Description

+

Mandatory element in create/replace queries (optional in "update" queries)

-

Optional element in create/replace queries

(default)


The default value when unspecified in create/replace queries

Local Repository

application/vnd.org.jfrog.artifactory.repositories.LocalRepositoryConfiguration+json

{
  - "key": "local-repo1",
  - "projectKey": "projx",
  - "environments":["DEV"] (mandatory when assigning repo to project),
  + "rclass": "local",
  - "packageType": "alpine"|"cargo"|"composer"|"bower"|"chef"|"cocoapods"|"conan"|"conda"|"cran"|"debian"|"docker"|"helm"|"helmoci"|"huggingfaceml"|"gems"|"gitlfs"|"go"|"gradle"|"ivy"|"maven"|"npm"|"nuget"|"oci"|"opkg"|"pub"|"puppet"|"pypi"|"rpm"|"sbt"|"swift"|"terraform"|"terraformbackend"|"vagrant"|"ansible"|"generic" (default)
  - "description": "The local repository public description", 
  - "notes": "Some internal notes",
  - "includesPattern": "**/*" (default), #The default ("**/*") includes everything. If empty (""), this also includes everything.
  - "excludesPattern": "" (default),
  - "repoLayoutRef": "maven-2-default" (default),
  - "debianTrivialLayout": false,
  - "checksumPolicyType": "client-checksums" (default) | "server-generated-checksums"
  - "handleReleases": true (default),
  - "handleSnapshots": true (default),
  - "maxUniqueSnapshots": 0 (default),
  - "maxUniqueTags": 0 (default),
  - "snapshotVersionBehavior": "unique"(default) | "non-unique" | "deployer", #Specifies the naming convention for Maven SNAPSHOT versions. From release 7.41, this default changed from "non-unique" to "unique" and affects both local and federated repositories
  - "suppressPomConsistencyChecks": false (default),
  - "blackedOut": false (default),
  - "xrayIndex": false       (default),
  - "propertySets": ["ps1", "ps2"],
  - "archiveBrowsingEnabled": false,
  - "calculateYumMetadata": false,
  - "yumRootDepth": 0,
  - "dockerApiVersion": "V2" (default),
  - "terraformType": "MODULE"|"PROVIDER",
  - "enableFileListsIndexing": "false" (default),
  - "optionalIndexCompressionFormats": ["bz2", "lzma", "xz"],
  - "downloadRedirect": "false" (default),
  - "cdnRedirect": "false" (default, Applies to Artifactory Cloud Only),
  - "blockPushingSchema1": "false",
  - "primaryKeyPairRef": "mygpgkey",
  - "secondaryKeyPairRef": "mysecgpgkey",
  - "forceNugetAuthentication": false (default),
  - "forceP2Authentication": false (default),
  - "forceConanAuthentication": false (default),
  - "encryptStates": true (default),
  - "priorityResolution": "false" (default, Applies to all repository types excluding CocoaPods, Git LFS, NuGet V2, Opkg, Rust, Vagrant and VCS repositories)
}

Remote Repository

application/vnd.org.jfrog.artifactory.repositories.RemoteRepositoryConfiguration+json

{
  - "key": "remote-repo1",
  - "projectKey": "projx",
  - "environments":["DEV"] (mandatory when assigning repo to project),
  + "rclass" : "remote",
  - "packageType": "alpine"|"cargo"|"composer"|"bower"|"chef"|"cocoapods"|"conan"|"conda"|"cran"|"debian"|"docker"|"helm"|"helmoci"|"huggingfaceml"|"gems"|"gitlfs"|"go"|"gradle"|"ivy"|"maven"|"npm"|"nuget"|"oci"|"opkg"|"pub"|"puppet"|"pypi"|"rpm"|"sbt"|"swift"|"terraform"|"ansible"|"generic" (default)
  + "url" : "http://host:port/some-repo",
  - "username": "remote-repo-user",
  - "password": "pass",
  - "proxy": "proxy1",
  - "disableProxy": false (default),
  - "description": "The remote repository public description",
  - "notes": "Some internal notes",
  - "includesPattern": "**/*" (default),
  - "excludesPattern": "" (default),
  - "repoLayoutRef" : "maven-2-default",
  - "remoteRepoLayoutRef" : "" (default),
  - "remoteRepoChecksumPolicyType": "generate-if-absent" (default) | "fail" | "ignore-and-generate" | "pass-thru",
  - "handleReleases": true (default),
  - "handleSnapshots": true (default),
  - "maxUniqueSnapshots": 0 (default),
  - "suppressPomConsistencyChecks": false (default),
  - "hardFail": false (default),
  - "offline": false (default),
  - "blackedOut": false (default),
  - "storeArtifactsLocally": true (default),
  - "socketTimeoutMillis": 15000 (default),
  - "localAddress": "212.150.139.167",
  - "retrievalCachePeriodSecs": 7200 (default),
  - "missedRetrievalCachePeriodSecs": 1800 (default),
  - "unusedArtifactsCleanupPeriodHours": 0 (default),
  - "assumedOfflinePeriodSecs" : 300 (default),
  - "fetchJarsEagerly": false (default),
  - "fetchSourcesEagerly": false (default),
  - "shareConfiguration": false (default),
  - "synchronizeProperties": false (default),
  - "blockMismatchingMimeTypes" : true (default),
  - "xrayIndex": false (default),
  - "propertySets": ["ps1", "ps2"],
  - "allowAnyHostAuth": false (default),              
  - "enableCookieManagement": false (default),
  - "enableTokenAuthentication": false (default), 
  - "forceNugetAuthentication": false (default),
  - "forceP2Authentication": false (default),
  - "forceConanAuthentication": false (default),
  - "metadataRetrievalTimeoutSecs": 60 (default),  
  - "bowerRegistryUrl": "https://registry.bower.io" (default),   
  - "gitRegistryUrl": "https://github.com/rust-lang/crates.io-index" (default),
  - "composerRegistryUrl": "https://packagist.org" (default),
  - "pyPIRegistryUrl": "https://pypi.org" (default),
  - "vcsType": "GIT" (default),
  - "vcsGitProvider": "GITHUB" (default) | "GITHUBENTERPRISE" | "BITBUCKET" | "OLDSTASH" | "STASH" | "ARTIFACTORY" | "CUSTOM",
  - "vcsGitDownloadUrl": "" (default),
  - "bypassHeadRequests" : false (default),
  - "clientTlsCertificate": "" (default),
  + "externalDependenciesEnabled": false (default, Applies to Docker repositories only),
  - "externalDependenciesPatterns": [ "**/*microsoft*/**", "**/*github*/**" ] (Applies to Docker repositories only)
  - "downloadRedirect" : "false" (default),
  - "cdnRedirect": "false" (default, Applies to Artifactory Cloud Only),
  - "feedContextPath":"api/v2",
  - "downloadContextPath":"api/v2/package",
  - "v3FeedUrl":"https://api.nuget.org/v3/index.json",
  - "listRemoteFolderItems": "false" (default),
  - "contentSynchronisation": {
      "enabled": false (default),
      "statistics": {
          "enabled": false (default)
      },
      "properties": {
          "enabled": false (default)
      },
      "source": {
          "originAbsenceDetection": false (default)
      }
        },
   - "blockPushingSchema1": false,    
   - "priorityResolution": false (default, Applies to all repository types excluding CocoaPods, Git LFS, NuGet V2, Opkg, Rust, Vagrant and VCS repositories),
   - "disableUrlNormalization": false (default)
}

Virtual Repository

application/vnd.org.jfrog.artifactory.repositories.VirtualRepositoryConfiguration+json

{
  - "key": "virtual-repo1",
  - "projectKey": "projx",
  - "environments":["DEV"] (mandatory when assigning repo to project),
  + "rclass" : "virtual",
  + "packageType": "alpine"|"composer"|"bower"|"chef"|"conan"|"conda"|"cran"|"debian"|"docker"|"helm"|"helmoci"|"huggingfaceml"|"gems"|"gitlfs"|"go"|"gradle"|"ivy"|"maven"|"npm"|"nuget"|"oci"|"pub"|"puppet"|"pypi"|"rpm"|"sbt"|"swift"|"terraform"|"ansible"|"generic" (default)   
  - "repositories": ["local-rep1", "local-rep2", "remote-rep1", "virtual-rep2"]
  - "description": "The virtual repository public description",
  - "notes": "Some internal notes",
  - "includesPattern": "**/*" (default),
  - "excludesPattern": "" (default),
  - "repoLayoutRef": "maven-2-default",
  - "debianTrivialLayout" : false,
  - "debianDefaultArchitectures" : "arm64,amd64", (applies to Debian repositories only),
  - "artifactoryRequestsCanRetrieveRemoteArtifacts": false,
  - "keyPair": "keypair1",
  - "pomRepositoryReferencesCleanupPolicy": "discard_active_reference" (default) | "discard_any_reference" | "nothing"
  - "defaultDeploymentRepo": "local-repo1",
  - "optionalIndexCompressionFormats" : ["bz2", "lzma", "xz"],  
  - "forceMavenAuthentication": false, (default - Applies to Maven repositories only),
  + "externalDependenciesEnabled": false (default - Applies to Bower, npm and Go repositories only),
  - "externalDependenciesPatterns": [ "**/*microsoft*/**", "**/*github*/**" ] (Applies to Bower, npm and Go repositories only),
  - "externalDependenciesRemoteRepo": "" (Applies to Bower and npm repositories only),
  - "primaryKeyPairRef": "mygpgkey",   
  - "secondaryKeyPairRef": "mysecgpgkey"
}

Federated Repository

application/vnd.org.jfrog.artifactory.repositories.FederatedRepositoryConfiguration+json

{ 
  - "key": "federated-repo1",
  - "projectKey": "projx",
  - "environments":["DEV"] (mandatory when assigning repo to project),
  + "rclass" : "federated",
  - "packageType": "alpine" | "maven" | "gradle" | "ivy" | "sbt" | "helm" | "helmoci" |"huggingfaceml" | "cargo" | "cocoapods" | "opkg" | "rpm"| "nuget" | "cran" | "gems" | "npm" | "bower" | "debian" | "composer" | "oci" | "pypi" | "docker" | "vagrant" | "gitlfs" | "go" | "ansible" | "conan" | "conda" | "chef" | "puppet" | "generic" (default)
  - "members": [{"url": "http://targetartifactory/artifactory/repositoryName", "enabled":"true"},": [{"url": "full URL to ending with the repositoryName", "enabled":"true by default. represents the active state of the federated member. it is supported to change the enabled status of my own member. the config will be updated on the other federated members automatically."} ]   //If a Federated member receives a request that does not include the repository URL, it will automatically be added with the combination of the configured base URL
     and "key" field value. Note that each of the federated members will need to have a base URL set,
  - "description": "The federated repository public description",
  - "proxy": "proxy-key", 
  - "disableProxy": false (default),
  - "notes": "Some internal notes",
  - "includesPattern": "**/*" (default),
  - "excludesPattern": "" (default),
  - "repoLayoutRef" : "maven-2-default" (default),
  - "debianTrivialLayout" : false,
  - "checksumPolicyType": "client-checksums" (default) | "server-generated-checksums"
  - "handleReleases": true (default),
  - "handleSnapshots": true (default),
  - "maxUniqueSnapshots": 0 (default),
  - "maxUniqueTags": 0 (default),
  - "snapshotVersionBehavior": "unique" (default) | "non-unique" | "deployer",
  - "suppressPomConsistencyChecks": false (default),
  - "blackedOut": false (default),
  - "xrayIndex" : false (default),
  - "propertySets": ["ps1", "ps2"],
  - "archiveBrowsingEnabled" : false,
  - "calculateYumMetadata" : false,
  - "yumRootDepth" : 0,
  - "dockerApiVersion" : "V2" (default),
  - "enableFileListsIndexing" : "false" (default),
  - "optionalIndexCompressionFormats" : ["bz2", "lzma", "xz"],
  - "downloadRedirect" : "false" (default),
  - "cdnRedirect": "false" (default, Applies to Artifactory Cloud Only),
  - "blockPushingSchema1": "false",
  - "primaryKeyPairRef": "mygpgkey",
  - "secondaryKeyPairRef": "mysecgpgkey",
  - "priorityResolution": false (default, Applies to all repository types excluding CocoaPods, Git LFS, NuGet V2, Opkg, RPM, Rust, Vagrant and VCS repositories)
}

Build Artifacts Request JSON

The Build Artifacts Request JSON is consumed by the following REST API endpoints:

{
  "buildName": "build-name",
  "buildNumber": "",
  "buildStatus": "Released",
  "buildRepo": "",
  "project": "Catalina",
  "repos": [ "lib-release-local", "ext-release-local" ],
  "archiveType": "tar.gz",
  "mappings": [ { "input": "(.+)/(.+)-sources.jar", "output": "$1/sources/$2.jar" }, { "input": "(.+)-release.zip", "output": "" } ]
}

Property

Required?

Description

buildName

mandatory

The build from which to get artifacts.

buildNumber

mandatory (see note)

The build number from which to get artifacts. Use LATEST to use the latest build.

Note: You can define either
buildNumber or buildStatus, but not both.

buildStatus

mandatory (see note)

The build status from which to get artifacts.

Note: You can define either
buildNumber or buildStatus, but not both.

buildRepo

optional

The repository where the build is located.

project

optional

The project related to the build.

repos

optional

When set, limits the search to the repositories defined here.

archiveType

mandatory

The archive type to send back to the user. Options include: zip, tar, tar.gz, tgz, tar.bz2.

mappings

optional

Refines the search using a list of regexp input and output patterns.

Security Configuration JSON

Legend

Element

Description

+

Mandatory element in create/replace queries (optional in "update" queries)

-

Optional element in create/replace queries

!


Read-only element

(default)


The default value when left unspecified in create/replace queries

application/vnd.org.jfrog.artifactory.security.User+json

{
  - "name": "davids",
  + "email" : "[email protected]",
  + "password": "***" (write-only, never returned),
  - "admin": false (default),
  - "profileUpdatable": true (default),
  - "disableUIAccess" : false (default),
  - "internalPasswordDisabled": false (default),
  ! "lastLoggedIn": ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ),
  ! "lastLoggedInMillis": 1735682400000,
  ! "realm": "Realm name (e.g. internal, saml, oauth, ldap, crowd, scim)",
  ! "groups" : [ "deployers", "users" ],
  - "watchManager": false(default),
  - "policyManager": false(default),
  - "policyViewer": false(default),
  - "reportsManager": false(default),
  ! "mfaStatus": "NONE" | "ENROLL" | "VERIFY",
  ! "status": "INVITED" | "ENABLED" | "DISABLED" | "LOCKED"
}

Property

Required?

Description

name

optional

The user name.

email

mandatory

The user's email address.

password

mandatory

The user's password.

admin

optional

Defines whether the user is an administrator. The default value is false.

profileUpdatable

optional

Defines whether the user has permission to change their profile details (except their password, which can be changed only by an administrator).

The default value is true.

disableUIAccess

optional

Defines whether the platform UI is disabled for this user.

The default value is false (meaning the user has access to the platform UI).

internalPasswordDisabled

optional

When set to true, the user password is cleared, which means that only external authentication is allowed (for example via an LDAP server). The default value is false.

lastLoggedIn

read-only

The timestamp of the last login by this user (ISO 8601 format).

lastLoggedInMillis

read-only

The timestamp of the last login by this user (in milliseconds).

realm

read-only

The authentication realm that manages this user's credentials.

groups

optional

The defined groups to which this user belongs.

watchManager

optional

[Xray users only] Defines whether the user can manage watches. The default value is false.

policyManager

optional

[Xray users only] Defines whether the user can manage policies. The default value is false.

policyViewer

optional

[Xray users only] Defines whether the user can view policies. The default value is false.

reportsManager

optional

[Xray users only} Defines whether the user can manage Xray Reports on any resource type. The default value is false.

mfaStatus

read-only

Defines the multi-factor authentication (MFA) status of this user:

  • NONE: MFA is not used
  • ENROLL: MFA is enabled but the user has not yet entered the verification code from the authenticator app.
  • VERIFY: MFA is enabled and the user has been verified by the authenticator app.

status

read-only

Defines the current status of the user:

  • INVITED: The user has been invited to join the JFrog platform by the administrator, but has yet to complete the process.
  • ENABLED: The user is active and can access the platform.
  • DISABLED: The user has been disabled (possibly due to a SCIM update from external providers which deactivated the user).
  • LOCKED: The user has been locked out of the platform due to excessive incorrect login attempts.

application/vnd.org.jfrog.artifactory.security.Group+json

{
  - "name": "dev-leads",
  - "description" : "The development leads group",
  - "autoJoin" : false (default, must be false if adminPrivileges is true),
  - "adminPrivileges" : false (default),
  ! "realm": "Realm name (e.g. internal, saml, ldap, crowd, scim)",
  ! "realmAttributes": "Realm attributes for use by LDAP"
  - "userNames" : [ "user1", "user2", "user3" ] //available from version 6.13 only for Update Group requests
  - "watchManager": false (default),
  - "policyManager": false (default),
  - "reportsManager": false (default)
  - "externalId" : "123"
  }

Property

Required?

Description

name

optional

The name of the group.

description

optional

An optional description of the group.

autoJoin

optional

Defines whether new users should join this group automatically. The default value is false.

Note: This property must be set to false if adminPrivileges is set to true.

adminPrivileges

optional

Defines whether the members of this group have administrator privileges. The default value is false.

realm

read-only

The authentication realm that manages this group's credentials.

realmAttributes

optional

Defines the configuration settings used to define how this group connects to and interacts with an LDAP server.

userNames

optional

An array of users to add as members to this group.

watchManager

optional

[Xray users only] Defines whether the users in this group can manage watches . The default value is false.

policyManager

optional

[Xray users only] Defines whether the users in this group can manage policies. The default value is false.

reportsManager

optional

[Xray users only} Defines whether the users in this group can manage Xray Reports on any resource type. The default value is false.

externalId

optional

If the group is managed by an external identity provider, this is the unique id generated by that provider. The externalId can be used to synchronize the group between the two different systems.

application/vnd.org.jfrog.artifactory.security.PermissionTarget+json

Permissions are set/returned according to the following conventions:

m=admin; d=delete; w=deploy; n=annotate; r=read; mxm=managedXrayMeta; x=distribute

Property

Required?

Description

name

optional

The name of the permission target.

Note: name is limited to 64 characters.

includesPattern

optional

A regex pattern that defines which repositories to include in this permission. The default is "**" (all).

Note: Limited to 1024 characters.

excludesPattern

optional

A regex pattern that defines which repositories to explicitly exclude from this permission. The default is "" (none).

Note: Limited to 1024 characters.

repositories

mandatory

Defines the local and remote repositories included as resources for this permission.

Note: Virtual repositories are not supported.

principals

optional

Defines the actions permitted to each user and group.

application/vnd.org.jfrog.artifactory.security.PermissionTargetV2+json

Permissions are set/returned according to the following conventions:

read, write, annotate, delete, manage, managedXrayMeta, distribute

You can specify the name "ANY" in the repositories section in order to apply to all repositories, "ANY REMOTE" for all remote repositories and "ANY LOCAL" for all local repositories.

{
  - "name": "java-developers",
  - "repo": {
     - "include-patterns": ["**"] (default),
     - "exclude-patterns": [""] (default),
     + "repositories": ["local-rep1", "local-rep2", "remote-rep1"],
     - "actions": {
          "users": {
            "bob": ["read","write","manage"],
            "alice": ["write","annotate", "read"]
        },
          "groups": {
            "dev-leads": ["manage","read","annotate"],
            "readers": ["read"]
       }
    }
}
 - "build": {
     - "include-patterns": [""] (default),
     - "exclude-patterns": [""] (default),
     + "repositories": ["artifactory-build-info"] (default, can't be changed),
     - "actions": {
          "users": {
            "bob": ["read","manage"],
            "alice": ["write"]
          },
          "groups": {
            "dev-leads": ["manage","read","write","annotate","delete"],
            "readers": ["read"]
          }
    }
  }
 - "releaseBundle":{
    - "include-patterns": ["**"],
    - "exclude-patterns": [],
   + "repositories": ["release-bundles"],
   - "actions": {
        "users": {
          "user_name":["read", “write” etc..]
       }, 
        "groups":{
          "group_name":[“read”, “write” etc..]
       }
   }
}
PropertyRequired?Description
nameoptionalThe name of the permission target.
repooptionalDefines which repositories are included in this permission and the actions that can be performed by each user and group. Include and exclude patterns are supported.
buildoptionalDefines which builds are included in this permission and the actions that can be performed by each user and group. Include and exclude patterns are supported.
releaseBundleoptionalDefines which Release Bundles are included in this permission and the actions that can be performed by each user and group. Include and exclude patterns are supported.

System Settings JSON

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", ... ]
}
PropertyDescription
versionThe Artifactory version number.
revisionThe revision number.
addonsThe list of active add-ons.

Updated 7 days ago