Get Federation Connection Details

JFrog REST APIs

Content Type
REST API
ft:sourceType
Paligo

Description: Returns the connection status of a Federated repository with other members of its Federation. This status indicates whether metadata events are being synchronized promptly between each source and each target within the Federation.

Tip

The connection status between Federation members can also be viewed in the Federation dashboard. For more information, see View the Status of a Selected Repository Federation.Monitor Federated Repositories using the DashboardView the Status of a Selected Repository Federation

Since: 7.104.2

Important

This API replaces the following APIs that were used by the legacy Federation service in Artifactory:

Security: Requires admin permissions

Usage: GET /artifactory/api/federation/status/connectionStates/<repo-name>

Sample Query:

curl -u "admin:password" -X GET https://[ARTIFACTORY_URL]/artifactory/api/federation/status/connectionStates/<repo-name>

Sample Response:

{
  "memberConnections" : [ {
    "localRepoKey" : "priority_test_repo_1",
    "localPlatformUrl" : "https://my-ci-green.jfrog.io/artifactory",
    "remoteRepoKey" : "repo_1_high",
    "remotePlatformUrl" : "https://my-ci-blue.jfrog.io/artifactory",
    "status" : "HEALTHY",
    "lagInMs" : 0,
    "queuedEvents" : 0,
    "disabled" : false,
    "supported" : true
  }, {
    "localRepoKey" : "repo_1_high",
    "localPlatformUrl" : "https://my-ci-blue.jfrog.io/artifactory",
    "remoteRepoKey" : "priority_test_repo_1",
    "remotePlatformUrl" : "https://my-ci-green.jfrog.io/artifactory",
    "status" : "N/A",
    "lagInMs" : 0,
    "queuedEvents" : 0,
    "disabled" : false,
    "supported" : false
  } ]
}

The response includes the following information:

Property

Type

Description

localRepoKey

string

The repository key of the Federated repository on the local JPD that serves as the source of the connection.

localPlatformUrl

string

The URL of the Federated repository on the local JPD.

remoteRepoKey

string

The repository key of the Federated repository on the remote JPD that serves as the target of the connection.

remotePlatformUrl

string

The URL of the Federated repository on the remote JPD.

status

string

The status of the connection between the source and target members. For more information about statuses (or states), see Get Federation State Summaries.

lagInMs

integer

The current lag (in milliseconds) in synchronizing events between the source and target members.

queuedEvents

integer

The number of metadata events remaining in the queue to be sent to the target member. (Binaries are not included in this count, only the metadata.)

disabled

boolean

Whether the Federation member has been disabled by an administrator.

supported

boolean

Whether the Federation member is running a version of Artifactory that supports the standalone Federation service (of which this REST API is a part).

Note

If supported is true, but the status is N/A, this indicates that the remote member cannot be reached (possibly due to a network issue).

Status Codes:

Code

Description

200

OK

401

Bad Credentials

403

Permission Denied