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 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'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"available": true,
"cloneUrls": [
{
"href": "https://bitbucket.example.com/scm/awesomeproject/awesomerepo.git",
"name": "http"
}
],
"lastUpdated": "<string>",
"mirrorName": "Saigon Mirror",
"pushUrls": [
{
"href": "https://bitbucket.example.com/scm/awesomeproject/awesomerepo.git",
"name": "http"
}
],
"repositoryId": "1",
"status": "NOT_MIRRORED"
}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'1
2
3
4
5
{
"discovering": true,
"syncedRepos": 2154,
"totalRepos": 2154
}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/{repoSlug}/repoSyncStatus' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"externalRepoId": "1",
"failedSyncCount": 1,
"hashes": {
"content": "677513e1f2a93ff50e7b709e3c96454c23a3fcd40046ab385c4093e30809500a",
"metadata": "677513e1f2a93ff50e7b709e3c96454c23a3fcd40046ab385c4093e30809500a"
},
"initialSyncDate": "<string>",
"lastSyncDate": "<string>",
"localProjectId": 1,
"localRepoId": 1,
"upstreamId": "148728f5-df0f-3f3e-af11-5ca16be3725f"
}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'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'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"isLastPage": true,
"limit": 25,
"nextPageStart": 2154,
"size": 1,
"start": 2154,
"values": [
{
"externalRepoId": "1",
"failedSyncCount": 1,
"hashes": {
"content": "677513e1f2a93ff50e7b709e3c96454c23a3fcd40046ab385c4093e30809500a",
"metadata": "677513e1f2a93ff50e7b709e3c96454c23a3fcd40046ab385c4093e30809500a"
},
"initialSyncDate": "<string>",
"lastSyncDate": "<string>",
"localProjectId": 1,
"localRepoId": 1,
"upstreamId": "148728f5-df0f-3f3e-af11-5ca16be3725f"
}
]
}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'1
2
3
4
5
6
{
"mode": "ALL_PROJECTS",
"projectIds": [
"<string>"
]
}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' \
--header 'Content-Type: application/json' \
--data '{
"mode": "ALL_PROJECTS",
"projectIds": [
"<string>"
]
}'1
2
3
4
5
6
{
"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'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' \
--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'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' \
--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'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'1
2
3
4
5
{
"baseUrl": "https://bitbucket.example.com",
"id": "f76a35c5-4592-425d-bf85-b4d9db68e809",
"state": "INSTALLED"
}Rate this page: