Skip to content

flywheel.api.audit_trail_api

AuditTrailApi

Bases: object

add_audit_trail_report(body, **kwargs)

Starts generation of an Audit Trail Report

Start generation of a new Audit Trail Report. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
body CoreModelsAuditTrailCreateReportInput
required
async_ (bool, optional)

Perform the request asynchronously

required

add_audit_trail_report_with_http_info(body, **kwargs)

Starts generation of an Audit Trail Report

Start generation of a new Audit Trail Report. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
body CoreModelsAuditTrailCreateReportInput
required
async_ (bool, optional)

Perform the request asynchronously

required

delete_audit_trail_report(report_id, **kwargs)

Deletes an Audit Trail Report

Delete an Audit Trail Report This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
report_id str
required
async_ (bool, optional)

Perform the request asynchronously

required

delete_audit_trail_report_with_http_info(report_id, **kwargs)

Deletes an Audit Trail Report

Delete an Audit Trail Report This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
report_id str
required
async_ (bool, optional)

Perform the request asynchronously

required

download_audit_trail_report(report_id, **kwargs)

Download Audit Trail Report

Download Audit Trail Reports This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
report_id str
required
async_ (bool, optional)

Perform the request asynchronously

required

download_audit_trail_report_with_http_info(report_id, **kwargs)

Download Audit Trail Report

Download Audit Trail Reports This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
report_id str
required
async_ (bool, optional)

Perform the request asynchronously

required

list_audit_trail_reports(**kwargs)

List Audit Trail Reports

List Audit Trail Reports. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
filter (str, optional)

Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22)

required
sort (str, optional)

The sort fields and order. (e.g. label:asc,created:desc)

required
limit (int, optional)

The maximum number of entries to return.

required
skip (int, optional)

The number of entries to skip., defaults to 0

required
page (int, optional)

The page number (i.e. skip limit*page entries)

required
after_id (str, optional)

Paginate after the given id. (Cannot be used with sort, page or skip)

required
x_accept_feature (list[union[HeaderFeature, str]], optional)

, defaults to []

required
async_ (bool, optional)

Perform the request asynchronously

required

list_audit_trail_reports_with_http_info(**kwargs)

List Audit Trail Reports

List Audit Trail Reports. This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
filter (str, optional)

Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22)

required
sort (str, optional)

The sort fields and order. (e.g. label:asc,created:desc)

required
limit (int, optional)

The maximum number of entries to return.

required
skip (int, optional)

The number of entries to skip., defaults to 0

required
page (int, optional)

The page number (i.e. skip limit*page entries)

required
after_id (str, optional)

Paginate after the given id. (Cannot be used with sort, page or skip)

required
x_accept_feature (list[union[HeaderFeature, str]], optional)

, defaults to []

required
async_ (bool, optional)

Perform the request asynchronously

required

modify_audit_trail_report(report_id, body, **kwargs)

Modify an Audit Trail Report

Modify an Audit Trail Report This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
report_id str
required
body CoreModelsAuditTrailModifyReportInput
required
async_ (bool, optional)

Perform the request asynchronously

required

modify_audit_trail_report_with_http_info(report_id, body, **kwargs)

Modify an Audit Trail Report

Modify an Audit Trail Report This method makes a synchronous HTTP request by default.

Parameters:

Name Type Description Default
report_id str
required
body CoreModelsAuditTrailModifyReportInput
required
async_ (bool, optional)

Perform the request asynchronously

required