Federation Recovery

JFrog REST APIs

Content Type
REST API
ft:sourceType
Paligo

Description: Activates the recovery mechanism on the Federation or the specified Federated repository. The recovery mechanism clears errors in exhausted queues so that additional attempts can be made to send events to all remote Federation members.

Note

This API can be used even when the auto-healing mechanism is disabled. For more information about performing recovery automatically using the auto-healing feature, see Federation Recovery and Auto-Healing.Federation Recovery and Auto-Healing

Since: 7.71.1

Security: Requires admin permissions.

Usage:

  • Before 7.109.2: POST  /artifactory/api/federation/recovery/{repoKey}

  • 7.109.2 and later: POST  /artifactory/api/federation/recovery?repoKey={repo-key}

Parameters:

Field

Type

Description

repoKey

string

The name of the Federated repository on which to perform recovery. If this property is not defined, recovery is performed on all Federated repositories.

Sample Request (before 7.109.2):

curl -XPOST 'http://localhost:8082/artifactory/api/federation/recovery/generic-fed'

Sample Request (7.109.2 and later):

curl -XPOST 'http://localhost:8082/artifactory/api/federation/recovery?repoKey=generic-fed'

Sample Response:

Recovery triggered successfully

Status Codes: 200 (OK)