Get Federated Repository Status

JFrog REST APIs

ft:sourceType
Paligo

Description: Returns the synchronization status of the Federation for a specific repository.

This API has a high impact on the database and should be used with care.

Since: 7.49.3

Security: Requires an admin user.

Usage: GET api/federation/status/repo/<REPO_NAME >

Sample Request:

GET api/federation/status/repo/<example-repo-local>

Sample Response:

{
    "localKey": "generic-repo-federated0",
    "binariesTasksInfo": {
        "inProgressTasks": 0,
        "failingTasks": 0
    },
    "mirrorEventsStatusInfo": [
        {
            "remoteUrl": "https://fedrepo1241node2master.jfrogdev.org/artifactory/",
            "remoteRepoKey": "generic-repo-federated0",
            "status": "SYNC",
            "createEvents": 9463,
            "updateEvents": 0,
            "deleteEvents": 0,
            "propsEvents": 0,
            "errorEvents": 0,
            "lagInMS": 46628,
            "eventRegistrationTimeStamp": 1676559878115
        }
    ],
    "federatedArtifactStatus": {
        "countFullyReplicateArtifacts": 987329,
        "countArtificiallyReplicatedArtifacts": 0
    }
}

The response displays the following information:

Property

Description

localRepoKey

The name of the local repository.

binariesTasksInfo

Includes the properties listed below:

inProgressTasks

Total number of tasks in the binaries tasks table waiting to download artifacts (currently only metadata is stored in the local JFrog Platform Deployment).

failingTasks

Total number of tasks that failed to download from the member during the download.

mirrorEventsStatusInfo

Includes the properties listed below:

remoteUrl

URL of one of the Federated members (mirrors).

remoteRepoKey

Repository name of the Federated member.

status

The current synchronization status of the Federated member:

  • SYNC

  • OUT_OF_SYNC

createEvents

The number of Create events waiting to be sent to the target member.

updateEvents

The number of Update events waiting to be sent to the target member.

deleteEvents

The number of Delete events waiting to be sent to the target member.

propsEvents

The number of node properties waiting to be sent to the target member.

errorEvents

The number of failed events during the sync process.

lagInMS

The amount of time the event waits to be processed (in milliseconds). The calculation is current time/query time (eventRegistrationTimeStamp).

eventRegistrationTimeStamp

The time when the event was created.

federatedArtifactStatus

Includes the properties listed below:

countFullyReplicateArtifacts

The number of artifacts that fully exist (binary data & metadata) in the JFrog Platform Deployment [JPD].

countArtificiallyReplicatedArtifacts

The number of artificial artifacts (metadata only) in the JPD. The full binary file does not yet exist. If the user tries to download the artifact, the search will proceed on one of the other members.