GET

Get farm nodes

Retrieves the list of farm nodes in this cluster

Request

This request has no parameters.

Responses

The list of farm nodes

application/json;charset=UTF-8

array<RestClusterNode>

GET/mirroring/latest/farmNodes
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/farmNodes' \ --header 'Accept: application/json;charset=UTF-8'
GET

Get delayed sync repositories

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.

Request

Query parameters

delayThreshold

string

limit

string

Responses

The upstream ID, project key and repository slug of the delayed sync repositories

application/json;charset=UTF-8

array<RestDelayedSyncRepository>

GET/mirroring/latest/mirrorRepos/delayed-sync
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/mirrorRepos/delayed-sync' \ --header 'Accept: application/json;charset=UTF-8'
GET

Get clone URLs

Retrieves all available clone urls for the specified repository.

Request

Path parameters

externalRepositoryId

string

Required

Responses

The mirrored repository's information.

application/json;charset=UTF-8

RestMirroredRepository
GET/mirroring/latest/mirrorRepos/{externalRepositoryId}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/mirrorRepos/{externalRepositoryId}' \ --header 'Accept: application/json;charset=UTF-8'
GET

Get synchronization progress state

Retrieves synchronization progress state.If there's no progress to report, this resource will return

1 {"discovering":false,"syncedRepos":0,"totalRepos":0}
If there are repositories in the process of synchronizing, but the precise number hasn't been discovered yet, this resource will return:
1 {"discovering":true,"syncedRepos":3,"totalRepos":100}
If there is progress to report and the total number of repositories is known, this resource will return:
 
1 {"discovering":false,"syncedRepos":242,"totalRepos":1071}

Request

This request has no parameters.

Responses

the synchronization progress state

application/json;charset=UTF-8

RestSyncProgress
GET/mirroring/latest/progress
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/progress' \ --header 'Accept: application/json;charset=UTF-8'
GET

Get the repository lock owner for the syncing process

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

Request

Path parameters

projectKey

string

Required
repositorySlug

string

Required

Responses

The information about the repository lock owner for the syncing process, if the lock is currently being held, otherwise an empty response

application/json;charset=UTF-8

RestRepositoryLockOwner
GET/mirroring/latest/supportInfo/projects/{projectKey}/repos/{repositorySlug}/repo-lock-owner
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'
GET

Gets information about the mirrored repository

Retrieves information about an external repository mirrored by the mirror server. Particularly the local ID & external ID of the repository

Request

Path parameters

projectKey

string

Required
repositorySlug

string

Required

Responses

The sync status of the repository on this node

application/json;charset=UTF-8

RestMirrorRepositorySynchronizationStatus
GET/mirroring/latest/supportInfo/projects/{projectKey}/repos/{repositorySlug}/repoSyncStatus
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'
GET

Get items in ref changes queue

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.

Request

This request has no parameters.

Responses

The contents of the ref changes queue

application/json;charset=UTF-8

RestRefSyncQueue
GET/mirroring/latest/supportInfo/refChangesQueue
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/supportInfo/refChangesQueue' \ --header 'Accept: application/json;charset=UTF-8'
GET

Get total number of items in ref changes queue

Retrieves the total number of items currently in the ref changes queue

Request

This request has no parameters.

Responses

The total number of items currently in the ref changes queue

application/json;charset=UTF-8

any

GET/mirroring/latest/supportInfo/refChangesQueue/count
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/supportInfo/refChangesQueue/count' \ --header 'Accept: application/json;charset=UTF-8'
GET

Get all the repository lock owners for the syncing process

Retrieves the information about all the processes from the all the nodes in the mirror farm owning sync lock for any repository

Request

This request has no parameters.

Responses

A list of all the repository lock owners for the syncing process

application/json;charset=UTF-8

array<RestRepositoryLockOwner>

GET/mirroring/latest/supportInfo/repo-lock-owners
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/supportInfo/repo-lock-owners' \ --header 'Accept: application/json;charset=UTF-8'
GET

Get sync status of repositories

Retrieves a page of sync statuses of the repositories on this mirror node

Request

Query parameters

start

number

limit

number

Responses

The sync status of the repositories on this node

application/json;charset=UTF-8

object
GET/mirroring/latest/supportInfo/repoSyncStatus
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/supportInfo/repoSyncStatus' \ --header 'Accept: application/json;charset=UTF-8'
GET

Get upstream settings

Retrieves upstream settings

Request

This request has no parameters.

Responses

the mirror settings

application/json;charset=UTF-8

RestUpstreamSettings
GET/mirroring/latest/syncSettings
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/syncSettings' \ --header 'Accept: application/json;charset=UTF-8'
PUT

Update upstream settings

Sets the settings for the specified upstream

Request

Request bodyapplication/json

the mirror settings to update to

mode

string

projectIds

array<string>

Responses

the updated mirror settings

application/json;charset=UTF-8

RestUpstreamSettings
PUT/mirroring/latest/syncSettings
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>" ] }'
GET

Get mirror mode

Gets the current mirror mode

Request

This request has no parameters.

Responses

the current mirror mode

application/json;charset=UTF-8

any

GET/mirroring/latest/syncSettings/mode
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/syncSettings/mode' \ --header 'Accept: application/json;charset=UTF-8'
PUT

Update mirror mode

Sets the mirror mode for the specified upstream

Request

Request bodyapplication/json

string

Responses

the mode to set

application/json;charset=UTF-8

any

PUT/mirroring/latest/syncSettings/mode
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>"'
GET

Get mirrored project IDs

Returns the IDs of the projects that the mirror is configured to mirror

Request

This request has no parameters.

Responses

the currently mirrored project IDs

application/json;charset=UTF-8

any

GET/mirroring/latest/syncSettings/projects
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/syncSettings/projects' \ --header 'Accept: application/json;charset=UTF-8'
POST

Add multiple projects to be mirrored

Configures the mirror to mirror the provided projects

Request

Request bodyapplication/json

array<string>

Responses

the currently mirrored project IDs

application/json;charset=UTF-8

any

POST/mirroring/latest/syncSettings/projects
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>" ]'
POST

Add project to be mirrored

Configures the mirror to mirror the provided project

Request

Path parameters

projectId

string

Required

Responses

the currently mirrored project IDs

application/json;charset=UTF-8

any

POST/mirroring/latest/syncSettings/projects/{projectId}
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/syncSettings/projects/{projectId}' \ --header 'Accept: application/json;charset=UTF-8'
DEL

Stop mirroring project

Configures the mirror to no longer mirror the provided project

Request

Path parameters

projectId

string

Required

Responses

the request has been processed

DEL/mirroring/latest/syncSettings/projects/{projectId}
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/mirroring/latest/syncSettings/projects/{projectId}'
GET

Get upstream server

Retrieves upstream server details.

Request

This request has no parameters.

Responses

The upstream server.

application/json;charset=UTF-8

RestUpstreamServer
GET/mirroring/latest/upstreamServer
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServer' \ --header 'Accept: application/json;charset=UTF-8'
POST

End ZDU upgrade on mirror farm

Finalizes the ZDU upgrade on the mirror farm denying heterogeneous cluster formation

Request

This request has no parameters.

Responses

The state of the rolling upgrade which includes the current version on all the nodes in the farm.

application/json;charset=UTF-8

RestRollingUpgradeState
POST/mirroring/latest/zdu/end
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/zdu/end' \ --header 'Accept: application/json;charset=UTF-8'
POST

Start ZDU upgrade on mirror farm

Enables upgrading of individual nodes within the cluster, allowing a heterogeneous cluster formation

Request

This request has no parameters.

Responses

The state of the rolling upgrade which includes the minimum version of all the nodes in the farm.

application/json;charset=UTF-8

RestRollingUpgradeState
POST/mirroring/latest/zdu/start
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/zdu/start' \ --header 'Accept: application/json;charset=UTF-8'

Rate this page: