The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
WebService-BitbucketServer-0.605
River stage zero No dependents
1 ++
/ WebService::BitbucketServer::Audit::V1

NAME

WebService::BitbucketServer::Audit::V1 - Bindings for a Bitbucket Server REST API

VERSION

version 0.605

SYNOPSIS

    my $stash = WebService::BitbucketServer->new(
        base_url    => 'https://stash.example.com/',
        username    => 'bob',
        password    => 'secret',
    );
    my $api = $stash->audit;

DESCRIPTION

This is a Bitbucket Server REST API for Audit::V1.

Original API documentation created by and copyright Atlassian.

ATTRIBUTES

context

Get the instance of WebService::BitbucketServer passed to "new".

METHODS

new

    $api = WebService::BitbucketServer::Audit::V1->new(context => $webservice_bitbucketserver_obj);

Create a new API.

Normally you would use $webservice_bitbucketserver_obj->audit instead.

get_events_for_project

Retrieve the audit events for this project. The list of events will match those shown in the UI, for a complete list of events please check the audit log file.

The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.

    GET audit/1.0/projects/{projectKey}/events

Responses:

  • 200 - page, type: application/json

    The audit events for this project

  • 401 - errors, type: application/json

    The currently authenticated user has insufficient permissions to administer the project.

  • 404 - errors, type: application/json

    The specified project does not exist.

get_events_for_repository

Retrieve the subset of audit events stored for this repository. The list of events will match those shown in the UI, for a complete list of events please check the audit log file.

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

    GET audit/1.0/projects/{projectKey}/repos/{repositorySlug}/events

Responses:

  • 200 - page, type: application/json

    The audit events for this repository

  • 401 - errors, type: application/json

    The currently authenticated user has insufficient permissions to administer the repository.

  • 404 - errors, type: application/json

    The specified repository does not exist.

SEE ALSO

BUGS

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.

AUTHOR

Charles McGarvey <chazmcgarvey@brokenzipper.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2018 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.