Get Federation State Summaries

JFrog REST APIs

Content Type
REST API
ft:sourceType
Paligo

Description: Returns the number of Federation members that are currently in each of the following states: HEALTHY, NOT_AVAILABLE, DELAYED, PENDING_FS, FULL_SYNC_RUNNING, ERROR, DISABLED

The state of each member is based on an aggregation of all connections that are federated with the JPD on which this endpoint is run. The aggregation is based on the most severe state. In the example shown below, metadata events sent from the Federated repository gen-fed-fr are synchronizing in a timely fashion with gen-fed-au. Therefore, that connection is HEALTHY. However, there is a delay in sending events from gen-fed-fr to gen-fed-us. Therefore, the aggregated status of gen-fed-fr is DELAYED.

Federation_Repo_State_Summary_diagram_cropped.png

Tip

All these states (except ERROR and DISABLED) can also be viewed in the Federation dashboard. For more information, see View the Status of All Repository Federations.Monitor Federated Repositories using the DashboardView the Status of All Repository Federations

Since: 7.104.2

Important

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

Security: Requires admin permissions

Usage: GET /artifactory/api/federation/status/stateSummary

Sample Query:

curl -u "admin:password" -X GET https://[ARTIFACTORY_URL]/artifactory/api/federation/status/stateSummary

Sample Response:

{
  "federationStates" : {
    "HEALTHY" : 6,
    "NOT_AVAILABLE" : 1,
    "DELAYED" : 2,
    "PENDING_FS" : 1,
    "FULL_SYNC_RUNNING" : 1,
    "ERROR" : 0,
    "DISABLED" : 0
  }
}

The response includes the following information:

State

Description

HEALTHY

The number of Federations where all members are experiencing timely synchronization of metadata events. 

NOT_AVAILABLE

The number of Federations where at least one member cannot be reached or is running a version of Artifactory that does not support the standalone Federation service (which includes this REST API).

DELAYED

The number of Federations where at least one member is experiencing latency that exceeds the defined thresholds (defined in system properties). This means that synchronization of metadata events is taking longer than expected.

PENDING_FS

The number of Federations where at least one member is waiting for a Full Sync to be performed. A Full Sync is performed during the initialization process when a Federation is created, and as a way to restore synchronization when regular synchronization and auto-healing are insufficient (for example, if there are purged events that are no longer available to be synchronized)

FULL_SYNC_RUNNING

The number of Federations where at least one member is currently undergoing the Full Sync procedure.

ERROR

The number of Federations where there are failures sending metadata events between members. The Federation service has an auto-healing mechanism to help the Federation recover from these types of errors.Federation Recovery and Auto-Healing

DISABLED

The number of Federations where at least one member has been disabled by an administrator.

Status Codes:

Code

Description

200

OK

401

Bad Credentials

403

Permission Denied