REST API Reference Index
Browse the categorized index of Federation REST APIs for repository management and monitoring.
This page lists all REST APIs related to Federated repositories.
Repository Management APIs
Use the following APIs to manage Federated repositories.
| API | Description |
|---|---|
| Get Repositories by Type and Project | List repositories filtered by type and project |
| Create Repository | Create a new repository, including Federated type |
| Update Repository Configuration | Update an existing repository configuration |
| Delete Repository | Delete a repository |
| Convert Local Repository to a Federated Repository | Convert a local repository to Federated |
| Convert Federated Repository to a Local Repository | Convert a Federated repository back to local |
Federation Operations APIs
Use the following APIs to perform Federation operations.
| API | Description |
|---|---|
| Federated Repository Full Sync | Perform a Full Sync operation on Federated repositories |
| Synchronize Federated Member Configuration | Push updated configuration to a target Federation member |
| Federation Recovery | Perform manual Federation recovery |
| Replay Failed Binary Tasks | Reset retry count for failed binary synchronization tasks |
| Update Custom URL Base | Change the custom base URL |
Monitoring APIs: Artifactory Federation Service
Use the following APIs to monitor Federation status with the Artifactory Federation Service. These APIs power the Federation Dashboard.
| API | Description |
|---|---|
| Get Federation Connection Details | View connection details between Federation members |
| Get Federation State Details | View the state of Federation members |
| Get Federation State Summaries | View summary of all Federation states |
| Prioritize Federated Repository | Assign priority to a Federated repository |
| Reconnect to Federation Client | Reconnect to a Federation client |
Monitoring APIs: Legacy Federation Service
Use the following APIs to monitor Federation status with the legacy Federation service. If you're still using this service, consider migrating to RTFS.
| API | Description |
|---|---|
| Get Federated Repository Status | View the status of a Federated repository |
| Get Federated Repository Status (v2) | View the status of a Federated repository (v2) |
| Get Federation Sync State | View the synchronization state of Federation members |
| Get Federation Mirror Lag Time | View the mirror lag time for Federation members |
| Get Unavailable Mirrors | View mirrors that are currently unavailable |
Authentication APIs
Use the following APIs for Federation authentication. See Federation over JFrog Bridge for the pairing workflow these APIs support.
| API | Description |
|---|---|
| Create Pairing Token | Generate a new pairing token for Federation members |
| Initiate Pairing | Pair a target JPD to a source JPD using a token |
| Revoke Token by ID | Revoke an obsolete token |
Configuration JSON
The dedicated Federated repository configuration JSON file is:
application/vnd.org.jfrog.artifactory.repositories.FederatedRepositoryConfiguration+json
For example, to create or update a Federated repository configuration using the Update Repository Configuration API:
curl -X PUT "https://<SERVER_URL>/artifactory/api/repositories/<REPOSITORY_KEY>" \
-H "Content-Type: application/vnd.org.jfrog.artifactory.repositories.FederatedRepositoryConfiguration+json" \
-u <USERNAME>:<ACCESS_TOKEN> \
-d @federated-repo-config.jsonWhere:
<SERVER_URL>: Your JFrog Platform server URL.<REPOSITORY_KEY>: The key of the Federated repository to create or update.<USERNAME>: Your JFrog Platform username.<ACCESS_TOKEN>: A valid JFrog access token.
For example:
curl -X PUT "https://mycompany.jfrog.io/artifactory/api/repositories/libs-release-federated" \
-H "Content-Type: application/vnd.org.jfrog.artifactory.repositories.FederatedRepositoryConfiguration+json" \
-u admin:<ACCESS_TOKEN> \
-d @federated-repo-config.jsonNote
When working inside a specific project, the Federated repositories that comprise the Federation must all share the same project key.
Related Topics
Updated about 7 hours ago