GET /api/build { "uri": "http://localhost:8080/artifactory/api/build" "builds" : [ { "uri" : "/wicket", "lastStarted" : ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ) }, { "uri" : "/jackrabbit", "lastStarted" : ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ) } ] }

GET /api/build/wicket { "uri": "http://localhost:8080/artifactory/api/build/wicket" "buildsNumbers" : [ { "uri" : "/51", "started" : ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ) }, { "uri" : "/52", "started" : ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ) } ] }

{“版本”:“1.0.1”、“名称”:“Maven2-3”、“number" : "9", "type" : "MAVEN", "buildAgent" : { "name" : "Maven", "version" : "3.0.5" }, "agent" : { "name" : "Jenkins", "version" : "1.565.2" }, "started" : "2015-03-20T11:01:38.445+0200", "durationMillis" : 8926, "artifactoryPrincipal" : "admin", "url" : "http://localhost:8080/job/Maven2-3/9/", "vcsRevision" : "83049487ecc61bef3dce798838e7a9457e174a5a", "vcsUrl" : "https://github.com/aseftel/project-examples", "licenseControl" : { "runChecks" : false, "includePublishedArtifacts" : false, "autoDiscover" : true, "scopesList" : "", "licenseViolationsRecipientsList" : "" }, "buildRetention" : { "count" : -1, "deleteBuildArtifacts" : true, "buildNumbersNotToBeDiscarded" : [ ] }, "modules" : [ { "properties" : { "project.build.sourceEncoding" : "UTF-8" }, "id" : "org.jfrog.test:multi:2.19-SNAPSHOT", "artifacts" : [ { "type" : "pom", "sha1" : "045b66ebbf8504002b626f592d087612aca36582", "md5" : "c25542a353dab1089cd186465dc47a68", "name" : "multi-2.19-SNAPSHOT.pom" } ] }, { "properties" : { "project.build.sourceEncoding" : "UTF-8" }, "id" : "org.jfrog.test:multi1:2.19-SNAPSHOT", "artifacts" : [ { "type" : "jar", "sha1" : "f4c5c9cb3091011ec2a895b3dedd7f10d847361c", "md5" : "d1fd850a3582efba41092c624e0b46b8", "name" : "multi1-2.19-SNAPSHOT.jar" }, { "type" : "pom", "sha1" : "2ddbf9824676f548d637726d3bcbb494ba823090", "md5" : "a64aa7f305f63a85e63a0155ff0fb404", "name" : "multi1-2.19-SNAPSHOT.pom" }, ... { "type" : "jar", "sha1" : "6fdd143a44cea3a2636660c5c266c95c27e50abc", "md5" : "12a1e438f4bef8c4b740fe848a1704a4", "id" : "org.slf4j:slf4j-simple:1.4.3", "scopes" : [ "compile" ] }, { "type" : "jar", "sha1" : "496e91f7df8a0417e00cecdba840cdf0e5f2472c", "md5" : "76a412a37c9d18659d2dacccdb1c24ff", "id" : "org.jenkins-ci.lib:dry-run-lib:0.1", "scopes" : [ "compile" ] } ] }, { "properties" : { "daversion" : "2.19-SNAPSHOT", "project.build.sourceEncoding" : "UTF-8" }, "id" : "org.jfrog.test:multi2:2.19-SNAPSHOT", "artifacts" : [ { "type" : "txt", "name" : "multi2-2.19-SNAPSHOT.txt" }, { "type" : "java-source-jar", "sha1" : "49108b0c7db5fdb4efe3c29a5a9f54e806aecb62", "md5" : "0e2c5473cf2a9b694afb4a2e8da34b53", "name" : "multi2-2.19-SNAPSHOT-sources.jar" }, ... { "type" : "jar", "sha1" : "476e89d290ae36dabb38ff22f75f264ae019d542", "md5" : "fa9b3df58ac040fffcff9310f261be80", "name" : "multi2-2.19-SNAPSHOT.jar" }, { "type" : "pom", "sha1" : "b719b90364e5ae38cda358072f61f821bdae5d5d", "md5" : "8d5060005235d75907baca4490cf60bf", "name" : "multi2-2.19-SNAPSHOT.pom" } ], "dependencies" : [ { "type" : "jar", "sha1" : "19d4e90b43059058f6e056f794f0ea4030d60b86", "md5" : "dcd95bcb84b09897b2b66d4684c040da", "id" : "xpp3:xpp3_min:1.1.4c", "scopes" : [ "provided" ] }, { "type" : "jar", "sha1" : "e2d866af5518e81282838301b49a1bd2452619d3", "md5" : "e9e4b59c69305ba3698dd61c5dfc4fc8", "id" : "org.jvnet.hudson.plugins:perforce:1.3.7", "scopes" : [ "compile" ] }, ... { "type" : "jar", "sha1" : "6fdd143a44cea3a2636660c5c266c95c27e50abc", "md5" : "12a1e438f4bef8c4b740fe848a1704a4", "id" : "org.slf4j:slf4j-simple:1.4.3", "scopes" : [ "compile" ] }, { "type" : "jar", "sha1" : "496e91f7df8a0417e00cecdba840cdf0e5f2472c", "md5" : "76a412a37c9d18659d2dacccdb1c24ff", "id" : "org.jenkins-ci.lib:dry-run-lib:0.1", "scopes" : [ "compile" ] } ] }, { "properties" : { "project.build.sourceEncoding" : "UTF-8" }, "id" : "org.jfrog.test:multi3:2.19-SNAPSHOT", "artifacts" : [ { "type" : "java-source-jar", "sha1" : "3cd104785167ac37ef999431f308ffef10810348", "md5" : "c683276f8dda97078ae8eb5e26bb3ee5", "name" : "multi3-2.19-SNAPSHOT-sources.jar" }, { "type" : "war", "sha1" : "34aeebeb805b23922d9d05507404533518cf81e4", "md5" : "55af06a2175cfb23cc6dc3931475b57c", "name" : "multi3-2.19-SNAPSHOT.war" }, ... { "type" : "jar", "sha1" : "496e91f7df8a0417e00cecdba840cdf0e5f2472c", "md5" : "76a412a37c9d18659d2dacccdb1c24ff", "id" : "org.jenkins-ci.lib:dry-run-lib:0.1", "scopes" : [ "compile" ] }, { "type" : "jar", "sha1" : "7e9978fdb754bce5fcd5161133e7734ecb683036", "md5" : "7df83e09e41d742cc5fb20d16b80729c", "id" : "hsqldb:hsqldb:1.8.0.10", "scopes" : [ "runtime" ] } ] } ], "governance" : { "blackDuckProperties" : { "runChecks" : false, "includePublishedArtifacts" : false, "autoCreateMissingComponentRequests" : false, "autoDiscardStaleComponentRequests" : false } }

GET /api/build/wicket/51 { "uri": "http://localhost:8080/artifactory/api/build/wicket/51" "buildInfo" : { ... } }

GET /api/build/wicket/51?diff=50 { "artifacts": { "updated": [], "unchanged": [], "removed": [], "new": [] }, "dependencies": { "updated": [], "unchanged": [], "removed": [], "new": [] }, "properties": { "updated": [], "unchanged": [], "removed": [], "new": [] } }

Build Promotion

Description: Change the status of a build, optionally moving or copying the build's artifacts and its dependencies to a target repository and setting properties on promoted artifacts.
All artifacts from all scopes are included by default while dependencies are not. Scopes are additive (or).
Since: 2.3.3
Notes: Requires Artifactory Pro
Security: Requires a privileged user (can be anonymous)
Usage: POST /api/build/promote/{buildName}/{buildNumber}
Consumes: application/vnd.org.jfrog.artifactory.build.PromotionRequest+json

POST / api /构建/升级/ wicket / 51{“状态”:“staged" // new build status (any string) "comment" : "Tested on all target platforms." // An optional comment describing the reason for promotion. Default: "" "ciUser": "builder" // The user that invoked promotion from the CI server "timestamp" : ISO8601 // the time the promotion command was received by Artifactory "dryRun" : false // run without executing any operation in Artifactory, but get the results to check if the operation can succeed. Default: false "sourceRepo" : "libs-snapshot-local" // "Optional repository. If some of the build's artifacts are located in more than one repository, use this field to specify from which repository artifacts will be promoted "targetRepo" : "libs-release-local" // optional repository to move or copy the build's artifacts and/or dependencies "copy": false // whether to copy instead of move, when a target repository is specified. Default: false "artifacts" : true // whether to move/copy the build's artifacts. Default: true "dependencies" : true // whether to move/copy the build's dependencies. Default: false. "scopes" : [ "compile", "runtime" ] // an array of dependency scopes to include when "dependencies" is true "properties": { // a list of properties to attach to the build's artifacts (regardless if "targetRepo" is used). "components": ["c1","c3","c14"], "release-name": ["fb3-ga"] } "failFast": true // fail and abort the operation upon receiving an error. Default: true }

Produces: application/vnd.org.jfrog.artifactory.build.PromotionResult+json
SampleOutput:

{ "messages" : [ { "level": "error", "message": "The repository has denied...." },... ] }

Delete Builds

Description: Removes builds stored in Artifactory. Useful for cleaning up old build info data.
If theartifactsparameter is evaluated as 1 (0/false by default), build artifacts are also removed.
If thedeleteAllparameter is evaluated as 1 (0/false by default), the whole build is removed.
Since: 2.3.0; artifact removal since 2.3.3;
Notes: Requires Artifactory Pro
Security: Requires an admin user
Usage: DELETE /api/build/{buildName}[?buildNumbers=n1[,n2]][&artifacts=0/1][&deleteAll=0/1]
Produces: application/text
Sample Usage:

删除/ api /构建/ wicket吗?buildNumbers = 51岁,52岁,55艺术类课程ifacts=1 The following builds has been deleted successfully: 'wicket#51', 'wicket#52', 'wicket#55'. DELETE /api/build/wicket All 'wicket' builds have been deleted successfully.

Build Rename

Description: Renames a build stored in Artifactory. Typically used to keep the build info in sync with a renamed build on the CI server.
Since: 2.2.5
Notes: Requires Artifactory Pro
Security: Requires a valid user with deploy permissions
Usage: POST /api/build/rename/{buildName}?to=newBuildName
Produces: application/text
Sample Usage:

POST /api/build/rename/myJobName?to=myNewJobName Build renaming of 'myJobName' to 'myNewJobName' was successfully started.

Push Build to Bintray

Description: Push a build to Bintray as a version.
Uses a descriptor file (that must have 'bintray-info' in it's filename and a .json extension) that is included with the build artifacts. For more details, please refer toPushing a Build.
Signing a version is controlled by thegpgSignparameter in the descriptor file, and thegpgSignparamater passed to this command.The value passed to this command always takes precedence over the value in the descriptor file.
If you also want a passphrase to be applied to your signature, specify gpgPassphrase=.
You may omit the descriptor file by passing 6 override parameters (see below). If you wish to use the descriptor file you should pass an empty json string instead.

Since: 3.5.0
Security: Requires a valid user with deploy permissions and Bintray credentials defined (if the default Bintray credential set is empty)
Usage: POST /api/build/pushToBintray/{build.name}/{build.number}?gpgPassphrase=[&gpgSign=true\false]
Consumes: application/vnd.org.jfrog.artifactory.build.BintrayDescriptorOverrideParams+json
SampleInput:

POST /api/build/pushToBintray/testBuild/1?gpgPassphrase=password&gpgSign=true { "subject": "myUser", "repoName": "test", "packageName": "overridePkg", "versionName": "overrideVer", "licenses": ["MIT"], "vcs_url": "https://github.com/bintray/bintray-client-java" }

SampleOutput:

{"Message": "Pushing build to Bintray finished successfully."}

ARTIFACTS & STORAGE

Folder Info

Description: Folder Info
For virtual use, the virtual repository returns the unified children.Supported by local, local-cached and virtual repositories.
Since: 2.2.0
Security: Requires a privileged user (can be anonymous)
Usage: GET /api/storage/{repoKey}/{folder-path}
Produces: application/vnd.org.jfrog.artifactory.storage.FolderInfo+json
SampleOutput:

GET /api/storage/libs-release-local/org/acme { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme", "repo": "libs-release-local", "path": "/org/acme", "created": ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ), "createdBy": "userY", "lastModified": ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ), "modifiedBy": "userX", "lastUpdated": ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ), "children": [ { "uri" : "/child1", "folder" : "true" },{ "uri" : "/child2", "folder" : "false" } ] }

File Info

Description: File Info
For virtual use the virtual repository returns the resolved file. Supported by local, local-cached and virtual repositories.
Since: 2.2.0
Security: Requires a privileged user (can be anonymous)
Usage: GET /api/storage/{repoKey}/{filePath}
Produces: application/vnd.org.jfrog.artifactory.storage.FileInfo+json
SampleOutput:

GET /api/storage/libs-release-local/org/acme/lib/ver/lib-ver.pom { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/lib/ver/lib-ver.pom", "downloadUri": "http://localhost:8080/artifactory/libs-release-local/org/acme/lib/ver/lib-ver.pom", "repo": "libs-release-local", "path": "/org/acme/lib/ver/lib-ver.pom", "remoteUrl": "http://some-remote-repo/mvn/org/acme/lib/ver/lib-ver.pom", "created": ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ), "createdBy": "userY", "lastModified": ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ), "modifiedBy": "userX", "lastUpdated": ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ), "size": "1024", //bytes "mimeType": "application/pom+xml", "checksums": { "md5" : string, "sha1" : string }, "originalChecksums":{ "md5" : string, "sha1" : string } }

Item Last Modified

Description:检索在给定拍最后一个修改项h. If the given path is a folder, the latest last modified item is searched for recursively. Supported by local and local-cached repositories.
Since: 2.2.5
Notes: Requires Artifactory Pro
Security: Requires a valid user with deploy permissions
Usage: GET /api/storage/{repoKey}/{item-path}?lastModified
Produces: application/vnd.org.jfrog.artifactory.storage.ItemLastModified+json
SampleOutput:

GET /api/storage/libs-release-local/org/acme?lastModified { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/foo/1.0-SNAPSHOT/foo-1.0-SNAPSHOT.pom", "lastModified": ISO8601 }

File Statistics

Description:Item statistics record the number of times an item was downloaded, last download date and last downloader.Supported by local and local-cached repositories.
Since:3.1.0
Security:Requires read privileges
Usage:GET /api/storage/{repoKey}/{item-path}?stats
Produces:application/vnd.org.jfrog.storage.StatsInfo+json
Sample Output:

GET /api/storage/libs-release-local/org/acme/foo/1.0/foo-1.0.jar?stats { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/foo/1.0/foo-1.0.jar", "lastDownloaded": Timestamp (ms), "downloadCount": 1337, "lastDownloadedBy": "user1" }

Item Properties

Description: Item Properties. Optionally return only the properties requested. Supported by local and local-cached repositories.
Since: 2.2.1
Security: Requires a privileged user (can be anonymous)
Usage: GET /api/storage/{repoKey}/{itemPath}?properties[=x[,y]]
Produces: application/vnd.org.jfrog.artifactory.storage.ItemProperties+json
SampleOutput:

GET /api/storage/libs-release-local/org/acme?properties\[=x[,y]\] { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme" "properties":{ "p1": ["v1","v2","v3"], "p2": ["v4","v5","v6"] } }

Set Item Properties

Description: Attach properties to an item (file or folder). When a folder is used property attachment is recursive by default.
为了提供特殊字符(逗号(,),backslash(\), pipe(|), equals(=)) as key/value you must add a backslash (\) before them. For example: ..?properties=a=1\=1 will attach key a with 1=1 as value
Supported by local and local-cached repositories.
Notes: Requires Artifactory Pro
Since: 2.3.0
Security: Requires a privileged user (can be anonymous)
Usage: PUT /api/storage/{repoKey}{itemPath}?properties=p1=v1[,v2][|p2=v3][&recursive=1]
Sample Usage:

PUT /api/storage/libs-release-local/ch/qos/logback/logback-classic/0.9.9?properties=os=win,linux|qa=done&recursive=1

Delete Item Properties

Description: Deletes the specified properties from an item (file or folder). When a folder is used property removal is recursive by default.Supported by local and local-cached repositories.
Notes: Requires Artifactory Pro
Since: 2.3.2
Security: Requires a privileged user (can be anonymous)
Usage: DELETE /api/storage/{repoKey}{itemPath}?properties=p1[,p2][&recursive=1]
Sample Usage:

DELETE /api/storage/libs-release-local/ch/qos/logback/logback-classic/0.9.9?properties=os,qa&recursive=1

Retrieve Artifact

Description: Retrieves an artifact from the specified destination.
You can also useProperty-based Resolutionas part of retrieving artifacts.
Security: Requires a user with 'read' permission (can be anonymous)
Usage: GET /repo-key/path/to/artifact.ext
Sample Usage:

GET http://localhost:8080/artifactory/libs-release-local/ch/qos/logback/logback-classic/0.9.9/logback-classic-0.9.9.jar

Retrieve Latest Artifact

Description: Retrieves the youngest (last uploaded) artifact version from the specified destination.
Latest Maven Release/Integration: SpecifySNAPSHOTor[RELEASE]for the version in the requested path to get the latest Maven integration or release artifact.
Latest Non-Maven Release/Integration: Specify[INTEGRATION]or[RELEASE]for the version in the requested path (replacing the[folderItegRev]and[fileItegRev]
as defined by the repository'slayout) to get the latest integration version or latest release version artifact accordingly.
Integration and release tokens cannot be mixed together. Only local, cache and virtual repositories will be used.
You can also useproperty-based resolutionas part of retrieving artifacts.
Notes: Requires Artifactory Pro.
Since: Latest Maven: 2.6.0; Latest non-Maven: 2.6.2
Security: Requires a user with 'read' permission (can be anonymous)
Usage: GET /repo-key/path/to/artifact.ext
SampleUsage:

Download the latest Maven unique snapshot artifact:

GET http://localhost:8080/artifactory/libs-release-local/ch/qos/logback/logback-classic/0.9.9-SNAPSHOT/logback-classic-0.9.9-SNAPSHOT.jar

Download the latest release artifact:

GET http://localhost:8080/artifactory/ivy-local/org/acme/[RELEASE]/acme-[RELEASE].jar

Download the latest integration artifact:

GET http://localhost:8080/artifactory/ivy-local/org/acme/1.0-[INTEGRATION]/acme-1.0-[INTEGRATION].jar

Retrieve Build Artifacts Archive

Description: Retrieves an archive file (supports zip/tar/tar.gz/tgz) containing all the artifacts related to a specific build, you can optionally provide mappings to filter the results,
the mappings supportregexp capturing groupswhich enables you to dynamically construct the target path inside the result archive file.
Notes: Requires Artifactory Pro
Since: 2.6.5
Security: Requires a privileged user (can be anonymous)
Usage: POST /api/archive/buildArtifacts
Consumes: application/vnd.org.jfrog.artifactory.build.BuildArtifactsRequest+json
Produces:application/zip (for zip archive type), application/x-tar (for tar archive type), application/x-gzip (fortar.gz/tgzarchive type)
Sample Usage:

POST /api/archive/buildArtifacts { +"buildName": "build-name" // The build name for search by +"buildNumber": "15" // The build number to search by, can be LATEST to search for the latest build number -"buildStatus": "Released" // Optionally search by latest build status (e.g: "Released") -"repos": ["libs-release-local,ext-release-local"] // Optionally refine search for specific repos, omit to search within all repositories +"archiveType": "tar/zip/tar.gz/tgz" // The archive file type to return -"mappings": [ // Optionally refine the search by providing a list of regexp patterns to search by { "input": "(.+)/(.+)-sources.jar", "output": "$1/sources/$2.jar" // Optionally provide different path of the found artifacts inside the result archive, supports regexp groups tokens }, { "input": "(.+)-release.zip" } ] }

Trace Artifact Retrieval

Description: Simulates an artifact retrieval request from the specified location and returns verbose output about the resolution process.
This API is useful for debugging artifact retrieval issues.
Security: As applied to standard artifact retrieval by the requesting user.
Since: 2.6.0
Usage: GET /repo-key/path/to/artifact.ext?trace
Produces: text/plain
SampleOutput:

GET http://localhost:8080/artifactory/libs-release-local/jmock/jmock/1.0.1/jmock-1.0.1.jar?trace Request ID: 51c808f6 Repo Path ID: libs-release-local:jmock/jmock/1.0.1/jmock-1.0.1.jar Method Name: GET User: resolver Time: 2012-05-06T10:49:09.528+03:00 Thread: pool-1-thread-31 Steps: 2012-05-06T10:49:09.587+03:00 Received request 2012-05-06T10:49:09.588+03:00 Request source = 0:0:0:0:0:0:0:1, Last modified = 01-01-70 01:59:59 IST, If modified since = -1, Thread name = pool-1-thread-31 2012-05-06T10:49:09.697+03:00 Retrieving info 2012-05-06T10:49:09.723+03:00 Identified resource as a file ... 2012-05-06T10:49:09.788+03:00 Responding with selected content handle 2012-05-06T10:49:09.807+03:00 Request succeeded

Archive Entry Download

Description: Retrieves an archived resource from the specified archive destination.
Security: Requires a user with 'read' permission (can be anonymous)
Usage: GET /repo-key/path/to/artifact.jar*!*/path/to/archived/resource (NOTE!the '!' between the archive file name and the archive entry path)
SampleOutput:

GET http://localhost:8080/artifactory/repo1-cache/commons-lang/commons-lang/2.6/commons-lang-2.6.jar!/META-INF/LICENSE.txt

Create Directory

Description: Create new directory at the specified destination.
Notes: You can alsoattach propertiesas part of creating directories.
Security: Requires a user with 'deploy' permissions (can be anonymous)
Usage: PUT /repo-key/path/to/directory/
Produces: application/vnd.org.jfrog.artifactory.storage.ItemCreated+json
Sample Usage:

PUT /libs-release-local/path/to/directory/ { "uri": "http://localhost:8080/artifactory/libs-release-local/path/to/directory", "repo": "libs-release-local", "path": "/path/to/directory", "created": ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ), "createdBy": "userY", "children" : [ ] }

Deploy Artifact

Description: Deploy an artifact to the specified destination.
Notes: You can alsoattach propertiesas part of deploying artifacts.
Security: Requires a user with 'deploy' permissions (can be anonymous)
Usage: PUT /repo-key/path/to/artifact.ext
Produces: application/vnd.org.jfrog.artifactory.storage.ItemCreated+json
Sample Usage:

PUT /libs-release-local/my/jar/1.0/jar-1.0.jar { "uri": "http://localhost:8080/artifactory/libs-release-local/my/jar/1.0/jar-1.0.jar", "downloadUri": "http://localhost:8080/artifactory/libs-release-local/my/jar/1.0/jar-1.0.jar", "repo": "libs-release-local", "path": "/my/jar/1.0/jar-1.0.jar", "created": ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ), "createdBy": "userY", "size": "1024", //bytes "mimeType": "application/java-archive", "checksums": { "md5" : string, "sha1" : string }, "originalChecksums":{ "md5" : string, "sha1" : string } }

Deploy Artifact by Checksum

Description: Deploy an artifact to the specified destination by checking if the artifact content already exists in Artifactory.
如果Artifactory已经包含一个用户可读的基于“增大化现实”技术tifact with the same checksum the artifact content is copied over to the new location and return a response without requiring content transfer.
Otherwise, a 404 error is returned to indicate that content upload is expected in order to deploy the artifact.
Notes: You can alsoattach propertiesas part of deploying artifacts.
Security: Requires a user with 'deploy' permissions (can be anonymous)
Usage: PUT /repo-key/path/to/artifact.ext
Headers: X-Checksum-Deploy: true, X-Checksum-Sha1: sha1Value
Produces: application/vnd.org.jfrog.artifactory.storage.ItemCreated+json
Since: 2.5.1
SampleOutput:

PUT /libs-release-local/my/jar/1.0/jar-1.0.jar { "uri": "http://localhost:8080/artifactory/libs-release-local/my/jar/1.0/jar-1.0.jar", "downloadUri": "http://localhost:8080/artifactory/libs-release-local/my/jar/1.0/jar-1.0.jar", "repo": "libs-release-local", "path": "/my/jar/1.0/jar-1.0.jar", "created": ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ), "createdBy": "userY", "size": "1024", //bytes "mimeType": "application/java-archive", "checksums": { "md5" : string, "sha1" : string }, "originalChecksums":{ "md5" : string, "sha1" : string } }

Deploy Artifacts from Archive

Description: Deploys an archive containing multiple artifacts and explodes it at the specified destination maintaining the archive's file structure.
Deployment is performed in a single HTTP request and only the exploded content is deployed, not the archive file itself.
Supported archive types are: zip; tar; tar.gz; and tgz.NOTE!that deployment of compressed archives (unlike tar) may incur considerable CPU overhead.
Notes:Requires Artifactory Pro
Security: Requires a user with 'deploy' permissions (can be anonymous)
Usage: PUT /repo-key/path/to/archive.zip
Headers: X-Explode-Archive: true
Produces: text/plain
Since: 2.6.3
Sample Usage:

PUT /libs-release-local/archive.zip

Push a Set of Artifacts to Bintray

Description: Push a set of artifacts to Bintray as a version.
Uses a descriptor file (that must have 'bintray-info' in it's filename and a .json extension) that was deployed to artifactory, the call accepts the full path to the descriptor as a parameter.
For more details, please refer toPushing a Set of Files.
Signing a version is controlled by thegpgSignparameter in the descriptor file, and thegpgSignparamater passed to this command.The value passed to this command always takes precedence over the value in the descriptor file.
If you also want a passphrase to be applied to your signature, specify gpgPassphrase=.

Security: Requires a valid user with deploy permissions and Bintray credentials defined (if the default Bintray credential set is empty).
Usage: POST /api/bintray/push/?descriptor=pathToDescriptorFile[&gpgPassphrase=passphrase][&gpgSign=true\false]
Since: 3.5.0
Produces: application/vnd.org.jfrog.artifactory.bintray.BintrayPushResponse+json

SampleOutput:

{"Message": "Pushing build to Bintray finished successfully."}

Push Docker Tag to Bintray

Description: Push Docker tag to Bintray
Calculation can be synchronous (the default) or asynchronous.
You will need to enter your Bintray credentials, for more details, please refer to Entering your Bintray credentials.
Security: Requires a valid user with deploy permissions and Bintray credentials defined (if the default Bintray credential set is empty).
Usage: POST /api/bintray/docker/push/{repoKey}
Since: 3.6.0
Produces: text/plain

SampleOutput:

POST api/bintray/docker/push/docker-local { "dockerImage": "jfrog/ubuntu:latest", // The docker image to push, use ':' for specific tag or leave blank for 'latest' "bintraySubject": "shayy", // The Bintray Subject "bintrayRepo": "containers", // The Bintray Subject's repository "async": false // Optionally execute the push asynchronously. Default: false }

File Compliance Info

Description: Get compliance info for a given artifact path. The result includes license and vulnerabilities, if any.Supported by local and local-cached repositories.
Notes:Requires Artifactory Pro, requires Black Duck addon enabled.
Since: 3.0.0
Security: Requires an authenticated user.
Usage: GET: /api/compliance/{repoKey}/{item-path}
Produces: application/json
Sample output:

GET: /api/compliance/libs-release-local/ch/qos/logback/logback-classic/0.9.9/logback-classic-0.9.9.jar { "licenses" : [ {"name":"LGPL v3", "url": "http://"}, {"name":"APL v2", "url": "http://"}... ], "vulnerabilities" : [ {"name":"CVE-13427", "url": "http://"}, {"name":"CVE-1041", "url": "http://"}... ] }

Delete Item

Description: Deletes a file or a folder from the specified destination.
Security: Requires a user with 'delete' permission (can be anonymous)
Usage: DELETE /repo-key/path/to/file-or-folder
Sample Usage:

DELETE http://localhost:8080/artifactory/libs-release-local/ch/qos/logback/logback-classic/0.9.9

Copy Item

Description: Copy an artifact or a folder to the specified destination.Supported by local repositories only.
Optionally suppress cross-layout module path translation during copy.
You can test the copy using a dry run.
Copy item behaves similarly to a standard file system and supports renames. If the target path does not exist, the source item is copied and optionally renamed. Otherwise, if the target exists and it is a directory,
the source is copied and placed under the target directory.
Notes: Requires Artifactory Pro
Security: Requires a privileged user (can be anonymous)
Usage: POST /api/copy/{srcRepoKey}/{srcFilePath}?to=/{targetRepoKey}/{targetFilePath}[&dry=1][&suppressLayouts=0/1][&failFast=0/1]
Produces: application/vnd.org.jfrog.artifactory.storage.CopyOrMoveResult+json
Since: 2.2.2
SampleOutput:

POST /api/copy/libs-release-local/org/acme?to=/ext-releases-local/org/acme-new&dry=1 { "messages" : [ { "level": "error", "message": "The repository has denied...." },... ] }

Move Item

Description: Moves an artifact or a folder to the specified destination.Supported by local repositories only.
Optionally suppress cross-layout module path translation during move.
You can test the move using dry run.
Move item behaves similarly to a standard file system and supports renames. If the target path does not exist, the source item is moved and optionally renamed. Otherwise, if the target exists and it is a directory,
the source is moved and placed under the target directory.
Notes: Requires Artifactory Pro
Security: Requires a privileged user (can be anonymous)
Usage: POST /api/move/{srcRepoKey}/{srcFilePath}?to=/{targetRepoKey}/{targetFilePath}[&dry=1][&suppressLayouts=0/1][&failFast=0/1]
Produces: application/vnd.org.jfrog.artifactory.storage.CopyOrMoveResult+json
Since: 2.2.2
SampleOutput:

POST /api/move/libs-release-local/org/acme?to=/ext-releases-local/org/acme-new&dry=1 { "messages" : [ { "level": "error", "message": "The repository has denied...." },... ] }

Get Repository Replication Configuration

Description: Returns the replication configuration for the given repository key, if found.Supported by local and remote repositories.
Notes: Requires Artifactory Pro
Security: Requires a privileged user
Usage: GET /api/replications/{repoKey}
Produces: application/vnd.org.jfrog.artifactory.replications.ReplicationConfigRequest+json
Since: 3.1.1
Sample Usage:

GET /api/replications/libs-release-local { "url" : "http://localhost:8081/artifactory/remote-repo", "socketTimeoutMillis" : 15000, "username" : "admin", "password" : "password", "enableEventReplication" : false, "enabled" : true, "cronExp" : "0 0 12 * * ?", "syncDeletes" : true, "syncProperties" : true, "repoKey" : "libs-release-local" }

Set Repository Replication Configuration

Description: Add or replace replication configuration for given repository key.Supported by local and remote repositories.
Notes: Requires Artifactory Pro
Security: Requires a privileged user
Usage: PUT /api/replications/{repoKey}
Consumes: application/vnd.org.jfrog.artifactory.replications.ReplicationConfigRequest+json
Since: 3.1.1
Sample Usage:

PUT /api/replications/libs-release-local

Update Repository Replication Configuration

Description: Update existing replication configuration for given repository key, if found.Supported by local and remote repositories.
Notes: Requires Artifactory Pro
Security: Requires a privileged user
Usage:发布/ api /复制/ {repoKey}
Consumes: full or partial application/vnd.org.jfrog.artifactory.replications.ReplicationConfigRequest+json
Since: 3.1.1
Sample Usage:

POST /api/replications/libs-release-local

Delete Repository Replication Configuration

Description: Delete existing replication configuration for given repository key.Supported by local and local-cached repositories.
Notes: Requires Artifactory Pro
Security: Requires a privileged user
Usage: DELETE /api/replications/{repoKey}
Since: 3.1.1
Sample Usage:

DELETE /api/replications/libs-release-local

Scheduled Replication Status

Description: Returns the status of scheduledcron-basedreplication jobs define via the Artifactory UI on repositories.Supported by local, local-cached and remote repositories.
Notes: Requires Artifactory Pro
Security: Requires a user with 'read' permission (can be anonymous)
Usage: GET /api/replication/{repoKey}
Produces: application/vnd.org.jfrog.artifactory.replication.ReplicationStatus+json
Since: 2.4.2
Sample Usage:

GET /api/replication/remote-libs { "status": never_run|incomplete(running or interrupted)|error|warn|ok|inconsistent "lastCompleted": ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ) or null if never completed }

Pull/Push Replication

Description: Schedules immediate content replication between two Artifactory instances. Replication can include properties and can optionally delete local items if they do not exist in the source repository.
This API completes the exitingcron-basedreplication exposed via the Artifactory UI and allows for on-demand execution.
Pull Replication - pulls content from a remote Artifactory repository to a local cache of the remote repository.
Push Replication - pushes content from a local repository into a remote Artifactory local repository.
Supported by local, local-cached and remote repositories.
Notes: Requires Artifactory Pro
Security: Requires a privileged user (can be anonymous) For non-admin users will replicate at max the number of files as defined by theartifactory.search.userQueryLimitsystem property.
Usage: POST /api/replication/{srcRepoKey}/{srcPath}
Consumes: application/vnd.org.jfrog.artifactory.replication.ReplicationRequest+json
Since: 2.4.0
Sample Usage:

POST /api/replication/libs-release-local/com/acme { - "properties": true, //Sync item properties (true by default) - "delete": true, //Sync deletions (false by default) //The following is only applicable for push replication + "url" : "https://repo.nmiy.org/repo-key", // The remote repository URL + "username": "replicator", //The name of a user with deploy permissions on the remote repository + "password": "***", //The remote repository password - "proxy": "org-prox", //A name of an Artifactory-configured proxy to use for remote requests }

+=mandatory; -=optional

Create or Replace Local Multi-push Replication

Description:Creates or replaces a local multi-push replication configuration.Supported by local and local-cached repositories.
Notes: Requires an enterprise license
Security: Requires an admin user.
Usage:PUT /api/replications/multiple
Consumes: application/vnd.org.jfrog.artifactory.replications.MultipleReplicationConfigRequest+json
Since: 3.7
Sample Usage:

PUT /api/replications/multiple { "cronExp":"0 0/9 14 * * ?", "enableEventReplication":true, "replications":[ { + "url": "http://localhost:8081/artifactory/repo-k", + "socketTimeoutMillis": 15000, + "username": "admin", + "password": "password", - "enableEventReplication": true, - "enabled": true, - "syncDeletes": false, - "syncProperties": true, - "repoKey": "libs-release-local" } , { + "url": "http://localhost:8081/artifactory/repo-v", + "socketTimeoutMillis": 15000, + "username": "admin", + "password": "password", - "enableEventReplication": true, - "enabled": true, - "syncDeletes": false, - "syncProperties": true, - "repoKey": "libs-release-local" } ] }

+=mandatory; -=optional

Update Local Multi-push Replication

Description:Updates a local multi-push replication configuration. Supported by local and local-cached repositories.
Notes: Requires an enterprise license
Security: Requires an admin user.
Usage:POST /api/replications/multiple
Consumes: application/vnd.org.jfrog.artifactory.replications.MultipleReplicationConfigRequest+json
Since: 3.7
Sample Usage:

POST / api /复制/多个{“cronExp”:“0 0/914 * * ?", "enableEventReplication":true, "replications":[ { + "url": "http://localhost:8081/artifactory/repo-k", + "socketTimeoutMillis": 15000, + "username": "admin", + "password": "password", - "enableEventReplication": true, - "enabled": true, - "syncDeletes": false, - "syncProperties": true, - "repoKey": "libs-release-local" } , { + "url": "http://localhost:8081/artifactory/repo-v", + "socketTimeoutMillis": 15000, + "username": "admin", + "password": "password", - "enableEventReplication": true, - "enabled": true, - "syncDeletes": false, - "syncProperties": true, - "repoKey": "libs-release-local" } ] }

+=mandatory; -=optional

Delete Local Multi-push Replication

Description:Deletes a local multi-push replication configuration. Supported by local and local-cached repositories.
Notes: Requires an enterprise license
Security: Requires an admin user.
Usage:DELETE /api/replications/{repoKey}?url={replicatedURL}
Produces:application/vnd.org.jfrog.artifactory.replications.ReplicationConfigRequest+json,application/vnd.org.jfrog.artifactory.replications.MultipleReplicationConfigRequest+json

Since: 3.7
Sample Usage:

DELETE /api/replications/libs-release-local?url=http://10.0.0.1/artifactory/libs-release-local

摇身fact Sync Download

Description: Downloads an artifact with or without returning the actual content to the client. When tracking the progress marks are printed (by default every 1024 bytes). This is extremely useful if you want to trigger downloads on a remote Artifactory server,
for example to force eager cache population of large artifacts, but want to avoid the bandwidth consumption involved in transferring the artifacts to the triggering client. If no content parameter is specified the file content is downloaded to the client.
Notes: This API isdeprecated. Requires Artifactory Pro
Security: Requires a privileged user (can be anonymous)
Usage: GET /api/download/{repoKey}/{filePath}[?content=none/progress][&mark=numOfBytesToPrintANewProgressMark]
Produces: application/octet-stream, text/plain (depending on content type)
Since: 2.2.2
SampleOutput:

GET /api/download/my-remote/org/acme/1.0/acme-1.0.jar?content=progress&mark=512 ..................................................... ..................................................... ..... Completed: 150/340 bytes

Folder Sync (Deprecated)

Description: Triggers a no-content download of artifacts from a remote Artifactory repository for all artifacts under the specified remote folder. Can optionally delete local files if they do not exist in the remote folder,
overwrite local files only if they are older than remote files or never overwrite local files.
The default is not to delete any local files and to overwrite older local files with remote ones. By default progress marks of the sync are displayed. The default timeout for the remote file list is 15000 milliseconds (15 seconds).
Notes: This API isdeprecated. Requires Artifactory Pro
Security: Requires a privileged user (can be anonymous) For non-admin users will replicate at max the number of files as defined by theartifactory.search.userQueryLimitsystem property.
Usage: GET /api/sync/{remoteRepositoryKey}/{folderPath}[?progress=showProgress][&mark=numOfBytesToPrintANewProgressMark][&delete=deleteExistingFiles][&overwrite=never/force][&timeout=fileListTimeoutInMillis]
Produces: text/plain
Since: 2.2.4
SampleOutput:

GET /api/sync/my-remote/org/acme/1.0?progress=1&delete=1 ..................................................... ..................................................... ..................................................... .......................................... Completed: 970/1702 bytes ..................................................... .................. Completed: 1702/1702 bytes Completed with 0 errors and 2 warnings (please check the server log for more details).

File List

Description: Get a flat (the default) or deep listing of the files and folders (not included by default) within a folder.
For deep listing you can specify an optional depth to limit the results.
Optionally include a map of metadata timestamp values as part of the result (only properties are displayed in since 3.0.0).
folder inclusion since 2.3.2; checksum inclusion since: 2.3.3; include folder root path since: 2.5.2. Supported by all types of repositories.
Since: 2.2.4
Notes: Requires Artifactory Pro
Security: Requires a non-anonymous privileged user.
Usage: GET /api/storage/{repoKey}/{folder-path}?list[&deep=0/1][&depth=n][&listFolders=0/1][&mdTimestamps=0/1][&includeRootPath=0/1]
Produces: application/vnd.org.jfrog.artifactory.storage.FileList+json
SampleOutput:

GET /api/storage/libs-release-local/org/acme?list&deep=1&listFolders=1&mdTimestamps=1 { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme", "created": ISO8601, "files" : [ { "uri": "/archived", "size": "-1", "lastModified": ISO8601, "folder": "true" }, { "uri": "/doc.txt", "size": "253207", //bytes "lastModified": ISO8601, "folder": "false", "sha1": sha1Checksum, "mdTimestamps": { "properties" : lastModified (ISO8601) } }, { "uri": "/archived/doc1.txt", "size": "253100", //bytes "lastModified": ISO8601, "folder": "false", "sha1": sha1Checksum, "mdTimestamps": { "properties" : lastModified (ISO8601) } },... ] }

SEARCHES

摇身factory Query Language (AQL)

POST /api/search/aql items.find( { "repo":{"$eq":"jcenter"} } )

{ "results" : [ { "repo" : "libs-release-local", "path" : "org/jfrog/artifactory", "name" : "artifactory.war", "type" : "item type", "size" : "75500000", "created" : "2015-01-01T10:10;10", "created_by" : "Jfrog", "modified" : "2015-01-01T10:10;10", "modified_by" : "Jfrog", "updated" : "2015-01-01T10:10;10" } ], "range" : { "start_pos" : 0, "end_pos" : 1, "total" : 1 } }

摇身fact Search (Quick Search)

Description: Artifact search by part of file name.
Searches return file info uris. Can limit search to specific repositories (local or caches).
Since: 2.2.0
Security: Requires a privileged user (can be anonymous)
Usage: GET /api/search/artifact?name=name[&repos=x[,y]]
Headers (Optionally):X-Result-Detail: info (To add all extra information of the found artifact), X-Result-Detail: properties (to get the properties of the found artifact), X-Result-Detail: info, properties (for both).
Produces: application/vnd.org.jfrog.artifactory.search.ArtifactSearchResult+json
SampleOutput:

GET /api/search/artifact?name=lib&repos=libs-release-local { "results": [ { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/lib/ver/lib-ver.pom" },{ "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/lib/ver2/lib-ver2.pom" } ] }

Archive Entry Search (Class Search)

Description: Search archive entries for classes or any other jar resources.
Can limit search to specific repositories (local or caches).
Since: 2.2.0
Security: Requires a privileged user (can be anonymous)
Usage: GET /api/search/archive?name=[archiveEntryName][&repos=x[,y]]
Produces: application/vnd.org.jfrog.artifactory.search.ArchiveEntrySearchResult+json
SampleOutput:

GET /api/search/archive?name=*Logger.class&repos=third-party-releases-local,repo1-cache { "results" :[ { "entry": "org/apache/jackrabbit/core/query/lucene/AbstractIndex.LoggingPrintStream.class", "archiveUris": [ "http://localhost:8080/artifactory/api/storage/third-party-releases-local/org/apache/jackrabbit/ jackrabbit-core/1.2.3/jackrabbit-core-1.2.3.jar", "http://localhost:8080/artifactory/api/storage/third-party-releases-local/org/apache/jackrabbit/ jackrabbit-core/1.3.1/jackrabbit-core-1.3.1.jar" ] },{ "entry": "org/codehaus/plexus/logging/AbstractLogger.class", "archiveUris": [ "http://localhost:8080/artifactory/api/storage/repo1-cache/org/codehaus/plexus/plexus-container-default/ 1.0-alpha-9-stable-1/plexus-container-default-1.0-alpha-9-stable-1.jar" ] } ] }

GAVC Search

Description: Search by Maven coordinates: GroupId, ArtifactId, Version & Classifier.
Search must contain at least one argument. Can limit search to specific repositories (local or caches).
Since: 2.2.0
Security: Requires a privileged user (can be anonymous)
Usage: GET /api/search/gavc?[g=groupId][&a=artifactId][&v=version][&c=classifier][&repos=x[,y]]
Headers (Optionally):X-Result-Detail: info (To add all extra information of the found artifact), X-Result-Detail: properties (to get the properties of the found artifact), X-Result-Detail: info, properties (for both).
Produces: application/vnd.org.jfrog.artifactory.search.GavcSearchResult+json
SampleOutput:

GET /api/search/gavc?g=org.acme&a=artifact&v=1.0&c=sources&repos=libs-release-local { "results": [ { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/artifact/1.0/artifact-1.0-sources.jar" },{ "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/artifactB/1.0/artifactB-1.0-sources.jar" } ] }

Property Search

Description: Search by properties.
If no value is specified for a property - assume '*'. Can limit search to specific repositories (local or caches).
Since: 2.2.0
Security: Requires a privileged user (can be anonymous)
Usage: GET /api/search/prop?[p1=v1,v2][&p2=v3][&repos=x[,y]]
Headers (Optionally):X-Result-Detail: info (To add all extra information of the found artifact), X-Result-Detail: properties (to get the properties of the found artifact), X-Result-Detail: info, properties (for both).
Produces: application/vnd.org.jfrog.artifactory.search.MetadataSearchResult+json
SampleOutput:

GET /api/search/prop?p1=v1,v2&p2=v3&repos=libs-release-local { "results" : [ { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/lib/ver/lib-ver.pom" },{ "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/lib/ver2/lib-ver2.pom" } ] }

Checksum Search

Description: Artifact search by checksum (md5 or sha1)
Searches return file info uris. Can limit search to specific repositories (local or caches).
Notes: Requires Artifactory Pro
Since: 2.3.0
Security: Requires a privileged user (can be anonymous)
Usage: GET /api/search/checksum?md5=md5sum?sha1=sha1sum[&repos=x[,y]]
Headers (Optionally):X-Result-Detail: info (To add all extra information of the found artifact), X-Result-Detail: properties (to get the properties of the found artifact), X-Result-Detail: info, properties (for both).
Produces: application/vnd.org.jfrog.artifactory.search.ChecksumSearchResult+json
SampleOutput:

GET /api/search/checksum?md5=04040c7c184620af0a0a8a3682a75eb7&repos=libs-release-local { "results": [ { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/jfrog/build-info-api/1.3.1/build-info-api-1.3.1.jar" } ] }

Bad Checksum Search

Description: Find all artifacts that have a bad or missing client checksum values (md5 or sha1)
Searches return file info uris. Can limit search to specific repositories (local, caches or virtuals).
Notes: Requires Artifactory Pro
Since: 2.3.4
Security: Requires a privileged user (can be anonymous)
Usage: GET /api/search/badChecksum?type=md5|sha1[&repos=x[,y]]
Produces: application/vnd.org.jfrog.artifactory.search.BadChecksumSearchResult+json
SampleOutput:

GET /api/search/badChecksum?type=md5&repos=libs-release-local { "results": [ { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/jfrog/build-info-api/1.3.1/build-info-api-1.3.1.jar" "serverMd5": "4040c7c184620af0a0a8a3682a75eb7" "clientMd5": "4040c7c184620af0a0a8a3682a75e44" //On missing checksum this element will be an empty string } ] }

摇身facts Not Downloaded Since

Description: Retrieve all artifacts not downloaded since the specified Java epoch inmilliseconds.
Optionally include only artifacts created before the specifiedcreatedBeforedate, otherwise only artifacts created beforenotUsedSinceare returned.
Can limit search to specific repositories (local or caches).
Since: 2.2.4
Security: Requires a privileged non-anonymous user.
Usage: GET /api/search/usage?notUsedSince=javaEpochMillis[&createdBefore=javaEpochMillis][&repos=x[,y]]
Produces: application/vnd.org.jfrog.artifactory.search.ArtifactUsageResult+json
SampleOutput:

GET /api/search/usage?notUsedSince=long&createdBefore=long&repos=libs-release-local { "results" : [ { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/lib/ver/lib-ver.jar", "lastDownloaded": ISO8601 },{ "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/lib/ver2/lib-ver2.jar", lastDownloaded: ISO8601 } ] }

摇身facts With Date in Date Range

Description: Get all artifacts with specified dates within the given range.Search can be limited to specific repositories (local or caches).
Since: 3.2.1
Security: Requires a privileged non-anonymous user.
Usage: GET /api/search/dates?[from=fromVal][&to=toVal][&repos=x[,y]][&dateFields=c[,d]]
Parameters: Thefromandtoparameters can be either a long value for the java epoch (millisecondssince the epoch), or an ISO8601 string value.fromis mandatory. Iftois not provided, now() will be used instead, and if either are omitted,400 bad requestis returned.
ThedateFieldsparameter is a comma separated list of date fields that specify which fields thefromandtovalues should be applied to. The date fields supported are:created,lastModified,lastDownloaded.
It is a mandatory field and it also dictates which fields will be added to the JSON returned.
If ANY of the specified date fields of an artifact is within the specified range, the artifact will be returned.

Produces: application/vnd.org.jfrog.artifactory.search.ArtifactResult+json

SampleOutput:

/ api /搜索/日期吗?datefield =创建,lastModified,lastDownloaded&from=long&to=long&repos=libs-release-local { "results" : [ { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/lib/ver/lib-ver.jar", "created": ISO8601, "lastModified": ISO8601, "lastDownloaded": ISO8601 },{ "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/lib/ver2/lib-ver2.jar", "created": ISO8601. "lastModified": ISO8601, "lastDownloaded": ISO8601 } ] }

摇身facts Created in Date Range

Description: Get All Artifacts Created in Date Range
If 'to' is not specified use now(). Can limit search to specific repositories (local or caches).
Since: 2.2.0
Security: Requires a privileged non-anonymous user.
Usage: GET /api/search/creation?from=javaEpochMillis[&to=javaEpochMillis][&repos=x[,y]]
Produces: application/vnd.org.jfrog.artifactory.search.ArtifactCreationResult+json
SampleOutput:

GET /api/search/creation?from=long&to=long&repos=libs-release-local { "results" : [ { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/lib/ver/lib-ver.jar", "created": ISO8601 },{ "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/lib/ver2/lib-ver2.jar", "created": ISO8601 } ] }

Pattern Search

Description: Get all artifacts matching the given Ant path pattern
Since: 2.2.4
Notes: Requires Artifactory Pro. Pattern "**" is not supported to avoid overloading search results.
Security: Requires a privileged non-anonymous user.
Usage: GET /api/search/pattern?pattern=repo-key:this/is/a/*pattern*.war
Produces: application/vnd.org.jfrog.artifactory.search.PatternResultFileSet+json
SampleOutput:

GET / api /搜索/模式?模式= libs-release-local:killer/*/ninja/*/*.jar { "repositoryUri" : "http://localhost:8080/artifactory/libs-release-local", "sourcePattern" : "libs-release-local:killer/*/ninja/*/*.jar", files : [ "killer/coding/ninja/1.0/monkey-1.0.jar", "killer/salty/ninja/1.5-SNAPSHOT/pickle-1.5-SNAPSHOT.jar" ] }

Builds for Dependency

Description: Find all the builds an artifact is a dependency of (where the artifact is included in the build-info dependencies)
Notes: Requires Artifactory Pro
Since: 2.3.4
Security: Requires a privileged user (can be anonymous)
Usage: GET /api/search/dependency?sha1=sha1Checksum
Produces: application/vnd.org.jfrog.artifactory.search.DependencyBuilds+json
SampleOutput:

GET /api/search/dependency?sha1=451a3c5f8cfa44c5d805379e760b5c512c7d250b { "results" : [ { "uri": "http://localhost:8080/artifactory/api/build/wicket/50" },{ "uri": "http://localhost:8080/artifactory/api/build/wicket/51" } ] }

License Search

Description: Search for artifacts with specified statuses.
To search by specific license values use Property Search with the 'artifactory.licenses' property.
Default parameter values when unspecified: unapproved=1, unknown=1, notfound=0, neutral=0, approved=0, autofind=0.
When theautofindparameter is specified Artifactory will try to automatically find new license information and return it as part of the result in thefoundfield. Please note that this can affect the speed of the search quite dramatically.
Can limit search to specific repositories (local or caches).
Since: 2.3.0
Notes: Requires Artifactory Pro
Security: Requires an admin user
Usage: GET /api/search/license[?unapproved=1][&unknown=1][¬found=0][&neutral=0][&approved=0][&autofind=0][&repos=x[,y]]
Produces: application/vnd.org.jfrog.artifactory.search.LicenseResult+json
SampleOutput:

GET /api/search/license?approved=1&unknown=1&autofind=1&repos=libs-release-local,staging { "results" : [ { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/lib/ver/lib-ver.jar", "license": "lgplv2", "found": "lgplv2", "status": "approved" },{ "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme/lib/ver/lib-ver.jar", "license": "cddlv1", "found": "gplv3", "status": "neutral" },{ "uri": "http://localhost:8080/artifactory/api/storage/staging/org/acme/lib/ver2/lib-ver2.jar", "license": "gplv3", "found": "gplv3", "status": "unapproved" } ] }

摇身fact Version Search

Description: Search for all available artifact versions by GroupId and ArtifactId in local, remote or virtual repositories.
Search can be limited to specific repositories (local, remote and virtual) by settings thereposparameter.
Release/integration versions: Unless theversionparameter is specified, both release and integration versions are returned. Whenversionis specified, e.g.1.0-SNAPSHOT, result includes only integration versions.

Integration versions are determined by therepository layoutof the repositories searched. For integration search to work the repository layout requires an 'Artifact Path Pattern' that contains thebaseRevtoken and then thefileItegRevtoken with only literals between them.
Remote searches: By default only local and cache repositories are used. When specifyingremote=1, Artifactory searches for versions on remote repositories.NOTE!that this can dramatically slow down the search.
For Maven repositories the remotemaven-metadata.xmlis consulted. For non-maven layouts, remote file listing runs for all remote repositories that have the 'List Remote Folder Items' checkbox enabled.
Filtering results (Artifactory 3.0.2+):Theversionparameter can accept the * and/or ? wildcards which will then filter the final result to match only those who match the given version pattern.
Since: 2.6.0
Notes: Requires Artifactory Pro
Security: Requires a privileged user (can be anonymous)
Usage: GET /api/search/versions?[g=groupId][&a=artifactId][&v=version][&remote=0/1][&repos=x[,y]]
Produces: application/vnd.org.jfrog.artifactory.search.ArtifactVersionsResult+json

SampleOutput:

GET /api/search/versions?g=org.acme&a=artifact&repos=libs-release-local { "results": [ { "version": "1.2", "integration": false },{ "version": "1.0-SNAPSHOT", "integration": true },{ "version": "1.0", "integration": false } ] }

摇身fact Latest Version Search Based on Layout

Description:根据groupI搜索最新的工件版本d and artifactId,based on the layout defined in the repository
Search can be limited to specific repositories (local, remote and virtual) by settings thereposparameter.
Latest release vs. latest integration: Unless theversionparameter is specified, the search returns the latest artifact release version. Whenversionis specified, e.g.1.0-SNAPSHOT, the result is the latest integration version. Integration versions are determined by therepository layoutof the repositories searched. For integration search to work the repository layout requires an "Artifact Path Pattern" that contains thebaseRevtoken and then thefileItegRevtoken with only literals between them.
Remote searches: By default only local and cache repositories will be used. When specifyingremote=1, Artifactory searches for versions on remote repositories.NOTE!that this can dramatically slow down the search.
For Maven repositories the remotemaven-metadata.xmlwill be consulted. For non-Maven layouts, remote file listing runs for all remote repositories that have the 'List Remote Folder Items' checkbox enabled.
Filtering results (Artifactory 3.0.2+):Theversionparameter can accept the * and/or ? wildcards which will then filter the final result to match only those who match the given version pattern.
Since: 2.6.0
Notes: Requires Artifactory Pro
Security: Requires a privileged user (can be anonymous)
Usage: GET /api/search/latestVersion?[g=groupId][&a=artifactId][&v=version][&remote=1][&repos=x[,y]]
Produces: text/plain
SampleOutput:

GET /api/search/latestVersion?g=org.acme&a=artifact&v=1.0-SNAPSHOT&repos=libs-snapshot-local 1.0-201203131455-2

摇身fact Latest Version Search Based on Properties

Description:Search for artifacts with the latest value in the "version" property. Only artifacts with a "version" property expressly defined will be returned. Results can be filtered by specifying additional properties.
{repo}: Specify a repository to search through or replace with "_any" to search through all repositories
{path}: Specify a path to search through or replace with "_any" to search through all paths
listFiles=0 (default): Artifactory will only retrieve the latest version
listFiles=1: Artifactory will retrieve the latest version and the corresponding files
You may specify filters to restrict the set of artifacts that are searched by adding any properties to your search URL
Notes:Requires Artifactory Pro
Since:3.1.1
Security:Requires an authenticated user (not anonymous) to use the api and read permission to the repository of each artifact.
Usage:GET /api/versions/{repo}/{path}?[listFiles=0/1]&[=]&[=]
Consumes:json
Examples:

Return the latest version and corresponding artifacts by searching for through all repositories whose path starts with a/b and are annotated with the properties os=win and license=GPL. GET /api/versions/_any/a/b?os=win&license=GPL&listFiles=1 { "version" : "1.1.2", "artifacts" : [ { "uri" : "http://...." }] } Return the latest version (without the corresponding artifacts) by searching through all repositories whose path starts with a/b and are annotated with the properties os=win and license=GPL. Return only the version. GET /api/versions/_any/a/b?os=win&license=GPL { "version" : "1.1.2", "artifacts" : [] }

Build Artifacts Search

Description: Find all the artifacts related to a specific build.
Notes: Requires Artifactory Pro
Since: 2.6.5
Security: Requires a privileged user (can be anonymous)
Usage: POST /api/search/buildArtifacts
Consumes: application/vnd.org.jfrog.artifactory.search.BuildArtifactsRequest+json
Sample Usage:

POST / api /搜索/ buildArtifacts{+“buildName”:“build-name" // The build name for search by +"buildNumber": "15" // The build number to search by, can be LATEST to search for the latest build number -"buildStatus": "Released" // Optionally search by latest build status (e.g: "Released") -"repos": ["libs-release-local,ext-release-local"] // Optionally refine search for specific repos, omit to search within all repositories -"mappings" [ // Optionally refine the search by providing a list of regexp patterns to search by { "input": "(.+)-sources.jar" }, { "input": "(.+)-javadoc.jar" } ] }

Produces:application/vnd.org.jfrog.artifactory.search.BuildArtifactsSearchResult+json
SampleOutput:

POST /api/search/buildArtifacts { "results" : [ { "downloadUri": "http://localhost:8080/artifactory/libs-release-local/org/acme/lib/ver/lib-sources.jar" },{ "downloadUri": "http://localhost:8080/artifactory/ext-release-local/org/acme/lib/ver/lib-ver-javadoc.jar" } ] }

SECURITY

Get Users

Description: Get the users list
Since: 2.4.0
Notes: Requires Artifactory Pro
Security: Requires an admin user
Usage: GET /api/security/users
Produces:application/vnd.org.jfrog.artifactory.security.Users+json
Sample Output:

GET /api/security/users [ { "name": "davids" "uri" : "http://localhost:8080/artifactory/api/security/users/davids" }, { "name": "danl" "uri" : "http://localhost:8080/artifactory/api/security/users/danl" } ]

Get User Details

Description: Get the details of an Artifactory user
Since: 2.4.0
Notes: Requires Artifactory Pro
Security: Requires an admin user
Usage: GET /api/security/users/{userName}
Produces:application/vnd.org.jfrog.artifactory.security.User+json
Sample Output:

GET /api/security/users/davids { user.json }

Get User Encrypted Password

Description: Get the encrypted password of the authenticated requestor
Since: 3.3.0
Security: Requires a privileged user
Usage: GET /api/security/encryptedPassword
Produces: plain/text
Sample Output:

GET /api/security/encryptedPassword AP5v2zs9ga7CJNZb74u3arAKE5B

Create or Replace User

Description: Creates a new user in Artifactory or replaces an existing user
Since: 2.4.0
Notes: Requires Artifactory Pro
Missing values will be set to the default values as defined by the consumed type.
Security: Requires an admin user
Usage: PUT /api/security/users/{userName}
Consumes:application/vnd.org.jfrog.artifactory.security.User+json
Sample Usage:

PUT /api/security/users/davids { user.json }

Update User

Description: Updates an exiting user in Artifactory with the provided user details.
Since: 2.4.0
Notes: Requires Artifactory Pro
Security: Requires an admin user
Usage: POST /api/security/users/{userName}
Consumes:application/vnd.org.jfrog.artifactory.security.User+json
Sample Usage:

POST /api/security/users/davids { user.json }

Delete User

Description: Removes an Artifactory user.
Since: 2.4.0
Notes: Requires Artifactory Pro
Security: Requires an admin user
Usage: DELETE /api/security/users/{userName}
Produces: application/text
Sample Usage:

DELETE /api/security/users/davids User 'davids' has been removed successfully.

Get Groups

Description: Get the groups list
Since: 2.4.0
Notes: Requires Artifactory Pro
Security: Requires an admin user
Usage: GET /api/security/groups
Produces:application/vnd.org.jfrog.artifactory.security.Groups+json
Sample Output:

GET /api/security/groups [ { "name": "readers" "uri" : "http://localhost:8080/artifactory/api/security/groups/readers" }, { "name": "tech-leads" "uri" : "http://localhost:8080/artifactory/api/security/groups/tech-leads" } ]

Get Group Details

Description: Get the details of an Artifactory Group
Since: 2.4.0
Notes: Requires Artifactory Pro
Security: Requires an admin user
Usage: GET /api/security/groups/{groupName}
Produces:application/vnd.org.jfrog.artifactory.security.Group+json
Sample Output:

GET /api/security/groups/dev-leads { group.json }

Create or Replace Group

Description: Creates a new group in Artifactory or replaces an existing group
Since: 2.4.0
Notes: Requires Artifactory Pro
Missing values will be set to the default values as defined by the consumed type.
Security: Requires an admin user
Usage: PUT /api/security/groups/{groupName}
Consumes:application/vnd.org.jfrog.artifactory.security.Group+json
Sample Usage:

PUT /api/security/groups/dev-leads { group.json }

Update Group

Description: Updates an exiting group in Artifactory with the provided group details.
Since: 2.4.0
Notes: Requires Artifactory Pro
Security: Requires an admin user
Usage: POST /api/security/groups/{groupName}
Consumes:application/vnd.org.jfrog.artifactory.security.Group+json
Sample Usage:

POST /api/security/groups/dev-leads { group.json }

Delete Group

Description: Removes an Artifactory group.
Since: 2.4.0
Notes: Requires Artifactory Pro
Security: Requires an admin user
Usage: DELETE /api/security/groups/{groupName}
Produces: application/text
Sample Usage:

DELETE /api/security/groups/dev-leads Group 'dev-leads' has been removed successfully.

Get Permission Targets

Description: Get the permission targets list
Since: 2.4.0
Notes: Requires Artifactory Pro
Security: Requires an admin user
Usage: GET /api/security/permissions
Produces:application/vnd.org.jfrog.artifactory.security.PermissionTargets+json
Sample Output:

GET /api/security/permissions [ { "name": "readSourceArtifacts" "uri" : "http://localhost:8080/artifactory/api/security/permissions/readSourceArtifacts" }, { "name": "populateCaches" "uri" : "http://localhost:8080/artifactory/api/security/permissions/populateCaches" } ]

Get Permission Target Details

Description: Get the details of an Artifactory Permission Target
Since: 2.4.0
Notes: Requires Artifactory Pro
Security: Requires an admin user
Usage: GET /api/security/permissions/{permissionTargetName}
Produces:application/vnd.org.jfrog.artifactory.security.PermissionTarget+json
Sample Output:

GET /api/security/permissions/populateCaches { permission-target.json }

Create or Replace Permission Target

Description: Creates a new permission target in Artifactory or replaces an existing permission target
Since: 2.4.0
Notes: Requires Artifactory Pro
Missing values will be set to the default values as defined by the consumed type.
Security: Requires an admin user
Usage: PUT /api/security/permissions/{permissionTargetName}
Consumes:application/vnd.org.jfrog.artifactory.security.PermissionTarget+json
Sample Usage:

PUT /api/security/permissions/populateCaches { permission-target.json }

Delete Permission Target

Description: Deletes an Artifactory permission target.
Since: 2.4.0
Notes: Requires Artifactory Pro
Security: Requires an admin user
Usage: DELETE /api/security/permissions/{permissionTargetName}
Produces: application/text
Sample usage:

DELETE /api/security/permissions/populateCaches Permission Target 'remoteCachePopulation' has been removed successfully.

Effective Item Permissions

Description: Returns a list of effective permissions for the specified item (file or folder).
Only users and groups with some permissions on the item are returned. Supported by local and local-cached repositories.
Permissions are returned according to the following conventions:
m=admin; d=delete; w=deploy; n=annotate; r=read
Notes: Requires Artifactory Pro
Since: 2.3.4
Security: Requires a valid admin or local admin user.
Usage: GET /api/storage/{repoKey}/{itemPath}?permissions
Produces: application/vnd.org.jfrog.artifactory.storage.ItemPermissions+json
Sample Output:

GET /api/storage/libs-release-local/org/acme?permissions { "uri": "http://localhost:8080/artifactory/api/storage/libs-release-local/org/acme" "principals": { "users" : { "bob": ["r","w","m"], "alice" : ["d","w","n", "r"] }, "groups" : { "dev-leads" : ["m","r","n"], "readers" : ["r"] } } }

Security Configuration

Description: Retrieve the security configuration (security.xml).
Since: 2.2.0
Notes: This is an advanced feature - make sure the new configuration is really what you wanted before saving.
Security: Requires a valid admin user
Usage: GET /api/system/security
Produces: application/xml
Sample Output:

GET /api/system/security 

Save Security Configuration

Description: Save the security configuration (security.xml). Requires the security.xml file from the same version.
Since: 2.2.0
Notes: This API isdeprecated.
Security: Requires a valid admin user
Usage: POST /api/system/security
Consumes: application/xml
Sample Usage:

POST /api/system/security 

Activate Master Key Encryption

Description: Creates a new master key and activates master key encryption.
Since: 3.2.2
Notes: This is an advanced feature intended for administrators
Security: Requires a valid admin user
Usage: POST /api/system/encrypt
Produces: text/plain
Sample Usage:

POST /api/system/encrypt DONE

Deactivate Master Key Encryption

POST /api/system/decrypt DONE

PUT /api/gpg/key/public

GET /api/gpg/key/public

PUT /api/gpg/key/private

PUT /api/gpg/passphrase

Get Repositories

Description: Returns a list of minimal repository details for all repositories of the specified type.
Since: 2.2.0
Security: Requires a privileged user (can be anonymous)
Usage: GET /api/repositories[?type=repositoryType (local|remote|virtual)]
Produces: application/vnd.org.jfrog.artifactory.repositories.RepositoryDetailsList+json
Sample Output:

GET / api /存储库[{“关键”:“libs-releases-local", "type" : "LOCAL", "description" : "Local repository for in-house libraries", "url" : "http://localhost:8080/artifactory/libs-releases-local" }, { "key" : "libs-snapshots-local", "type" : "LOCAL", "description" : "Local repository for in-house snapshots", "url" : "http://localhost:8080/artifactory/libs-snapshots-local" } ]

Repository Configuration

Description: Retrieves the current configuration of a repository.Supported by local, remote and virtual repositories.
Since: 2.3.0
Notes: Requires Artifactory Pro
Security: Requires a valid user for ashared remote repositoryand admin user for anything else. Shared remote repository data is sanitized for security when a non-admin user is used.
Usage: GET /api/repositories/{repoKey}
Produces:application/vnd.org.jfrog.artifactory.repositories.LocalRepositoryConfiguration+json,application/vnd.org.jfrog.artifactory.repositories.RemoteRepositoryConfiguration+json,
application/vnd.org.jfrog.artifactory.repositories.VirtualRepositoryConfiguration+json

Sample Output:

GET /api/repositories/libs-release-local { repository-config.json }

Create or Replace Repository Configuration

Description: Creates a new repository in Artifactory with the provided configuration or replaces the configuration of an existing repository.Supported by local, remote and virtual repositories.
A position may be specified using theposparameter. If the map size is shorter thanposthe repository is the last one (the default behavior).
Since: 2.3.0
Notes: Requires Artifactory Pro
An existing repository with the same key are removed from the configuration and its content is removed!
Missing values are set to the default values as defined by the consumed type spec.
Security: Requires an admin user
Usage: PUT /api/repositories/{repoKey}[?pos=position]
Consumes:application/vnd.org.jfrog.artifactory.repositories.LocalRepositoryConfiguration+json,application/vnd.org.jfrog.artifactory.repositories.RemoteRepositoryConfiguration+json,
application/vnd.org.jfrog.artifactory.repositories.VirtualRepositoryConfiguration+json
Sample Usage:

PUT /api/repositories/libs-release-local?pos=2 { repository-config.json }

Update Repository Configuration

Description: Updates an exiting repository configuration in Artifactory with the provided configuration elements.Supported by local, remote and virtual repositories.
Since: 2.3.0
Notes: Requires Artifactory Pro
The class of a repository (therclassattribute cannot be updated.
Security: Requires an admin user
Usage: POST /api/repositories/{repoKey}
Consumes:application/vnd.org.jfrog.artifactory.repositories.LocalRepositoryConfiguration+json,application/vnd.org.jfrog.artifactory.repositories.RemoteRepositoryConfiguration+json,
application/vnd.org.jfrog.artifactory.repositories.VirtualRepositoryConfiguration+json
Sample Usage:

POST /api/repositories/libs-release-local { repository-config.json }

Delete Repository

Description: Removes a repository configuration together with the whole repository content.Supported by local, remote and virtual repositories.
Since: 2.3.0
Notes: Requires Artifactory Pro
Security: Requires an admin user
Usage: DELETE /api/repositories/{repoKey}
Produces: application/text
Sample Usage:

DELETE /api/repositories/libs-release-local Repository 'libs-release-local' and all its content have been removed successfully.

Remote Repository Configuration

Description: Repository Configuration (Deprecated)
Gets the shared configuration of a remote repository.
Since: 2.2.0
Notes: This API isdeprecated. Use the Get Repository Configuration API instead.
Security: Requires a valid user for a shared remote repository and admin user for anything else. Shared remote repository data will be sanitized for security when non-admin user is used.
Usage: GET /api/repositories/{remoteRepoName}/configuration
Produces: application/vnd.org.jfrog.artifactory.repositories.SharedRemoteRepositoryConfiguration+json
Sample Output:

GET /api/repositories/remote-repo/configuration { repository-config.json }

Calculate YUM Repository Metadata

Description: Calculates/recalculates the YUM metdata for this repository, based on the RPM package currently hosted in the repository.Supported by local repositories only.
Calculation can be synchronous (the default) or asynchronous.
Please see theYUM integrationdocumentation for more details.
Notes: Requires Artifactory Pro. Immediate calculation requests cannot be called on repositories with automatic asynchronous calculations enabled.
Security: Requires a valid admin user
Usage: POST /api/yum/{repoKey}[?async=0/1]
Produces: application/text
Since: 2.3.5
Sample Output:

POST /api/yum/libs-release-local?async=1 YUM metadata calculation for repository 'libs-release-local' accepted.

计算NuGetRepository Metadata

Description: Recalculates all the NuGet packages for this repository (local/cache/virtual), and re-annotate the NuGet properties for each NuGet package according to it's internal nuspec file.
Please see theNuGet integrationdocumentation for more details.
Supported by local, local-cache, remote and virtual repositories.
Notes: Requires Artifactory Pro.
Security: Requires a valid admin user
Usage: POST /api/nuget/{repoKey}/reindex
Produces: application/text
Since: 3.0.3
Sample Output:

POST /api/nuget/nuget-local/reindex NuGet reindex calculation for repository 'nuget-local' accepted.

Calculate Npm Repository Metadata

Description: Recalculates the npm search index for this repository (local/virtual). Please see theNpm integrationdocumentation for more details.Supported by local and virtual repositories.
Notes: Requires Artifactory Pro.
Security: Requires a valid admin user
Usage: POST /api/npm/{repoKey}/reindex
Produces: application/text
Since: 3.2.0
Sample Output:

POST /api/npm/npm-local/reindex Recalculating index for npm repository npm-local scheduled to run

Calculate Maven Index

Description: Calculates/caches a Maven index for the specified repositories.
For a virtual repository specify all underlying repositories that you want the aggregated index to include.
Calculation can be forced, which for remote repositories will cause downloading of a remote index even if a locally cached index has not yet expired; and index recalculation based on the cache on any failure to download the remote index, including communication errors (the default behavior is to only use the cache when a remote index cannot be found and returns a 404). Forcing has no effect on local repositories index calculation.
Please see theExposing Maven Indexesdocumentation for more details.
Notes: Requires Artifactory Pro.
Security: Requires a valid admin user
Usage: POST /api/maven[?repos=x[,y]][&force=0/1]
Produces: application/text
Since: 2.5.0
Sample Output:

POST /api/maven?repos=libs-release-local,ext-release-local&force=1 Maven index refresh for repositories '[libs-release-local, ext-release-local]' has been accepted.

Calculate Maven Metadata

Description: Calculates Maven metadata on the specified path (local repositories only).
Security: Requires a valid user with deploy permissions
Usage: POST /api/maven/calculateMetadata/{repoKey}/{folder-path}
Produces: application/text
Since: 3.0.2
Sample Output:

POST /api/maven/calculateMetadata/libs-release-local/org/acme OK

Calculate Debian Repository Metadata

Description: Calculates/recalculates the Packages and Release metadata for this repository,based on the Debian packages in it.
Calculation can be synchronous (the default) or asynchronous. Please refer toDebian Repositoriesfor more details.Supported by local repositories only.
Notes: Requires Artifactory Pro.
Security: Requires a valid admin user
Usage: POST api/deb/reindex/{repoKey}[?async=0/1]
Headers (Optionally):-H X-GPG-PASSPHRASE:passphrase
Produces: application/text
Since: 3.3
Sample Output:

POST / api / deb /重建索引/ debian-local我重新计算ndex for Debian repository debian-local scheduled to run.

Calculate Vagrant Repository Metadata

Description: Recalculates the Vagrant boxes indices for this repository. Please see theVagrant integrationdocumentation for more details.
Notes: Requires Artifactory Pro.
Security: Requires a valid admin user
Usage: POST /api/vagrant/{repoKey}/reindex
Produces: text/plain
Since: 3.7.1
Sample Output:

POST /api/vagrant/vagrant-local/reindex Recalculating index for Vagrant repository vagrant-local scheduled to run

SYSTEM & CONFIGURATION

System Info

Description: System Info
Get general system information.
Since: 2.2.0
Security: Requires a valid admin user
Usage: GET /api/system
Produces: text/plain
Sample Output:

GET /api/system system info output text

System Health Ping

Description: Get a simple status response about the state of Artifactory
Returns 200 code with an 'OK' text if Artifactory is working properly, if not will return an HTTP error code with a reason.
Since: 2.3.0
Security: Requires a valid user (can be anonymous)
Usage: GET /api/system/ping
Produces: text/plain
Sample Output:

GET /api/system/ping OK

General Configuration

Description: Get the general configuration (artifactory.config.xml).
Since: 2.2.0
Security: Requires a valid admin user
Usage: / api /系统/配置
Produces: application/xml (http://www.jfrog.org/xsd/artifactory-v1_4_5.xsd)
Sample Output:

GET /api/system/configuration 

Save General Configuration

Description: Save the general configuration (artifactory.config.xml).
Since: 2.2.0
Notes: This is an advanced feature - make sure the new configuration is really what you wanted before saving.
Security: Requires a valid admin user
Usage: POST /api/system/configuration
Consumes: application/xml (http://www.jfrog.org/xsd/artifactory-v1_4_5.xsd)
Sample Usage:

POST /api/system/configuration 

License Information

Description: Retrieve information about the currently installed license.
Since: 3.3.0
Security: Requires a valid admin user
Usage: GET /api/system/license
Produces:application/json
Sample Output:

GET /api/system/license { "type" : "Commercial", "validThrough" : "May 15, 2014", "licensedTo" : "JFrog inc." }

Install License

Description: Install new license key or change the current one.
Since: 3.3.0
Security: Requires a valid admin user
Usage: POST /api/system/license
Produces:application/json
Consumes:application/json({ "licenseKey": "your supplied license key ..." } )
Sample Output:

POST /api/system/license { "status" : 200, "message" : "The license has been successfully installed." }

Version and Add-ons information

Description: Retrieve information about the current Artifactory version, revision, and currently installed Add-ons
Since: 2.2.2
Security: Requires a valid user (can be anonymous)
Usage: GET /api/system/version
Produces:application/vnd.org.jfrog.artifactory.system.Version+json
Sample Output:

GET /api/system/version { "version" : "2.2.2", "revision" : "10427", "addons" : [ "build", "ldap", "properties", "rest", "search", "sso", "watch", "webstart" ] }

PLUGINS

Execute Plugin Code

Description: Executes a named execution closure found in theexecutionssection of auser plugin.
Execution can take parameters and be synchronous (the default) or asynchronous.
Since: 2.3.1
Notes: Requires Artifactory Pro
Security: Requires an authenticated user (the plugin can control which users/groups are allowed to trigger it)
Usage:发布/ api /插件s/execute/{executionName}?[params=p1=v1[,v2][|p2=v3][&async=1]]
Produces: text/plain
Sample Output:

POST /api/plugins/execute/cleanup?params=suffix=SNAPSHOT|types=jar,war,zip&async=1 OK

Retrieve All Available Plugin Info

Description: Retrieves all availableuser plugininformation (subject to the permissions of the provided credentials).
Since: 2.5.2
Notes: Requires Artifactory Pro
Security: Requires an authenticated user.
Usage: GET /api/plugins
Produces: application/json
Sample Output:

GET /api/plugins { "executions": [ { "name": "execution1", "version": "version", "description": "description", "users": ["user1"], "groups": ["group1", "group2"], "params": {} } ], "staging": [ { "name": "strategy1", "version": "1.0", "description": "desc", "params": {"key1": "val1"} } ] }

Retrieve Plugin Info of a Certain Type

Description: Retrieves all availableuser plugininformation (subject to the permissions of the provided credentials) of the specified type.
Since: 2.5.2
Notes: Requires Artifactory Pro
Security: Requires an authenticated user.
Usage: GET /api/plugins/{pluginType}
Produces: application/json
Sample Output:

GET /api/plugins/staging { "staging": [ { "name": "strategy1", "version": "1.0", "description": "desc", "params": {"key1": "val1"} } ] }

Retrieve Build Staging Strategy

Description: Retrieves a build staging strategy defined by auser plugin.
Since: 2.5.2
Notes: Requires Artifactory Pro
Security: Requires an authenticated user.
Usage: GET /api/plugins/build/staging/{strategyName}?buildName={buildName}&[params=p1=v1[,v2][|p2=v3]]
Produces: application/vnd.org.jfrog.plugins.BuildStagingStrategy
Sample Output:

GET /api/plugins/build/staging/strategy1?buildName=build1?params=types=jar,war,zip { "defaultModuleVersion": { "moduleId": "moduleId", "nextRelease": "nextRelease", "nextDevelopment": "nextDevelopment" }, "vcsConfig": { "useReleaseBranch": true, "releaseBranchName": "branchName", "createTag": true, "tagUrlOrName": "tagUrl", "tagComment": "comment", "nextDevelopmentVersionComment": "comment" }, "promotionConfig": { "targetRepository": "repoKey", "comment": "comment", "status": "statusName" } }

Execute Build Promotion

Description: Executes a named promotion closure found in thepromotionssection of auser plugin.
Since: 2.5.2
Notes: Requires Artifactory Pro
Security: Requires an authenticated user.
Usage:发布/ api /插件s/build/promote/{promotionName}/{buildName}/{buildNumber}?[params=p1=v1[,v2][|p2=v3]]
Produces: text/plain
Sample Output:

POST /api/plugins/build/promote/promotion1/build1/3?params=types=jar,war,zip OK

Reload Plugins

Description: Reloads user plugins if there are modifications since the last user plugins reload. Works regardless of the automatic user plugins refresh interval.
Since: 2.9.0
Notes: Requires Artifactory Pro
Security: Requires a valid admin user
Usage:发布/ api /插件s/reload
Produces: text/plain
Sample Output:

POST /api/plugins/reload Successfully loaded: myplugin1.groovy, myplugin2.groovy

IMPORT & EXPORT

Import Repository Content

Description: Import one or more repositories.
Since: 2.2.2
Security: Requires a valid admin user
Usage: POST: /api/import/repositories
Requests Params:
path - The base path to import from (may contain a single repo or multiple repos with named sub folders)
repo - Empty/null repo -> all
metadata - Include metadata - default 1
verbose - Verbose - default 0
Produces: text/plain
Sample Output:

POST: /api/import/repositories?path=pathToRepos&verbose=1

Import System Settings Example

Description: Returned default Import Settings JSON.
Since: 2.4.0
Security: Requires a valid admin user
Usage: GET: /api/import/system
Produces:application/vnd.org.jfrog.artifactory.system.ImportSettings+json
Sample Usage:

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

Full System Import

Description: Import full system from a server local Artifactory export directory.
Since: 2.4.0
Security: Requires a valid admin user
Usage: POST: /api/import/system
Consumes:application/vnd.org.jfrog.artifactory.system.ImportSettings+json
Produces: text/plain
Sample Usage:

POST /api/import/system { import-settings.json }

Export System Settings Example

Description: Returned default Export Settings JSON.
Since: 2.4.0
Security: Requires a valid admin user
Usage: GET: /api/export/system
Produces:application/vnd.org.jfrog.artifactory.system.ExportSettings+json
Sample Usage:

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

Export System

Description: Export full system to a server local directory.
Since: 2.4.0
Security: Requires a valid admin user
Usage: POST: /api/export/system
Consumes:application/vnd.org.jfrog.artifactory.system.ExportSettings+json, application/json
Produces: text/plain
Sample Usage:

POST /api/export/system{ export-settings.json }

ERROR RESPONSES

In case of an error, Artifactory will return an error response in JSON format. The response contains the HTTP status code and error message.

For example, a badly formatted API call would return the "404, File not found" response below:

{ "errors" : [ { "status" : 404, "message" : "File not found." } ] }