Retrieves the list of farm nodes in this cluster
This request has no parameters.
The list of farm nodes
array<RestClusterNode>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/farmNodes' \
--header 'Accept: application/json;charset=UTF-8'
Retrieves a list of repositories which have not synced on one or more mirror nodes for at least the threshold time limit after the content was changed in the corresponding upstream repositories. The threshold time limit is defined by a configuration property plugin.mirroring.repository.diagnostics.sync.tolerance
. The detection of out of sync repositories is dependent on the timing of a scheduled job which is controlled by a configuration property plugin.mirroring.synchronization.interval
which means in worst case it can take upto plugin.mirroring.repository.diagnostics.sync.tolerance
+ plugin.mirroring.synchronization.interval
time to detect an out-of-sync repository.
Note: If plugin.mirroring.repository.diagnostics.sync.enabled=false
is set on any of the mirror farm nodes, results will not be reported from that node.
string
string
The upstream ID, project key and repository slug of the delayed sync repositories
array<RestDelayedSyncRepository>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/mirrorRepos/delayed-sync' \
--header 'Accept: application/json;charset=UTF-8'
Retrieves all available clone urls for the specified repository.
string
RequiredThe mirrored repository's information.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/mirrorRepos/{externalRepositoryId}' \
--header 'Accept: application/json;charset=UTF-8'
Retrieves synchronization progress state.If there's no progress to report, this resource will return
If there are repositories in the process of synchronizing, but the precise number hasn't been discovered yet, this resource will return:1
{"discovering":false,"syncedRepos":0,"totalRepos":0}
If there is progress to report and the total number of repositories is known, this resource will return:1
{"discovering":true,"syncedRepos":3,"totalRepos":100}
1
{"discovering":false,"syncedRepos":242,"totalRepos":1071}
This request has no parameters.
the synchronization progress state
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/progress' \
--header 'Accept: application/json;charset=UTF-8'
Retrieves the information about the process owning the sync lock for this repository. The process owning the lock could be running on any of the nodes in the mirror farm
string
Requiredstring
RequiredThe information about the repository lock owner for the syncing process, if the lock is currently being held, otherwise an empty response
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/supportInfo/projects/{projectKey}/repos/{repositorySlug}/repo-lock-owner' \
--header 'Accept: application/json;charset=UTF-8'
Retrieves information about an external repository mirrored by the mirror server. Particularly the local ID & external ID of the repository
string
Requiredstring
RequiredThe sync status of the repository on this node
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/supportInfo/projects/{projectKey}/repos/{repositorySlug}/repoSyncStatus' \
--header 'Accept: application/json;charset=UTF-8'
Retrieves a list of up to plugin.mirroring.farm.max.ref.change.queue.dump.size
items currently in the ref changes queue. The ref changes queue is an internal component of every mirror farm, and is shared between all nodes. When the contents of an upstream repository changes, an item is added to this queue so that the mirror farm nodes know to synchronize. The mirror farm constantly polls and removes items from this queue for processing, so it is empty most of the time.
This request has no parameters.
The contents of the ref changes queue
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/supportInfo/refChangesQueue' \
--header 'Accept: application/json;charset=UTF-8'
Retrieves the total number of items currently in the ref changes queue
This request has no parameters.
The total number of items currently in the ref changes queue
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/supportInfo/refChangesQueue/count' \
--header 'Accept: application/json;charset=UTF-8'
Retrieves the information about all the processes from the all the nodes in the mirror farm owning sync lock for any repository
This request has no parameters.
A list of all the repository lock owners for the syncing process
array<RestRepositoryLockOwner>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/supportInfo/repo-lock-owners' \
--header 'Accept: application/json;charset=UTF-8'
Retrieves a page of sync statuses of the repositories on this mirror node
number
number
The sync status of the repositories on this node
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/supportInfo/repoSyncStatus' \
--header 'Accept: application/json;charset=UTF-8'
Retrieves upstream settings
This request has no parameters.
the mirror settings
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/syncSettings' \
--header 'Accept: application/json;charset=UTF-8'
Sets the settings for the specified upstream
the mirror settings to update to
string
array<string>
the updated mirror settings
1
2
3
4
5
6
7
8
9
10
curl --request PUT \
--url 'http://{baseurl}/rest/mirroring/latest/syncSettings' \
--header 'Accept: application/json;charset=UTF-8' \
--header 'Content-Type: application/json' \
--data '{
"mode": "ALL_PROJECTS",
"projectIds": [
"<string>"
]
}'
Gets the current mirror mode
This request has no parameters.
the current mirror mode
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/syncSettings/mode' \
--header 'Accept: application/json;charset=UTF-8'
Sets the mirror mode for the specified upstream
string
the mode to set
any
1
2
3
4
5
curl --request PUT \
--url 'http://{baseurl}/rest/mirroring/latest/syncSettings/mode' \
--header 'Accept: application/json;charset=UTF-8' \
--header 'Content-Type: application/json' \
--data '"<string>"'
Returns the IDs of the projects that the mirror is configured to mirror
This request has no parameters.
the currently mirrored project IDs
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/syncSettings/projects' \
--header 'Accept: application/json;charset=UTF-8'
Configures the mirror to mirror the provided projects
array<string>
the currently mirrored project IDs
any
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/mirroring/latest/syncSettings/projects' \
--header 'Accept: application/json;charset=UTF-8' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'
Configures the mirror to mirror the provided project
string
Requiredthe currently mirrored project IDs
any
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/mirroring/latest/syncSettings/projects/{projectId}' \
--header 'Accept: application/json;charset=UTF-8'
Configures the mirror to no longer mirror the provided project
string
Requiredthe request has been processed
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/mirroring/latest/syncSettings/projects/{projectId}'
Retrieves upstream server details.
This request has no parameters.
The upstream server.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/upstreamServer' \
--header 'Accept: application/json;charset=UTF-8'
Finalizes the ZDU upgrade on the mirror farm denying heterogeneous cluster formation
This request has no parameters.
The state of the rolling upgrade which includes the current version on all the nodes in the farm.
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/mirroring/latest/zdu/end' \
--header 'Accept: application/json;charset=UTF-8'
Enables upgrading of individual nodes within the cluster, allowing a heterogeneous cluster formation
This request has no parameters.
The state of the rolling upgrade which includes the minimum version of all the nodes in the farm.
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/mirroring/latest/zdu/start' \
--header 'Accept: application/json;charset=UTF-8'
Rate this page: