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" : ""
}

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" : ""
}

Repository Configuration JSON

Legend

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"|"bazelmodules"|"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),
     - "customHttpHeaders": [ { "name": "x-api-key", "value": "...", "sensitive": false } ] 
       (default: omitted or empty; headers sent to the remote repository URL; names validated per system settings; enable the sensitive flag to ensure that the header value is encrypted and masked in API responses)
}

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"|"bazelmodules"|"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" |"bazelmodules"|"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:

• Build Artifacts Search
• Retrieve Build Artifacts Archive

{
  "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": "" } ]
}

Security Configuration JSON

Legend

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"
}

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"
  }

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

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..]
       }
   }
}

System Settings JSON

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

{
  "importPath" : "/import/path",
  "includeMetadata" : true,
  "verbose" : false,
  "failOnError" : true,
  "failIfEmpty" : 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
}

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

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