Cloud customer?
Start for Free >
Upgrade in MyJFrog >
What's New in Cloud >

Search





Repository Configuration JSON

Legend

+

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

Page Contents

 

Local Repository

application/vnd.org.jfrog.artifactory.repositories.LocalRepositoryConfiguration+json
{
  - "key": "local-repo1",
  - "projectKey": "projx",
  - "environments":["DEV", "PROD"],
  + "rclass" : "local",
  - "packageType": "alpine" | "maven" | "gradle" | "ivy" | "sbt" | "helm" | "cargo" | "cocoapods" | "opkg" | "rpm"| "nuget" | "cran" | "gems" | "npm" | "bower" | "debian" | "composer" | "pypi" | "docker" | "vagrant" | "gitlfs" | "go" | "yum" | "conan" | "chef" | "puppet" | "generic" (default)
  - "description": "The local repository public description", 
  - "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" | "non-unique" (default) | "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",
  - "keyPairRef": "pairName",
  - "priorityResolution": "false" (default, Applies to Docker, PyPI, RubyGems, and NPM repositories only)
}

Remote Repository

application/vnd.org.jfrog.artifactory.repositories.RemoteRepositoryConfiguration+json
{
  - "key": "remote-repo1",
  - "projectKey": "projx",
  - "environments":["DEV", "PROD"],
  + "rclass" : "remote",
  - "packageType": "alpine" | "maven" | "gradle" | "ivy" | "sbt" | "helm" | "cargo" |"cocoapods" | "opkg" | "rpm"| "nuget" | "cran"|"gems" | "npm" | "bower" | "debian" | "pypi" | "docker" | "yum" | "vcs" | "composer" | "go" | "p2" | "chef" | "puppet" | "generic" (default)
  + "url" : "http://host:port/some-repo",
  - "username": "remote-repo-user",
  - "password": "pass",
  - "proxy": "proxy1",
  - "description": "The remote repository public description",
  - "notes": "Some internal notes",
  - "includesPattern": "**/*" (default),
  - "excludesPattern": "" (default),
  - "repoLayoutRef" : "maven-2-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": 43200 (default),
  - "missedRetrievalCachePeriodSecs": 7200 (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),   
  - "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) | "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",
  - "contentSynchronisation": {
      "enabled": false (default),
      "statistics": {
          "enabled": false (default)
      },
      "properties": {
          "enabled": false (default)
      },
      "source": {
          "originAbsenceDetection": false (default)
      }
  	},
   - "blockPushingSchema1": "false",    - "priorityResolution": "false" (default, Applies to Docker, PyPI, RubyGems, and NPM repositories only)
}}

Virtual Repository

application/vnd.org.jfrog.artifactory.repositories.VirtualRepositoryConfiguration+json
{
  - "key": "virtual-repo1",
  - "projectKey": "projx",
  - "environments":["DEV", "PROD"],
  + "rclass" : "virtual",
  + "packageType": "alpine" | "maven" | "gradle" | "ivy" | "sbt" | "helm" | "rpm" | "nuget" | "cran" |"gems" | "npm" | "bower" | "pypi" | "docker" | "p2" | "yum" | "go" | "chef" | "puppet" | "generic"
  - "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,
  - "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),
  - "keyPairRef": "pairName"
}

Federated Repository

application/vnd.org.jfrog.artifactory.repositories.FederatedRepositoryConfiguration+json
  - "key": "federated-repo1",
  - "projectKey": "projx",
  - "environments":["DEV", "PROD"],
  + "rclass" : "federated",
  - "packageType": "alpine" | "maven" | "gradle" | "ivy" | "sbt" | "helm" | "cargo" | "cocoapods" | "opkg" | "rpm"| "nuget" | "cran" | "gems" | "npm" | "bower" | "debian" | "composer" | "pypi" | "docker" | "vagrant" | "gitlfs" | "go" | "yum" | "conan" | "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",
  - "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" | "non-unique" (default) | "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",
  - "keyPairRef": "pairName"
}




  • No labels
Copyright © 2021 JFrog Ltd.