Retrieves the current user's preferred mirror server
Forge and OAuth2 apps cannot access this REST resource.
This request has no parameters.
the preferred mirror server
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/account/settings/preferred-mirror' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
{
"lastSeenDate": "<string>",
"mirrorType": "SINGLE",
"productType": "Bitbucket",
"productVersion": "8.0.0",
"enabled": true,
"baseUrl": "http://vietnam.example.com",
"name": "Mirror",
"id": "B0F5-CS21-45C2-CCK3"
}Sets the mirror specified by a mirror ID as the current user's preferred mirror
Forge and OAuth2 apps cannot access this REST resource.
the mirror ID
string
an empty response indicating that the user setting has been updated
1
2
3
4
curl --request POST \
--url 'http://{baseurl}/rest/mirroring/latest/account/settings/preferred-mirror' \
--header 'Content-Type: application/json' \
--data '"<string>"'Removes the current user's preferred mirror
Forge and OAuth2 apps cannot access this REST resource.
This request has no parameters.
an empty response indicating that the user setting has been updated
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/mirroring/latest/account/settings/preferred-mirror'Forge and OAuth2 apps cannot access this REST resource.
This request has no parameters.
The analytics settings from upstream
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/analyticsSettings' \
--header 'Accept: application/json'1
2
3
4
5
{
"supportEntitlementNumber": "SEN-500",
"canCollectAnalytics": true,
"serverTime": 1640390400000
}Authenticates on behalf of a user. Used by mirrors to check the credentials supplied to them by users. If successful a user and their effective permissions is returned. Currently only username/password and SSH credentials are supported.
Forge and OAuth2 apps cannot access this REST resource.
RestUsernamePasswordCredentials
Requiredinteger
The user for the supplied credentials and their effective permissions}.
1
2
3
4
5
6
7
8
9
10
11
curl --request POST \
--url 'http://{baseurl}/rest/mirroring/latest/authenticate' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"credentials": {
"password": "secr3t",
"username": "user1"
},
"repositoryId": 2154
}'1
2
3
4
5
6
7
8
9
10
{
"effectivePermissions": {},
"slug": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen",
"emailAddress": "jane@example.com",
"name": "jcitizen"
}Returns a list of mirrors
Forge and OAuth2 apps cannot access this REST resource.
number
number
a page of mirrors
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/mirrorServers' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"values": [
{
"lastSeenDate": "<string>",
"mirrorType": "SINGLE",
"productType": "Bitbucket",
"productVersion": "8.0.0",
"enabled": true,
"baseUrl": "http://vietnam.example.com",
"name": "Mirror",
"id": "B0F5-CS21-45C2-CCK3"
}
],
"size": 1,
"isLastPage": true,
"nextPageStart": 2154,
"start": 2154,
"limit": 25
}Returns the mirror specified by a mirror ID
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredthe mirror
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/mirrorServers/{mirrorId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
{
"lastSeenDate": "<string>",
"mirrorType": "SINGLE",
"productType": "Bitbucket",
"productVersion": "8.0.0",
"enabled": true,
"baseUrl": "http://vietnam.example.com",
"name": "Mirror",
"id": "B0F5-CS21-45C2-CCK3"
}Upgrades the add-on for the mirror server in question This endpoint can only be called by the mirror instance or system administrators
Since 5.8
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
string
string
string
the mirror
1
2
3
4
5
6
7
8
9
10
curl --request PUT \
--url 'http://{baseurl}/rest/mirroring/latest/mirrorServers/{mirrorId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"addonDescriptorUri": "https://bitbucket-eu.example.com:7990/bitbucket/rest/mirroring/1.0/descriptor",
"baseUrl": "https://bitbucket-eu.example.com:7990/bitbucket",
"productType": "Bitbucket",
"productVersion": "8.0.0"
}'1
2
3
4
5
6
7
8
9
10
{
"lastSeenDate": "<string>",
"mirrorType": "SINGLE",
"productType": "Bitbucket",
"productVersion": "8.0.0",
"enabled": true,
"baseUrl": "http://vietnam.example.com",
"name": "Mirror",
"id": "B0F5-CS21-45C2-CCK3"
}Removes a mirror, disabling all access and notifications for the mirror server in question
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredan empty response indicating that the mirror has been removed
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/mirroring/latest/mirrorServers/{mirrorId}'Publishes a RepositoryMirrorEvent on the event queue.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredinteger
string
string
The event was successfully placed on the queue
1
2
3
4
5
6
7
8
curl --request POST \
--url 'http://{baseurl}/rest/mirroring/latest/mirrorServers/{mirrorId}/events' \
--header 'Content-Type: application/json' \
--data '{
"mirrorRepoId": 42,
"type": "SYNCHRONIZED",
"upstreamRepoId": "24"
}'Forge and OAuth2 apps cannot access this REST resource.
string
Requireddefault response
any
1
2
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/mirrorServers/{mirrorId}/webPanels/config'Returns the requested project using its primary key ID.
Since 6.7
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredThe project with the specified ID
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/projects/{projectId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
{
"description": "The description for my cool project",
"namespace": "<string>",
"avatar": "<string>",
"scope": "PROJECT",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
}Returns a page of repositories for a given project, enriched with a content hash
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
number
number
A page of repositories with content hashes
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/projects/{projectId}/repos' \
--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
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
{
"values": [
{
"properties": {
"contentHash": "457389a0b871fb61012a7351d09aefc0cf1c57c306449d4b5df4d2f381df8433",
"defaultBranchId": "refs/heads/master",
"metadataHash": "11e5cd17e8d74d84a11f2c8a6bbc6ae0a2b69059e54030f49214c94d980364c1"
},
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"relatedLinks": {},
"partition": 2154,
"defaultBranch": "main",
"description": "My repo description",
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"project": {
"description": "The description for my cool project",
"namespace": "<string>",
"avatar": "<string>",
"scope": "PROJECT",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"relatedLinks": {},
"partition": 2154,
"defaultBranch": "main",
"description": "My repo description",
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"project": {
"description": "The description for my cool project",
"namespace": "<string>",
"avatar": "<string>",
"scope": "PROJECT",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scope": "REPOSITORY",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
}
],
"size": 1,
"isLastPage": true,
"nextPageStart": 2154,
"start": 2154,
"limit": 25
}Returns a page of repositories enriched with a content hash and default branch
Forge and OAuth2 apps cannot access this REST resource.
string
A page of repositories with content hashes and default branch
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/repos' \
--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
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
{
"properties": {
"contentHash": "457389a0b871fb61012a7351d09aefc0cf1c57c306449d4b5df4d2f381df8433",
"defaultBranchId": "refs/heads/master",
"metadataHash": "11e5cd17e8d74d84a11f2c8a6bbc6ae0a2b69059e54030f49214c94d980364c1"
},
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"relatedLinks": {},
"partition": 2154,
"defaultBranch": "main",
"description": "My repo description",
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"project": {
"description": "The description for my cool project",
"namespace": "<string>",
"avatar": "<string>",
"scope": "PROJECT",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"relatedLinks": {},
"partition": 2154,
"defaultBranch": "main",
"description": "My repo description",
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"project": {
"description": "The description for my cool project",
"namespace": "<string>",
"avatar": "<string>",
"scope": "PROJECT",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scope": "REPOSITORY",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
}Returns a repository enriched with a content hash and default branch
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredboolean
The repository with the specified repoId
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/repos/{repoId}' \
--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
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
{
"properties": {
"contentHash": "457389a0b871fb61012a7351d09aefc0cf1c57c306449d4b5df4d2f381df8433",
"defaultBranchId": "refs/heads/master",
"metadataHash": "11e5cd17e8d74d84a11f2c8a6bbc6ae0a2b69059e54030f49214c94d980364c1"
},
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"relatedLinks": {},
"partition": 2154,
"defaultBranch": "main",
"description": "My repo description",
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"project": {
"description": "The description for my cool project",
"namespace": "<string>",
"avatar": "<string>",
"scope": "PROJECT",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"relatedLinks": {},
"partition": 2154,
"defaultBranch": "main",
"description": "My repo description",
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"project": {
"description": "The description for my cool project",
"namespace": "<string>",
"avatar": "<string>",
"scope": "PROJECT",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scope": "REPOSITORY",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
}Returns a page of mirrors for a repository. This resource will return all mirrors along with authorized links to the mirror's repository REST resource. To determine if a repository is available on the mirror, the returned URL needs to be called.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredThe mirrored repository descriptor
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/repos/{repoId}/mirrors' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
{
"mirrorServer": {
"lastSeenDate": "<string>",
"mirrorType": "SINGLE",
"productType": "Bitbucket",
"productVersion": "8.0.0",
"enabled": true,
"baseUrl": "http://vietnam.example.com",
"name": "Mirror",
"id": "B0F5-CS21-45C2-CCK3"
}
}Retrieves a mirroring request
Forge and OAuth2 apps cannot access this REST resource.
string
number
number
A page of mirroring requests
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/requests' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"values": [
{
"mirrorName": "Bitbucket Mirror",
"mirrorType": "SINGLE",
"productType": "Bitbucket",
"productVersion": "8.0.0",
"mirrorId": "4f0eb5fc-67fc-48f8-b4a7-87981f026c6a",
"addonDescriptorUri": "https://bitbucket-eu.example.com:7990/bitbucket/rest/mirroring/1.0/descriptor",
"mirrorBaseUrl": "https://bitbucket-eu.example.com:7990/bitbucket",
"id": 2154,
"state": "PENDING"
}
],
"size": 1,
"isLastPage": true,
"nextPageStart": 2154,
"start": 2154,
"limit": 25
}Creates a new mirroring request
Forge and OAuth2 apps cannot access this REST resource.
string
string
string
string
string
string
string
string
The created mirroring request
1
2
3
4
5
6
7
8
9
10
11
12
13
14
curl --request POST \
--url 'http://{baseurl}/rest/mirroring/latest/requests' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"mirrorName": "Bitbucket Mirror",
"mirrorType": "SINGLE",
"productType": "Bitbucket",
"productVersion": "8.0.0",
"mirrorId": "4f0eb5fc-67fc-48f8-b4a7-87981f026c6a",
"addonDescriptorUri": "https://bitbucket-eu.example.com:7990/bitbucket/rest/mirroring/1.0/descriptor",
"mirrorBaseUrl": "https://bitbucket-eu.example.com:7990/bitbucket",
"state": "PENDING"
}'1
2
3
4
5
6
7
8
9
10
11
{
"mirrorName": "Bitbucket Mirror",
"mirrorType": "SINGLE",
"productType": "Bitbucket",
"productVersion": "8.0.0",
"mirrorId": "4f0eb5fc-67fc-48f8-b4a7-87981f026c6a",
"addonDescriptorUri": "https://bitbucket-eu.example.com:7990/bitbucket/rest/mirroring/1.0/descriptor",
"mirrorBaseUrl": "https://bitbucket-eu.example.com:7990/bitbucket",
"id": 2154,
"state": "PENDING"
}Retrieves a mirroring request
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredThe mirroring request
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/mirroring/latest/requests/{mirroringRequestId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
{
"mirrorName": "Bitbucket Mirror",
"mirrorType": "SINGLE",
"productType": "Bitbucket",
"productVersion": "8.0.0",
"mirrorId": "4f0eb5fc-67fc-48f8-b4a7-87981f026c6a",
"addonDescriptorUri": "https://bitbucket-eu.example.com:7990/bitbucket/rest/mirroring/1.0/descriptor",
"mirrorBaseUrl": "https://bitbucket-eu.example.com:7990/bitbucket",
"id": 2154,
"state": "PENDING"
}Deletes a mirroring request
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredThe request was deleted
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/mirroring/latest/requests/{mirroringRequestId}'Accepts a mirroring request
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredThe accepted mirror server
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/mirroring/latest/requests/{mirroringRequestId}/accept' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
{
"lastSeenDate": "<string>",
"mirrorType": "SINGLE",
"productType": "Bitbucket",
"productVersion": "8.0.0",
"enabled": true,
"baseUrl": "http://vietnam.example.com",
"name": "Mirror",
"id": "B0F5-CS21-45C2-CCK3"
}Rejects a mirroring request
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredThe rejected mirror server
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/mirroring/latest/requests/{mirroringRequestId}/reject' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
{
"lastSeenDate": "<string>",
"mirrorType": "SINGLE",
"productType": "Bitbucket",
"productVersion": "8.0.0",
"enabled": true,
"baseUrl": "http://vietnam.example.com",
"name": "Mirror",
"id": "B0F5-CS21-45C2-CCK3"
}Rate this page: