Get Federation Sync State

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Returns the synchronization state of all Federated repositories in the JPD.

Security: Requires Admin permissions

UsageGET /artifactory/api/federation/state

Query Parameters (optional): {none}

Request Body: {none}

Sample Response:

[
    {
        "localRepoKey" :  "generic-fed-a" ,
        "status" :  "OUT_OF_SYNC"
        "members" : [
          {
            "remoteUrl" :  "http://docker.for.mac.localhost:10104/artifactory/" ,
            "remoteRepoKey" :  "generic-fed-a" ,
          },
          {
            "remoteUrl" :  "http://docker.for.mac.localhost:10105/artifactory/" ,
            "remoteRepoKey" :  "generic-fed-a" ,
          }
        ]  
    } , 
    {
        "localRepoKey" :  "generic-fed-b" ,
        "status" :  "DISABLED"
        "members" : []  
    } ,
    {
        "localRepoKey" :  "generic-fed-c" ,
        "status" :  "FULL_SYNC_RUNNING"
        "members" : [
          {
            "remoteUrl" :  "http://docker.for.mac.localhost:10104/artifactory/" ,
            "remoteRepoKey" :  "generic-fed-c" ,
          },
        ]
    } ,
]

The response includes the following information:

Property

Description

localRepoKey

The unique key of the local repository.

status

The current synchronization status:

  • FULL_SYNC_RUNNING: A full sync operation is running in the background.

  • SYNCING: The mirrors are in syncing mode.

  • OUT_OF_SYNC: The mirrors are out of sync.

  • DISABLED: The mirror is currently disabled.

members

Includes the following properties:

  • remoteUrl: The URL of the remote repository.

  • remoteRepoKey: The unique key of the remote repository.

Status Codes:

Code

Description

200

Success

401

Bad Credentials

403

Permission Denied