Server
Bitbucket Data Center / / Modules
Operations
GET/mirroring/latest/upstreamServersGET/mirroring/latest/upstreamServers/{upstreamId}GET/mirroring/latest/upstreamServers/{upstreamId}/addon/descriptorPOST/mirroring/latest/upstreamServers/{upstreamId}/addon/disabledPOST/mirroring/latest/upstreamServers/{upstreamId}/addon/enabledPOST/mirroring/latest/upstreamServers/{upstreamId}/addon/eventsPOST/mirroring/latest/upstreamServers/{upstreamId}/addon/installedPOST/mirroring/latest/upstreamServers/{upstreamId}/addon/uninstalledGET/mirroring/latest/upstreamServers/{upstreamId}/farmNodesGET/mirroring/latest/upstreamServers/{upstreamId}/progressGET/mirroring/latest/upstreamServers/{upstreamId}/repos/{upstreamRepoId}POST/mirroring/latest/upstreamServers/{upstreamId}/repos/{upstreamRepoId}/synchronizationGET/mirroring/latest/upstreamServers/{upstreamId}/settingsPUT/mirroring/latest/upstreamServers/{upstreamId}/settingsGET/mirroring/latest/upstreamServers/{upstreamId}/settings/modePUT/mirroring/latest/upstreamServers/{upstreamId}/settings/modeGET/mirroring/latest/upstreamServers/{upstreamId}/settings/projectsPOST/mirroring/latest/upstreamServers/{upstreamId}/settings/projectsDEL/mirroring/latest/upstreamServers/{upstreamId}/settings/projectsPOST/mirroring/latest/upstreamServers/{upstreamId}/settings/projects/{projectId}DEL/mirroring/latest/upstreamServers/{upstreamId}/settings/projects/{projectId}POST/mirroring/latest/upstreamServers/{upstreamId}/synchronizationGET/mirroring/latest/account/settings/preferred-mirrorPOST/mirroring/latest/account/settings/preferred-mirrorDEL/mirroring/latest/account/settings/preferred-mirrorGET/mirroring/latest/analyticsSettingsPOST/mirroring/latest/authenticateGET/mirroring/latest/mirrorServersGET/mirroring/latest/mirrorServers/{mirrorId}PUT/mirroring/latest/mirrorServers/{mirrorId}DEL/mirroring/latest/mirrorServers/{mirrorId}POST/mirroring/latest/mirrorServers/{mirrorId}/eventsGET/mirroring/latest/mirrorServers/{mirrorId}/webPanels/configGET/mirroring/latest/projects/{projectId}GET/mirroring/latest/projects/{projectId}/reposGET/mirroring/latest/reposGET/mirroring/latest/repos/{repoId}GET/mirroring/latest/repos/{repoId}/mirrorsGET/mirroring/latest/requestsPOST/mirroring/latest/requestsGET/mirroring/latest/requests/{mirroringRequestId}DEL/mirroring/latest/requests/{mirroringRequestId}POST/mirroring/latest/requests/{mirroringRequestId}/acceptPOST/mirroring/latest/requests/{mirroringRequestId}/reject
GET

Get mirroring latest upstreamServers

Retrieves a page of upstream servers

Request

Query parameters

start

number

limit

number

Responses

A page of upstream servers

application/json

object
GET/mirroring/latest/upstreamServers
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "values": [ { "apiBaseUrl": "https://bitbucket.example.com", "id": "f76a35c5-4592-425d-bf85-b4d9db68e809", "state": "INSTALLED", "type": "server", "baseUrl": "https://bitbucket.example.com" } ], "size": 1, "isLastPage": true, "nextPageStart": 2154, "start": 2154, "limit": 25 }
GET

Get mirroring latest upstreamServers {upstreamId}

Retrieves upstream server details by ID.

Request

Path parameters

upstreamId

string

Required

Responses

The upstream server.

application/json

RestUpstreamServer
GET/mirroring/latest/upstreamServers/{upstreamId}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 { "apiBaseUrl": "https://bitbucket.example.com", "id": "f76a35c5-4592-425d-bf85-b4d9db68e809", "state": "INSTALLED", "type": "server", "baseUrl": "https://bitbucket.example.com" }
GET

Get mirroring latest upstreamServers {upstreamId} addon descriptor

Returns the mirroring atlassian-connect add-on descriptor for the upstream server identified by upstreamId.
This endpoint should only be called by upstream servers

Request

Path parameters

upstreamId

string

Required

Responses

atlassian-connect add-on descriptor

application/json

any

GET/mirroring/latest/upstreamServers/{upstreamId}/addon/descriptor
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/addon/descriptor' \ --header 'Accept: application/json'
POST

Post mirroring latest upstreamServers {upstreamId} addon disabledDeprecated

This REST endpoint is retained for backwards compatibility only. It is a no-op. Starting from 4.6.0, mirrors no longer specify a disabled lifecycle callback in their addon descriptor. Prior to 4.6.0, this was the callback method that was called when the mirroring atlassian-connect add-on has been disabled in the upstream server identified by upstreamId.

Request

Path parameters

upstreamId

string

Required

Responses

An empty response indicating that callback has been processed

POST/mirroring/latest/upstreamServers/{upstreamId}/addon/disabled
1 2 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/addon/disabled'
POST

Post mirroring latest upstreamServers {upstreamId} addon enabledDeprecated

This REST endpoint is retained for backwards compatibility only. It is a no-op. Starting from 4.6.0, mirrors no longer specify an enabled lifecycle callback in their addon descriptor. Prior to 4.6.0, this was the callback method that was called when the mirroring atlassian-connect add-on has been enabled in the upstream server identified by upstreamId.

Request

Path parameters

upstreamId

string

Required

Responses

An empty response indicating that callback has been processed

POST/mirroring/latest/upstreamServers/{upstreamId}/addon/enabled
1 2 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/addon/enabled'
POST

Post mirroring latest upstreamServers {upstreamId} addon events

Callback method for web hook events this mirror is interested in.
This endpoint should only be called by upstream servers

Request

Path parameters

upstreamId

string

Required

Request bodyapplication/json

the entity

RestUnknownEntity

Responses

an empty response indicating that callback has been processed

POST/mirroring/latest/upstreamServers/{upstreamId}/addon/events
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/addon/events' \ --header 'Content-Type: application/json' \ --data '{}'
POST

Post mirroring latest upstreamServers {upstreamId} addon installed

Callback method that should be called when the mirroring atlassian-connect add-on has been installed in the upstream server identified by upstreamId
This endpoint should only be called by upstream servers

Request

Path parameters

upstreamId

string

Required

Request bodyapplication/json

the event

apiBaseUrl

string

baseUrl

string

clientKey

string

Required
key

string

publicKey

string

sharedSecret

string

Required
teamId

string

teamName

string

Responses

An empty response indicating that callback has been processed

POST/mirroring/latest/upstreamServers/{upstreamId}/addon/installed
1 2 3 4 5 6 7 8 9 10 11 12 13 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/addon/installed' \ --header 'Content-Type: application/json' \ --data '{ "apiBaseUrl": "<string>", "baseUrl": "https://us-east.bitbucket.example.com", "clientKey": "atlassian-mirroring-addon", "key": "connect-mirror-install", "publicKey": "616161", "sharedSecret": "424242", "teamId": "<string>", "teamName": "<string>" }'
POST

Post mirroring latest upstreamServers {upstreamId} addon uninstalled

Callback method that should be called when the mirroring atlassian-connect add-on has been uninstalled from the upstream server identified by upstreamId
This endpoint should only be called by upstream servers

Request

Path parameters

upstreamId

string

Required

Responses

An empty response indicating that callback has been processed

POST/mirroring/latest/upstreamServers/{upstreamId}/addon/uninstalled
1 2 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/addon/uninstalled'
GET

Get mirroring latest upstreamServers {upstreamId} farmNodes

Retrieves the list of farm nodes in this cluster

Request

Path parameters

upstreamId

string

Required

Responses

The list of farm nodes

application/json;charset=UTF-8

array<RestClusterNode>

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

Get mirroring latest upstreamServers {upstreamId} progress

Retrieves synchronization progress state for the specified upstream server.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

Path parameters

upstreamId

string

Required

Responses

the synchronization progress state

application/json

RestSyncProgress
GET/mirroring/latest/upstreamServers/{upstreamId}/progress
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/progress' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 { "discovering": true, "syncedRepos": 2154, "totalRepos": 2154 }
GET

Get mirroring latest upstreamServers {upstreamId} repos {upstreamRepoId}

Retrieves all available clone urls for the specified repository.

Request

Path parameters

upstreamRepoId

string

Required
upstreamId

string

Required

Responses

The mirrored repository's information.

application/json

RestMirroredRepository
GET/mirroring/latest/upstreamServers/{upstreamId}/repos/{upstreamRepoId}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/repos/{upstreamRepoId}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 { "pushUrls": [ { "name": "http", "href": "https://bitbucket.example.com/scm/awesomeproject/awesomerepo.git" } ], "cloneUrls": [ { "name": "http", "href": "https://bitbucket.example.com/scm/awesomeproject/awesomerepo.git" } ], "mirrorName": "Saigon Mirror", "lastUpdated": "<string>", "available": true, "status": "NOT_MIRRORED", "repositoryId": "1" }
POST

Post mirroring latest upstreamServers {upstreamId} repos {upstreamRepoId} synchronizationDeprecated

This method is no longer supported

Request

Path parameters

upstreamRepoId

string

Required
upstreamId

string

Required

Query parameters

level

string

Responses

this operation is no longer supported

application/json

any

POST/mirroring/latest/upstreamServers/{upstreamId}/repos/{upstreamRepoId}/synchronization
1 2 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/repos/{upstreamRepoId}/synchronization'
GET

Get mirroring latest upstreamServers {upstreamId} settings

Retrieves mirror settings

Request

Path parameters

upstreamId

string

Required

Responses

the mirror settings

application/json

RestUpstreamSettings
GET/mirroring/latest/upstreamServers/{upstreamId}/settings
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/settings' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 { "projectIds": [ "<string>" ], "mode": "ALL_PROJECTS" }
PUT

Put mirroring latest upstreamServers {upstreamId} settings

Sets the settings for the specified upstream

Request

Path parameters

upstreamId

string

Required

Request bodyapplication/json

the mirror settings to update to

projectIds

array<string>

mode

string

Responses

the updated mirror settings

application/json

RestUpstreamSettings
PUT/mirroring/latest/upstreamServers/{upstreamId}/settings
1 2 3 4 5 6 7 8 9 10 curl --request PUT \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/settings' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "projectIds": [ "<string>" ], "mode": "ALL_PROJECTS" }'
200Response
1 2 3 4 5 6 { "projectIds": [ "<string>" ], "mode": "ALL_PROJECTS" }
GET

Get mirroring latest upstreamServers {upstreamId} settings mode

Gets the current mirror mode for the specified upstream

Request

Path parameters

upstreamId

string

Required

Responses

the current mirror mode

application/json

any

GET/mirroring/latest/upstreamServers/{upstreamId}/settings/mode
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/settings/mode' \ --header 'Accept: application/json'
PUT

Put mirroring latest upstreamServers {upstreamId} settings mode

Sets the mirror mode for the specified upstream

Request

Path parameters

upstreamId

string

Required

Request bodyapplication/json

string

Responses

the mode to set

application/json

any

PUT/mirroring/latest/upstreamServers/{upstreamId}/settings/mode
1 2 3 4 5 curl --request PUT \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/settings/mode' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '"<string>"'
GET

Get mirroring latest upstreamServers {upstreamId} settings projects

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

Request

Path parameters

upstreamId

string

Required

Responses

the currently mirrored project IDs

application/json

any

GET/mirroring/latest/upstreamServers/{upstreamId}/settings/projects
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/settings/projects' \ --header 'Accept: application/json'
POST

Post mirroring latest upstreamServers {upstreamId} settings projects

Configures the mirror to mirror the provided projects

Request

Path parameters

upstreamId

string

Required

Request bodyapplication/json

array<string>

Responses

the currently mirrored project IDs

application/json

any

POST/mirroring/latest/upstreamServers/{upstreamId}/settings/projects
1 2 3 4 5 6 7 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/settings/projects' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '[ "<string>" ]'
DEL

Delete mirroring latest upstreamServers {upstreamId} settings projects

Configures the mirror to no longer mirror the provided projects

Request

Path parameters

upstreamId

string

Required

Request bodyapplication/json

array<string>

Responses

the request has been processed

DEL/mirroring/latest/upstreamServers/{upstreamId}/settings/projects
1 2 3 4 5 6 curl --request DELETE \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/settings/projects' \ --header 'Content-Type: application/json' \ --data '[ "<string>" ]'
POST

Post mirroring latest upstreamServers {upstreamId} settings projects {projectId}

Configures the mirror to mirror the provided project

Request

Path parameters

upstreamId

string

Required
projectId

string

Required

Responses

the currently mirrored project IDs

application/json

any

POST/mirroring/latest/upstreamServers/{upstreamId}/settings/projects/{projectId}
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/settings/projects/{projectId}' \ --header 'Accept: application/json'
DEL

Delete mirroring latest upstreamServers {upstreamId} settings projects {projectId}

Configures the mirror to no longer mirror the provided project

Request

Path parameters

upstreamId

string

Required
projectId

string

Required

Responses

the request has been processed

DEL/mirroring/latest/upstreamServers/{upstreamId}/settings/projects/{projectId}
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/settings/projects/{projectId}'
POST

Post mirroring latest upstreamServers {upstreamId} synchronizationDeprecated

This method is no longer supported

Request

Path parameters

upstreamId

string

Required

Query parameters

level

string

Responses

this operation is no longer supported

application/json

any

POST/mirroring/latest/upstreamServers/{upstreamId}/synchronization
1 2 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/upstreamServers/{upstreamId}/synchronization'
GET

Get mirroring latest account settings preferred-mirror

Retrieves the current user's preferred mirror server

Request

This request has no parameters.

Responses

the preferred mirror server

application/json

RestMirrorServer
GET/mirroring/latest/account/settings/preferred-mirror
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/account/settings/preferred-mirror' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 { "lastSeenDate": "<string>", "productVersion": "8.0.0", "mirrorType": "SINGLE", "productType": "Bitbucket", "name": "Mirror", "id": "B0F5-CS21-45C2-CCK3", "enabled": true, "baseUrl": "http://vietnam.example.com" }
POST

Post mirroring latest account settings preferred-mirror

Sets the mirror specified by a mirror ID as the current user's preferred mirror

Request

Request bodyapplication/json

the mirror ID

string

Responses

an empty response indicating that the user setting has been updated

POST/mirroring/latest/account/settings/preferred-mirror
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/account/settings/preferred-mirror' \ --header 'Content-Type: application/json' \ --data '"<string>"'
DEL

Delete mirroring latest account settings preferred-mirror

Removes the current user's preferred mirror

Request

This request has no parameters.

Responses

an empty response indicating that the user setting has been updated

DEL/mirroring/latest/account/settings/preferred-mirror
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/mirroring/latest/account/settings/preferred-mirror'
GET

Get mirroring latest analyticsSettings

Request

This request has no parameters.

Responses

The analytics settings from upstream

application/json

RestAnalyticsSettings
GET/mirroring/latest/analyticsSettings
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/analyticsSettings' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 { "supportEntitlementNumber": "SEN-500", "canCollectAnalytics": true, "serverTime": 1640390400000 }
POST

Post mirroring latest authenticate

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.

Request

Request bodyapplication/json

credentials

RestUsernamePasswordCredentials

Required
repositoryId

integer

Responses

The user for the supplied credentials and their effective permissions}.

application/json

RestApplicationUserWithPermissions
POST/mirroring/latest/authenticate
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 }'
200Response
1 2 3 4 5 6 7 8 9 10 { "effectivePermissions": {}, "slug": "jcitizen", "displayName": "Jane Citizen", "id": 101, "type": "NORMAL", "active": true, "emailAddress": "jane@example.com", "name": "jcitizen" }
GET

Get mirroring latest mirrorServers

Returns a list of mirrors

Request

Query parameters

start

number

limit

number

Responses

a page of mirrors

application/json

object
GET/mirroring/latest/mirrorServers
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/mirrorServers' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 { "values": [ { "lastSeenDate": "<string>", "productVersion": "8.0.0", "mirrorType": "SINGLE", "productType": "Bitbucket", "name": "Mirror", "id": "B0F5-CS21-45C2-CCK3", "enabled": true, "baseUrl": "http://vietnam.example.com" } ], "size": 1, "isLastPage": true, "nextPageStart": 2154, "start": 2154, "limit": 25 }
GET

Get mirroring latest mirrorServers {mirrorId}

Returns the mirror specified by a mirror ID

Request

Path parameters

mirrorId

string

Required

Responses

the mirror

application/json

RestMirrorServer
GET/mirroring/latest/mirrorServers/{mirrorId}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/mirrorServers/{mirrorId}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 { "lastSeenDate": "<string>", "productVersion": "8.0.0", "mirrorType": "SINGLE", "productType": "Bitbucket", "name": "Mirror", "id": "B0F5-CS21-45C2-CCK3", "enabled": true, "baseUrl": "http://vietnam.example.com" }
PUT

Put mirroring latest mirrorServers {mirrorId}

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

Request

Path parameters

mirrorId

string

Required

Request bodyapplication/json

addonDescriptorUri

string

baseUrl

string

productType

string

productVersion

string

Responses

the mirror

application/json

RestMirrorServer
PUT/mirroring/latest/mirrorServers/{mirrorId}
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" }'
200Response
1 2 3 4 5 6 7 8 9 10 { "lastSeenDate": "<string>", "productVersion": "8.0.0", "mirrorType": "SINGLE", "productType": "Bitbucket", "name": "Mirror", "id": "B0F5-CS21-45C2-CCK3", "enabled": true, "baseUrl": "http://vietnam.example.com" }
DEL

Delete mirroring latest mirrorServers {mirrorId}

Removes a mirror, disabling all access and notifications for the mirror server in question

Request

Path parameters

mirrorId

string

Required

Responses

an empty response indicating that the mirror has been removed

DEL/mirroring/latest/mirrorServers/{mirrorId}
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/mirroring/latest/mirrorServers/{mirrorId}'
POST

Post mirroring latest mirrorServers {mirrorId} events

Publishes a RepositoryMirrorEvent on the event queue.

Request

Path parameters

mirrorId

string

Required

Request bodyapplication/json

mirrorRepoId

integer

type

string

upstreamRepoId

string

Responses

The event was successfully placed on the queue

POST/mirroring/latest/mirrorServers/{mirrorId}/events
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" }'
GET

Get mirroring latest mirrorServers {mirrorId} webPanels config

Request

Path parameters

mirrorId

string

Required

Responses

default response

text/html

any

GET/mirroring/latest/mirrorServers/{mirrorId}/webPanels/config
1 2 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/mirrorServers/{mirrorId}/webPanels/config'
GET

Get mirroring latest projects {projectId}

Returns the requested project using its primary key ID.
Since 6.7

Request

Path parameters

projectId

string

Required

Responses

The project with the specified ID

application/json

RestProject
GET/mirroring/latest/projects/{projectId}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/projects/{projectId}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 { "avatar": "<string>", "name": "My Cool Project", "key": "PRJ", "public": true, "id": 2154, "type": "NORMAL", "description": "The description for my cool project", "namespace": "<string>", "scope": "PROJECT" }
GET

Get mirroring latest projects {projectId} repos

Returns a page of repositories for a given project, enriched with a content hash

Request

Path parameters

projectId

string

Required

Query parameters

includeDefaultBranch

string

start

number

limit

number

Responses

A page of repositories with content hashes

application/json

object
GET/mirroring/latest/projects/{projectId}/repos
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/projects/{projectId}/repos' \ --header 'Accept: application/json'
200Response
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 { "values": [ { "properties": { "defaultBranchId": "refs/heads/master", "contentHash": "457389a0b871fb61012a7351d09aefc0cf1c57c306449d4b5df4d2f381df8433", "metadataHash": "11e5cd17e8d74d84a11f2c8a6bbc6ae0a2b69059e54030f49214c94d980364c1" }, "scmId": "git", "hierarchyId": "e3c939f9ef4a7fae272e", "statusMessage": "Available", "partition": 2154, "origin": { "scmId": "git", "hierarchyId": "e3c939f9ef4a7fae272e", "statusMessage": "Available", "partition": 2154, "archived": true, "forkable": true, "defaultBranch": "main", "relatedLinks": {}, "slug": "my-repo", "name": "My repo", "public": true, "id": 2154, "state": "AVAILABLE", "description": "My repo description", "scope": "REPOSITORY" }, "archived": true, "forkable": true, "defaultBranch": "main", "relatedLinks": {}, "slug": "my-repo", "name": "My repo", "public": true, "id": 2154, "state": "AVAILABLE", "description": "My repo description", "scope": "REPOSITORY" } ], "size": 1, "isLastPage": true, "nextPageStart": 2154, "start": 2154, "limit": 25 }
GET

Get mirroring latest repos

Returns a page of repositories enriched with a content hash and default branch

Request

Query parameters

includeDefaultBranch

string

Responses

A page of repositories with content hashes and default branch

application/json

EnrichedRepository
GET/mirroring/latest/repos
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/repos' \ --header 'Accept: application/json'
200Response
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 { "properties": { "defaultBranchId": "refs/heads/master", "contentHash": "457389a0b871fb61012a7351d09aefc0cf1c57c306449d4b5df4d2f381df8433", "metadataHash": "11e5cd17e8d74d84a11f2c8a6bbc6ae0a2b69059e54030f49214c94d980364c1" }, "scmId": "git", "hierarchyId": "e3c939f9ef4a7fae272e", "statusMessage": "Available", "partition": 2154, "origin": { "scmId": "git", "hierarchyId": "e3c939f9ef4a7fae272e", "statusMessage": "Available", "partition": 2154, "archived": true, "forkable": true, "defaultBranch": "main", "relatedLinks": {}, "slug": "my-repo", "name": "My repo", "public": true, "id": 2154, "state": "AVAILABLE", "description": "My repo description", "scope": "REPOSITORY" }, "archived": true, "forkable": true, "defaultBranch": "main", "relatedLinks": {}, "slug": "my-repo", "name": "My repo", "public": true, "id": 2154, "state": "AVAILABLE", "description": "My repo description", "scope": "REPOSITORY" }
GET

Get mirroring latest repos {repoId}

Returns a repository enriched with a content hash and default branch

Request

Path parameters

repoId

string

Required

Query parameters

includeDefaultBranch

boolean

Responses

The repository with the specified repoId

application/json

EnrichedRepository
GET/mirroring/latest/repos/{repoId}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/repos/{repoId}' \ --header 'Accept: application/json'
200Response
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 { "properties": { "defaultBranchId": "refs/heads/master", "contentHash": "457389a0b871fb61012a7351d09aefc0cf1c57c306449d4b5df4d2f381df8433", "metadataHash": "11e5cd17e8d74d84a11f2c8a6bbc6ae0a2b69059e54030f49214c94d980364c1" }, "scmId": "git", "hierarchyId": "e3c939f9ef4a7fae272e", "statusMessage": "Available", "partition": 2154, "origin": { "scmId": "git", "hierarchyId": "e3c939f9ef4a7fae272e", "statusMessage": "Available", "partition": 2154, "archived": true, "forkable": true, "defaultBranch": "main", "relatedLinks": {}, "slug": "my-repo", "name": "My repo", "public": true, "id": 2154, "state": "AVAILABLE", "description": "My repo description", "scope": "REPOSITORY" }, "archived": true, "forkable": true, "defaultBranch": "main", "relatedLinks": {}, "slug": "my-repo", "name": "My repo", "public": true, "id": 2154, "state": "AVAILABLE", "description": "My repo description", "scope": "REPOSITORY" }
GET

Get mirroring latest repos {repoId} mirrors

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.

Request

Path parameters

repoId

string

Required

Responses

The mirrored repository descriptor

application/json

RestMirroredRepositoryDescriptor
GET/mirroring/latest/repos/{repoId}/mirrors
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/repos/{repoId}/mirrors' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 { "mirrorServer": { "lastSeenDate": "<string>", "productVersion": "8.0.0", "mirrorType": "SINGLE", "productType": "Bitbucket", "name": "Mirror", "id": "B0F5-CS21-45C2-CCK3", "enabled": true, "baseUrl": "http://vietnam.example.com" } }
GET

Get mirroring latest requests

Retrieves a mirroring request

Request

Query parameters

state

string

start

number

limit

number

Responses

A page of mirroring requests

application/json

object
GET/mirroring/latest/requests
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/requests' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 { "values": [ { "productVersion": "8.0.0", "mirrorType": "SINGLE", "productType": "Bitbucket", "mirrorId": "4f0eb5fc-67fc-48f8-b4a7-87981f026c6a", "mirrorName": "Bitbucket Mirror", "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 }
POST

Post mirroring latest requests

Creates a new mirroring request

Request

Request bodyapplication/json

productVersion

string

mirrorType

string

productType

string

mirrorId

string

mirrorName

string

addonDescriptorUri

string

mirrorBaseUrl

string

state

string

Responses

The created mirroring request

application/json

RestMirroringRequest
POST/mirroring/latest/requests
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 '{ "productVersion": "8.0.0", "mirrorType": "SINGLE", "productType": "Bitbucket", "mirrorId": "4f0eb5fc-67fc-48f8-b4a7-87981f026c6a", "mirrorName": "Bitbucket Mirror", "addonDescriptorUri": "https://bitbucket-eu.example.com:7990/bitbucket/rest/mirroring/1.0/descriptor", "mirrorBaseUrl": "https://bitbucket-eu.example.com:7990/bitbucket", "state": "PENDING" }'
200Response
1 2 3 4 5 6 7 8 9 10 11 { "productVersion": "8.0.0", "mirrorType": "SINGLE", "productType": "Bitbucket", "mirrorId": "4f0eb5fc-67fc-48f8-b4a7-87981f026c6a", "mirrorName": "Bitbucket Mirror", "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" }
GET

Get mirroring latest requests {mirroringRequestId}

Retrieves a mirroring request

Request

Path parameters

mirroringRequestId

string

Required

Responses

The mirroring request

application/json

RestMirroringRequest
GET/mirroring/latest/requests/{mirroringRequestId}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/mirroring/latest/requests/{mirroringRequestId}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 { "productVersion": "8.0.0", "mirrorType": "SINGLE", "productType": "Bitbucket", "mirrorId": "4f0eb5fc-67fc-48f8-b4a7-87981f026c6a", "mirrorName": "Bitbucket Mirror", "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" }
DEL

Delete mirroring latest requests {mirroringRequestId}

Deletes a mirroring request

Request

Path parameters

mirroringRequestId

string

Required

Responses

The request was deleted

DEL/mirroring/latest/requests/{mirroringRequestId}
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/mirroring/latest/requests/{mirroringRequestId}'
POST

Post mirroring latest requests {mirroringRequestId} accept

Accepts a mirroring request

Request

Path parameters

mirroringRequestId

string

Required

Responses

The accepted mirror server

application/json

RestMirrorServer
POST/mirroring/latest/requests/{mirroringRequestId}/accept
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/requests/{mirroringRequestId}/accept' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 { "lastSeenDate": "<string>", "productVersion": "8.0.0", "mirrorType": "SINGLE", "productType": "Bitbucket", "name": "Mirror", "id": "B0F5-CS21-45C2-CCK3", "enabled": true, "baseUrl": "http://vietnam.example.com" }
POST

Post mirroring latest requests {mirroringRequestId} reject

Rejects a mirroring request

Request

Path parameters

mirroringRequestId

string

Required

Responses

The rejected mirror server

application/json

RestMirrorServer
POST/mirroring/latest/requests/{mirroringRequestId}/reject
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/requests/{mirroringRequestId}/reject' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 { "lastSeenDate": "<string>", "productVersion": "8.0.0", "mirrorType": "SINGLE", "productType": "Bitbucket", "name": "Mirror", "id": "B0F5-CS21-45C2-CCK3", "enabled": true, "baseUrl": "http://vietnam.example.com" }

Rate this page: