Get Federated Repository Status (v2)

JFrog REST APIs

Products

JFrog Xray

Content Type

REST API

ft:sourceType

Paligo

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

Note

This is the v2 version of the endpoint, which was released to offer a wider range of possible member statuses, as described below. The original version is still available for purposes of backward compatibility.

Warning

This API greatly impacts the database and should be used with care.

Since: 7.82.2 (Cloud)

Security: Requires an admin user.

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

Sample Request:

https://federationtest2.jfrogdev.org/artifactory/api/v2/federation/status/repo/fed-generic

Sample Response:

{
 "localKey" : "fed-generic",
 "binariesTasksInfo" : {
  "inProgressTasks" : 0,
  "failingTasks" : 0
 },
 "mirrorEventsStatusInfo" : [ {
  "remoteUrl" : "https://federationtest4.jfrogdev.org/artifactory/",
  "remoteRepoKey" : "fed-generic",
  "status" : "HEALTHY",
  "createEvents" : 0,
  "updateEvents" : 0,
  "deleteEvents" : 0,
  "propsEvents" : 0,
  "errorEvents" : 0,
  "lagInMS" : 0,
  "eventRegistrationTimeStamp" : 0
 }, {
  "remoteUrl" : "https://federationtest7.jfrogdev.org/artifactory/",
  "remoteRepoKey" : "fed-generic",
  "status" : "HEALTHY",
  "createEvents" : 0,
  "updateEvents" : 0,
  "deleteEvents" : 0,
  "propsEvents" : 0,
  "errorEvents" : 0,
  "lagInMS" : 0,
  "eventRegistrationTimeStamp" : 0
 } ],
 "federatedArtifactStatus" : {
  "countFullyReplicateArtifacts" : 0,
  "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: HEALTHY: Metadata events are synchronizing in a timely manner. PENDING_FS: The member is waiting for a Full Sync operation to be performed. FS_RUNNING: A Full Sync operation is currently running. OUT_OF_SYNC: The member is out of sync. EXHAUSTED: The member's event queue has exceeded the maximum number of attempts to send metadata events to other Federation member. See Federation Recovery. DISABLED: The member has been disabled and cannot synchronize metadata events with the rest of the Federation.
`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.