Description: Returns the current state of each repository Federation configured on your JPD.
Tip
The Federation state details can also be viewed in the Federation dashboard. For more information, see View the Status of All Repository Federations.
Since: 7.104.2
Important
This API replaces the following APIs that were used by the legacy Federation service in Artifactory:
GET api/federation/status/mirrorsLag
(see Get Federation Mirror Lag Time)GET api/federation/status/unavailableMirrors
(see Get Unavailable Mirrors)
Security: Requires admin permissions
Usage: GET /artifactory/api/federation/status/stateList
Sample Query:
curl -u "admin:password" -X GET https://[ARTIFACTORY_URL]/artifactory/api/federation/status/stateList
Sample Response:
{ "federations" : [ { "localRepoKey" : "rtfs-dev-master-maven-local-2", "memberInfoList" : [ { "url" : "https://my-ci-blue.jfrog.io/artifactory", "repoKey" : "rtfs-dev-master-maven-local-2", "aggregatedStatus" : "HEALTHY", "supported" : true, "disabled" : false, "inLag" : false }, { "url" : "https://my-ci-green.jfrog.io/artifactory", "repoKey" : "rtfs-dev-master-maven-local-2", "aggregatedStatus" : "N/A", "supported" : false, "disabled" : false, "inLag" : false } ], "priority" : "HIGH" }, { "localRepoKey" : "artifactory-federation-1", "memberInfoList" : [ { "url" : "https://my-ci-blue.jfrog.io/artifactory", "repoKey" : "artifactory-federation-1", "aggregatedStatus" : "DELAYED", "supported" : true, "disabled" : false, "inLag" : true }, { "url" : "https://my-ci-green.jfrog.io/artifactory", "repoKey" : "artifactory-federation-1", "aggregatedStatus" : "PENDING_FS", "supported" : true, "disabled" : false, "inLag" : true } ], "priority" : "STANDARD" }, { "localRepoKey" : "rtfs-dev-master-docker-local-1", "memberInfoList" : [ { "url" : "https://my-ci-blue.jfrog.io/artifactory", "repoKey" : "rtfs-dev-master-docker-local-1", "aggregatedStatus" : "ERROR", "supported" : true, "disabled" : false, "inLag" : true }, { "url" : "https://my-ci-green.jfrog.io/artifactory", "repoKey" : "rtfs-dev-master-docker-local-1", "aggregatedStatus" : "DISABLED", "supported" : false, "disabled" : true, "inLag" : false } ], "priority" : "STANDARD" } ] }
The response includes the following information:
Property | Type | Description |
---|---|---|
| string | The repository key of the local member of the Federation on this JPD. |
| string | Contains information about the other members of the repository Federation, as described below. |
| string | The URL of the Federation member. |
| string | The repository key of the Federation member. |
| string | The aggregated status of the Federation member, which is based on the most severe status of its connections with other Federation members. For more information about statuses (or states), see Get Federation State Summaries. |
| 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). |
| boolean | Whether the Federation member has been disabled by an administrator. |
| boolean | Whether the Federation member is currently experiencing delays in sending metadata events to other members. |
| string | Whether this repository Federation has been given priority access to system resources. For more information, see Prioritize Federated Repository. Possible values are |
Status Codes:
Code | Description |
---|---|
200 | OK |
401 | Bad Credentials |
403 | Permission Denied |