WebService::BitbucketServer::MirroringUpstream::V1 - Bindings for a Bitbucket Server REST API
version 0.603
my $stash = WebService::BitbucketServer->new( base_url => 'https://stash.example.com/', username => 'bob', password => 'secret', ); my $api = $stash->mirroring_upstream;
This is a Bitbucket Server REST API for MirroringUpstream::V1.
Original API documentation created by and copyright Atlassian.
Get the instance of WebService::BitbucketServer passed to "new".
$api = WebService::BitbucketServer::MirroringUpstream::V1->new(context => $webservice_bitbucketserver_obj);
Create a new API.
Normally you would use $webservice_bitbucketserver_obj->mirroring_upstream instead.
$webservice_bitbucketserver_obj->mirroring_upstream
Sets the mirror specified by a mirror ID as the current user's preferred mirror
POST mirroring/1.0/account/settings/preferred-mirror
Responses:
204 - data, type: application/json
204
an empty response indicating that the user setting has been updated
404 - not-found, type: application/json
404
The mirror could not be found.
Retrieves the current user's preferred mirror server
GET mirroring/1.0/account/settings/preferred-mirror
200 - data, type: application/json
200
the preferred mirror server
The user's preferred mirror server could not be found.
Removes the current user's preferred mirror
DELETE mirroring/1.0/account/settings/preferred-mirror
GET mirroring/1.0/analyticsSettings
The analytics settings from upstream
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. Currently only username/password and SSH credentials are supported.
POST mirroring/1.0/authenticate
200 - user, type: application/json
The user for the supplied credentials and their effective permissions.
400 - errors, type: application/json
400
If the supplied credentials are incomplete or not understood.
401 - errors, type: application/json
401
The currently authenticated user is not permitted to authenticate on behalf of users or authentication with the supplied user credentials failed for some reason
Returns a list of mirrors
GET mirroring/1.0/mirrorServers
200 - page, type: unknown
a page of mirrors
Returns the mirror specified by a mirror ID
GET mirroring/1.0/mirrorServers/{mirrorId}
Parameters:
mirrorId - string, default: none
mirrorId
the ID of the mirror to remove
200 - mirror, type: application/json
the mirror
Removes a mirror, disabling all access and notifications for the mirror server in question
DELETE mirroring/1.0/mirrorServers/{mirrorId}
204 - data, type: unknown
an empty response indicating that the mirror has been removed
This renders the HTML that is needed to get the remote connect web-panel on the mirror.
GET mirroring/1.0/mirrorServers/{mirrorId}/webPanels/config
Returns a page of repositories enriched with a content hash
GET mirroring/1.0/repos
200 - page, type: application/json
A page of repositories with content hashes
409 - errors, type: application/json
409
Mirroring is not available
Returns a repository enriched with a content hash
GET mirroring/1.0/repos/{repoId}
repoId - int, default: none
repoId
the ID of the requested repository
200 - repository, type: application/json
The repository with the specified repoId
Repository not found
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.
GET mirroring/1.0/repos/{repoId}/mirrors
200 - repositoryDescriptor, type: application/json
The mirrored repository descriptor
Retrieves a mirroring request
GET mirroring/1.0/requests
state - string, default: none
state
(optional) the request state to filter on
A page of mirroring requests
Creates a new mirroring request
POST mirroring/1.0/requests
The created mirroring request
The request was invalid or missing
GET mirroring/1.0/requests/{mirroringRequestId}
mirroringRequestId - int, default: none
mirroringRequestId
the ID of the mirroring request to delete
The mirroring request
The request could not be found
Deletes a mirroring request
DELETE mirroring/1.0/requests/{mirroringRequestId}
The request was deleted
Accepts a mirroring request
POST mirroring/1.0/requests/{mirroringRequestId}/accept
the ID of the request to accept
The accepted mirror server
Rejects a mirroring request
POST mirroring/1.0/requests/{mirroringRequestId}/reject
the ID of the request to reject
The rejected mirroring request
WebService::BitbucketServer
https://developer.atlassian.com/bitbucket/server/docs/latest/
Please report any bugs or feature requests on the bugtracker website https://github.com/chazmcgarvey/WebService-BitbucketServer/issues
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
Charles McGarvey <chazmcgarvey@brokenzipper.com>
This software is copyright (c) 2017 by Charles McGarvey.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install WebService::BitbucketServer, copy and paste the appropriate command in to your terminal.
cpanm
cpanm WebService::BitbucketServer
CPAN shell
perl -MCPAN -e shell install WebService::BitbucketServer
For more information on module installation, please visit the detailed CPAN module installation guide.