Scheduled Replication Status

JFrog REST APIs

Content Type
REST API
ft:sourceType
Paligo

Description: Returns the status of scheduled cron-based replication jobs defined in Artifactory. Supported by local, local-cached, and remote repositories. The status is returned on two levels, per replication job and per repository containing the replication jobs, as explained below.

Notes: Requires Artifactory Pro

Security: Requires a user with 'read' permission (can be anonymous)

Since: 2.4.2

Usage: GET /api/replication/{repoKey}

Produces: application/json (application/vnd.org.jfrog.artifactory.replication.ReplicationStatus+json)

GET /api/replication/remote-libs
{
        "status": {status},
        "lastCompleted": {time}, 
        "targets":
        [
                { "url" : targetUrl, "repoKey": {repoKy}, "status" : {status}, "lastCompleted" : {time} },
                ... 
                { "url" : targetUrl, "repoKey": {repoKy}, "status" : {status}, "lastCompleted" : {time}}
        ],
        "repositories":
        {
                {repoKy} : { "status" : {status}, "lastCompleted" : {time} },
                ... 
                {repoKy} : { "status" : {status}, "lastCompleted" : {time} }
        }
}

where:
{status}= never_run|incomplete(running or interrupted)|error|warn|ok|inconsistent
{time}= time in ISO8601 format (yyyy-MM-dd'T'HH:mm:ss.SSSZ), or null if never completed

Sample Usage:

GET /api/replication/remote-libs
{
        "status" : "ok",
        "lastCompleted" : 2015-12-27T15:08:49.050+02:00",
        "targets":
        [
                { "url": "http://remote_host/remote-libs1", "repoKey": "remote-libs1", "status" : {status}, "lastCompleted" : "2015-12-27T15:07:49.050+02:00" },
                ... 
                { "url" : "http://remote_host/remote-libs2", "repoKey": "remote-libs2", "status" : {status}, "lastCompleted" : "2015-12-27T15:07:49.050+02:00" }
        ],
        "repositories":
                { 
                        "remote-libs1" : { "status" : "ok", "lastCompleted" : "2015-12-27T15:07:49.050+02:00" },
                        ... 
                        "remote-libs2" : { "status" : "ok", "lastCompleted" : "2015-12-27T15:07:49.050+02:00" }
                }
}

Return Values for status

The status parameter will have one of the following return values:

Value

Description

The following status return values can be returned for a single replication job:

never_run

The replication never ran.

incomplete

The replication ran but never finished.

inconsistent

The replication has not no start-time but does have an end-time.

The following status return values can be returned for a single replication job and also for the repository cointaining the replication jobs:

partial_failure

Some replications completed with errors.

warn

Replications completed with warnings.

error

Replications completed with errors.

ok

All replications completed successfully.