GET

Get preferred mirror

Retrieves the current user's preferred mirror server

Request

This request has no parameters.

Responses

the preferred mirror server

application/json;charset=UTF-8

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;charset=UTF-8'
POST

Set 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

Remove 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 analytics settings from upstream

Gets the analytics settings from the mirroring upstream

Request

This request has no parameters.

Responses

The analytics settings from upstream

application/json;charset=UTF-8

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

Authenticate on behalf of a user

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 are returned as follows -

  • For SSH credentials - all the effective user permissions are returned.
  • For all other credentials - the highest global permission is returned along with highest repository permission if repository ID is also provided in the request.

Currently only username/password, bearer token and SSH credentials are supported.

Request

Request bodyapplication/json

credentials

oneOf [RestUsernamePasswordCredentials, RestBearerTokenCredentials, RestSshCredentials]

Required
repositoryId

integer

Responses

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

application/json;charset=UTF-8

RestApplicationUserWithPermissions
POST/mirroring/latest/authenticate
1 2 3 4 5 6 7 8 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/authenticate' \ --header 'Accept: application/json;charset=UTF-8' \ --header 'Content-Type: application/json' \ --data '{ "credentials": {}, "repositoryId": 2154 }'
GET

Get all mirrors

Returns a list of mirrors

Request

Query parameters

start

number

limit

number

Responses

a page of mirrors

application/json;charset=UTF-8

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

Get mirror by ID

Returns the mirror specified by a mirror ID

Request

Path parameters

mirrorId

string

Required

Responses

the mirror

application/json;charset=UTF-8

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

Upgrade mirror server

Upgrades the mirror server in question with the provided details.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

baseUrl

string

productVersion

string

Responses

the mirror

application/json;charset=UTF-8

RestMirrorServer
PUT/mirroring/latest/mirrorServers/{mirrorId}
1 2 3 4 5 6 7 8 curl --request PUT \ --url 'http://{baseurl}/rest/mirroring/latest/mirrorServers/{mirrorId}' \ --header 'Accept: application/json;charset=UTF-8' \ --header 'Content-Type: application/json' \ --data '{ "baseUrl": "https://bitbucket-eu.example.com:7990/bitbucket", "productVersion": "8.0.0" }'
DEL

Delete mirror by ID

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

Publish RepositoryMirrorEvent

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 project

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;charset=UTF-8

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

Get hashes for repositories in project

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;charset=UTF-8

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;charset=UTF-8'
GET

Get content hashes for repositories

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;charset=UTF-8

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

Get content hash for a repository

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;charset=UTF-8

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

Get mirrors for repository

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

Query parameters

preAuthorized

boolean

Responses

The mirrored repository descriptor

application/json;charset=UTF-8

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;charset=UTF-8'
GET

Get mirroring requests

Retrieves a mirroring request

Request

Query parameters

state

string

start

number

limit

number

Responses

A page of mirroring requests

application/json;charset=UTF-8

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

Create a mirroring request

Creates a new mirroring request

Request

Request bodyapplication/json

mirrorBaseUrl

string

mirrorId

string

mirrorName

string

mirrorType

string

productVersion

string

state

string

Responses

The created mirroring request

application/json;charset=UTF-8

RestMirroringRequest
POST/mirroring/latest/requests
1 2 3 4 5 6 7 8 9 10 11 12 curl --request POST \ --url 'http://{baseurl}/rest/mirroring/latest/requests' \ --header 'Accept: application/json;charset=UTF-8' \ --header 'Content-Type: application/json' \ --data '{ "mirrorBaseUrl": "https://bitbucket-eu.example.com:7990/bitbucket", "mirrorId": "4f0eb5fc-67fc-48f8-b4a7-87981f026c6a", "mirrorName": "Bitbucket Mirror", "mirrorType": "SINGLE", "productVersion": "8.0.0", "state": "PENDING" }'
GET

Get a mirroring request

Retrieves a mirroring request

Request

Path parameters

mirroringRequestId

string

Required

Responses

The mirroring request

application/json;charset=UTF-8

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

Delete a mirroring request

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

Accept a mirroring request

Accepts a mirroring request

Request

Path parameters

mirroringRequestId

string

Required

Responses

The accepted mirror server

application/json;charset=UTF-8

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;charset=UTF-8'
POST

Reject a mirroring request

Rejects a mirroring request

Request

Path parameters

mirroringRequestId

string

Required

Responses

The rejected mirror server

application/json;charset=UTF-8

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;charset=UTF-8'

Rate this page: