com.iland.core.web.rest.api

Interface OrgReportingResource

@Path(value="/orgs")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface OrgReportingResource

Org Reporting Resource V1.

Author:

Brett Snyder

Method Summary

Modifier and Type	Method and Description
TaskResponse	generateAntiMalwareReport(String orgUuid, Long start, Long end, String reportFormat, boolean emailOnCompletion, String email) Generate the anti-malware report for the given organization and time range.
TaskResponse	generateBillingReport(String orgUuid, BillingReportRequest billingReportSpec, boolean emailOnCompletion, String email) Generate the billing report for a given organization.
TaskResponse	generateContinuityProtectionReport(String orgUuid, String reportFormat, boolean emailOnCompletion, String email) Generate a continuity protection summary report for the given organization.
TaskResponse	generateDPIEventHistoryReport(String orgUuid, Long start, Long end, String reportFormat, boolean emailOnCompletion, String email) Generate the DPI event history report for the given organization and time range.
TaskResponse	generateEventHistoryReport(String orgUuid, Long start, Long end, String reportFormat, boolean emailOnCompletion, String email) Generate the ecs event history report for the given organization and time range.
TaskResponse	generateFirewallEventHistoryReport(String orgUuid, Long start, Long end, String reportFormat, boolean emailOnCompletion, String email) Generate the firewall event history report for the given organization and time range.
TaskResponse	generateHIPAAReport(String orgUuid, Long start, Long end, String reportFormat, boolean emailOnCompletion, String email) Generate the HIPAA report for the given organization and time range.
TaskResponse	generateIntegrityEventHistoryReport(String orgUuid, Long start, Long end, String reportFormat, boolean emailOnCompletion, String email) Generate the integrity event history report for the given organization and time range.
TaskResponse	generateLoginEventHistoryReport(String orgUuid, Long start, Long end, String reportFormat, boolean emailOnCompletion, String email) Generate the login event history report for the given organization and time range.
TaskResponse	generateLogInspectionReport(String orgUuid, Long start, Long end, String reportFormat, boolean emailOnCompletion, String email) Generate the log inspection report for the given organization and time range.
TaskResponse	generateSupportRequestReport(String orgUuid, Long start, Long end, String reportFormat, boolean emailOnCompletion, String email) Generate the support request history report for the given organization and time range.
TaskResponse	generateVmEncryptionReport(String orgUuid, String reportFormat, boolean emailOnCompletion, String email) Generate the VM encryption report for the given organization.
TaskResponse	generateVmInventoryReport(String orgUuid, boolean emailOnCompletion, String email) Generate the vm inventory report for a given organization.
TaskResponse	generateVulnerabilityReport(String orgUuid, String reportFormat, boolean emailOnCompletion, String email) Generate the vulnerability report for the given organization.
TaskResponse	generateWebReputationEventHistoryReport(String orgUuid, Long start, Long end, String reportFormat, boolean emailOnCompletion, String email) Generate the web reputation event history report for the given organization and time range.
ReportHeaderListResponse	getAntimalwareEventReports(String orgUuid, ReportFormat reportFormat, Boolean latest) Get the anti-malware reports available for download for the given organization.
AntimalwareOverTimeResponse	getAntimalwareOverTimeSerie(String orgUuid, Long start, Long end, Integer limit) Get the antimalware over time serie for the given organization and date range.
ReportHeaderListResponse	getBillingReports(String orgUuid, ReportFormat reportFormat, Boolean latest) Get the billing reports for the organization.
ReportHeaderListResponse	getCloudEventReports(String orgUuid, ReportFormat reportFormat, Boolean latest) Get the cloud event history reports available for download for the given organization.
ComplianceOverTimeResponse	getComplianceOverTimeSerie(String orgUuid, ComplianceOverTimeResponse.SerieType type, Long start, Long end, Integer limit) Get the compliance over time serie for the given organization and serie name.
ReportHeaderListResponse	getContinuityProtectionReports(String orgUuid, ReportFormat reportFormat, Boolean latest) Get the continuity protection reports for the organization.
EventCountResponse	getCount(String orgUuid, String reportType, Long start, Long end) Get the number of events for the given organization, date range, and report type.
ReportHeaderListResponse	getDPIEventReports(String orgUuid, ReportFormat reportFormat, Boolean latest) Get the DPI event reports available for download for the given organization.
ReportHeaderListResponse	getFirewallEventReports(String orgUuid, ReportFormat reportFormat, Boolean latest) Get the firewall event reports available for download for the given organization.
FirewallOverTimeResponse	getFirewallOverTimeSerie(String orgUuid, Long start, Long end, Integer limit) Get the firewall over time serie for the given organization and date range.
ReportHeaderListResponse	getHIPAAReports(String orgUuid, ReportFormat reportFormat, Boolean latest) Get the HIPAA reports available for download for the given organization.
ReportHeaderListResponse	getIntegrityEventReports(String orgUuid, ReportFormat reportFormat, Boolean latest) Get the integrity event reports available for download for the given organization.
ReportHeaderListResponse	getLoginEventReports(String orgUuid, ReportFormat reportFormat, Boolean latest) Get the login event history reports available for download for the given organization.
ReportHeaderListResponse	getLogInspectionEventReports(String orgUuid, ReportFormat reportFormat, Boolean latest) Get the log inspection reports available for download for the given organization.
LogInspectionOverTimeResponse	getLogInspectionOverTimeSerie(String orgUuid, Long start, Long end, Integer limit) Get the log inspection over time serie for the given organization and date range.
ReportHeaderListResponse	getSupportRequestReports(String orgUuid, ReportFormat reportFormat, Boolean latest) Get the support request reports available for download for the given organization.
ReportHeaderListResponse	getVMEncryptionReports(String orgUuid, ReportFormat reportFormat, Boolean latest) Get the VM encryption reports available for download for the given organization.
ReportHeaderListResponse	getVmInventoryReports(String orgUuid, ReportFormat reportFormat, Boolean latest) Get the VM inventory reports for the organization.
VulnerabilityOverTimeResponse	getVulnerabilityOverTimeSerie(String orgUuid, Long start, Long end, Integer limit) Get the vulnerability over time serie for the given organization and date range.
ReportHeaderListResponse	getVulnerabilityReports(String orgUuid, ReportFormat reportFormat, Boolean latest) Get the vulnerability reports available for download for the given organization.
ReportHeaderListResponse	getWebReputationEventReports(String orgUuid, ReportFormat reportFormat, Boolean latest) Get the web reputation event reports available for download for the given organization.

Method Detail

generateVulnerabilityReport

@POST
 @Path(value="/{orgUuid}/actions/generate-vulnerability-report")
TaskResponse generateVulnerabilityReport(@PathParam(value="orgUuid")
                                                                                                                String orgUuid,
                                                                                                                @QueryParam(value="format")
                                                                                                                String reportFormat,
                                                                                                                @QueryParam(value="emailOnCompletion")
                                                                                                                boolean emailOnCompletion,
                                                                                                                @QueryParam(value="email")
                                                                                                                String email)

Generate the vulnerability report for the given organization.

Default format is pdf if format is unspecified

Parameters:

orgUuid - organization uuid

reportFormat - report format ('pdf' or 'html')

emailOnCompletion - whether to email the report upon successful generation

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

asynchronous task

generateAntiMalwareReport

@POST
 @Path(value="/{orgUuid}/actions/generate-antimalware-report")
TaskResponse generateAntiMalwareReport(@PathParam(value="orgUuid")
                                                                                                            String orgUuid,
                                                                                                            @QueryParam(value="start")
                                                                                                            Long start,
                                                                                                            @QueryParam(value="end")
                                                                                                            Long end,
                                                                                                            @QueryParam(value="format")
                                                                                                            String reportFormat,
                                                                                                            @QueryParam(value="emailOnCompletion")
                                                                                                            boolean emailOnCompletion,
                                                                                                            @QueryParam(value="email")
                                                                                                            String email)

Generate the anti-malware report for the given organization and time range.

Default format is pdf if format is unspecified

Parameters:

orgUuid - organization uuid

start - start

end - end

reportFormat - report format ('pdf' or 'html')

emailOnCompletion - whether to email the report upon successful generation

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

asynchronous task

generateLogInspectionReport

@POST
 @Path(value="/{orgUuid}/actions/generate-log-inspection-report")
TaskResponse generateLogInspectionReport(@PathParam(value="orgUuid")
                                                                                                                 String orgUuid,
                                                                                                                 @QueryParam(value="start")
                                                                                                                 Long start,
                                                                                                                 @QueryParam(value="end")
                                                                                                                 Long end,
                                                                                                                 @QueryParam(value="format")
                                                                                                                 String reportFormat,
                                                                                                                 @QueryParam(value="emailOnCompletion")
                                                                                                                 boolean emailOnCompletion,
                                                                                                                 @QueryParam(value="email")
                                                                                                                 String email)

Generate the log inspection report for the given organization and time range.

Default format is pdf if format is unspecified

Parameters:

orgUuid - organization uuid

start - start

end - end

reportFormat - report format ('pdf' or 'html')

emailOnCompletion - whether to email the report upon successful generation

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

asynchronous task

generateEventHistoryReport

@POST
 @Path(value="/{orgUuid}/actions/generate-event-history-report")
TaskResponse generateEventHistoryReport(@PathParam(value="orgUuid")
                                                                                                               String orgUuid,
                                                                                                               @QueryParam(value="start")
                                                                                                               Long start,
                                                                                                               @QueryParam(value="end")
                                                                                                               Long end,
                                                                                                               @QueryParam(value="format")
                                                                                                               String reportFormat,
                                                                                                               @QueryParam(value="emailOnCompletion")
                                                                                                               boolean emailOnCompletion,
                                                                                                               @QueryParam(value="email")
                                                                                                               String email)

Generate the ecs event history report for the given organization and time range.

Default format is pdf if format is unspecified

Parameters:

orgUuid - organization uuid

start - start

end - end

reportFormat - report format ('pdf' or 'html')

emailOnCompletion - whether to email the report upon successful generation

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

asynchronous task

generateSupportRequestReport

@POST
 @Path(value="/{orgUuid}/actions/generate-support-request-report")
TaskResponse generateSupportRequestReport(@PathParam(value="orgUuid")
                                                                                                                   String orgUuid,
                                                                                                                   @QueryParam(value="start")
                                                                                                                   Long start,
                                                                                                                   @QueryParam(value="end")
                                                                                                                   Long end,
                                                                                                                   @QueryParam(value="format")
                                                                                                                   String reportFormat,
                                                                                                                   @QueryParam(value="emailOnCompletion")
                                                                                                                   boolean emailOnCompletion,
                                                                                                                   @QueryParam(value="email")
                                                                                                                   String email)

Generate the support request history report for the given organization and time range.

Default format is pdf if format is unspecified

Parameters:

orgUuid - organization uuid

start - start

end - end

reportFormat - report format ('pdf' or 'html')

emailOnCompletion - whether to email the report upon successful generation

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

asynchronous task

generateLoginEventHistoryReport

@POST
 @Path(value="/{orgUuid}/actions/generate-login-event-report")
TaskResponse generateLoginEventHistoryReport(@PathParam(value="orgUuid")
                                                                                                                  String orgUuid,
                                                                                                                  @QueryParam(value="start")
                                                                                                                  Long start,
                                                                                                                  @QueryParam(value="end")
                                                                                                                  Long end,
                                                                                                                  @QueryParam(value="format")
                                                                                                                  String reportFormat,
                                                                                                                  @QueryParam(value="emailOnCompletion")
                                                                                                                  boolean emailOnCompletion,
                                                                                                                  @QueryParam(value="email")
                                                                                                                  String email)

Generate the login event history report for the given organization and time range.

There is a limit of 1 month duration for requesting login events and if no query params are provided for the time range it will fall back on the past week.

Default format is pdf if format is unspecified.

Parameters:

orgUuid - organization uuid

start - start

end - end

reportFormat - report format ('pdf' or 'html')

emailOnCompletion - whether to email the report upon successful generation

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

asynchronous task

generateFirewallEventHistoryReport

@POST
 @Path(value="/{orgUuid}/actions/generate-firewall-event-report")
TaskResponse generateFirewallEventHistoryReport(@PathParam(value="orgUuid")
                                                                                                                        String orgUuid,
                                                                                                                        @QueryParam(value="start")
                                                                                                                        Long start,
                                                                                                                        @QueryParam(value="end")
                                                                                                                        Long end,
                                                                                                                        @QueryParam(value="format")
                                                                                                                        String reportFormat,
                                                                                                                        @QueryParam(value="emailOnCompletion")
                                                                                                                        boolean emailOnCompletion,
                                                                                                                        @QueryParam(value="email")
                                                                                                                        String email)

Generate the firewall event history report for the given organization and time range.

Default format is pdf if format is unspecified

Parameters:

orgUuid - organization uuid

start - start

end - end

reportFormat - report format ('pdf' or 'html')

emailOnCompletion - whether to email the report upon successful generation

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

asynchronous task

generateIntegrityEventHistoryReport

@POST
 @Path(value="/{orgUuid}/actions/generate-integrity-event-report")
TaskResponse generateIntegrityEventHistoryReport(@PathParam(value="orgUuid")
                                                                                                                          String orgUuid,
                                                                                                                          @QueryParam(value="start")
                                                                                                                          Long start,
                                                                                                                          @QueryParam(value="end")
                                                                                                                          Long end,
                                                                                                                          @QueryParam(value="format")
                                                                                                                          String reportFormat,
                                                                                                                          @QueryParam(value="emailOnCompletion")
                                                                                                                          boolean emailOnCompletion,
                                                                                                                          @QueryParam(value="email")
                                                                                                                          String email)

Generate the integrity event history report for the given organization and time range.

Default format is pdf if format is unspecified

Parameters:

orgUuid - organization uuid

start - start

end - end

reportFormat - report format ('pdf' or 'html')

emailOnCompletion - whether to email the report upon successful generation

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

asynchronous task

generateDPIEventHistoryReport

@POST
 @Path(value="/{orgUuid}/actions/generate-dpi-event-report")
TaskResponse generateDPIEventHistoryReport(@PathParam(value="orgUuid")
                                                                                                              String orgUuid,
                                                                                                              @QueryParam(value="start")
                                                                                                              Long start,
                                                                                                              @QueryParam(value="end")
                                                                                                              Long end,
                                                                                                              @QueryParam(value="format")
                                                                                                              String reportFormat,
                                                                                                              @QueryParam(value="emailOnCompletion")
                                                                                                              boolean emailOnCompletion,
                                                                                                              @QueryParam(value="email")
                                                                                                              String email)

Generate the DPI event history report for the given organization and time range.

Default format is pdf if format is unspecified

Parameters:

orgUuid - organization uuid

start - start

end - end

reportFormat - report format ('pdf' or 'html')

emailOnCompletion - whether to email the report upon successful generation

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

asynchronous task

generateContinuityProtectionReport

@POST
 @Path(value="/{orgUuid}/actions/generate-continuity-protection-report")
TaskResponse generateContinuityProtectionReport(@PathParam(value="orgUuid")
                                                                                                                               String orgUuid,
                                                                                                                               @QueryParam(value="format")
                                                                                                                               String reportFormat,
                                                                                                                               @QueryParam(value="emailOnCompletion")
                                                                                                                               boolean emailOnCompletion,
                                                                                                                               @QueryParam(value="email")
                                                                                                                               String email)

Generate a continuity protection summary report for the given organization.

Parameters:

orgUuid - organization uuid

reportFormat - report format ('pdf' or 'html')

emailOnCompletion - whether to email the report upon successful generation

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

asynchronous task

generateWebReputationEventHistoryReport

@POST
 @Path(value="/{orgUuid}/actions/generate-web-reputation-event-report")
TaskResponse generateWebReputationEventHistoryReport(@PathParam(value="orgUuid")
                                                                                                                                   String orgUuid,
                                                                                                                                   @QueryParam(value="start")
                                                                                                                                   Long start,
                                                                                                                                   @QueryParam(value="end")
                                                                                                                                   Long end,
                                                                                                                                   @QueryParam(value="format")
                                                                                                                                   String reportFormat,
                                                                                                                                   @QueryParam(value="emailOnCompletion")
                                                                                                                                   boolean emailOnCompletion,
                                                                                                                                   @QueryParam(value="email")
                                                                                                                                   String email)

Generate the web reputation event history report for the given organization and time range.

Default format is pdf if format is unspecified

Parameters:

orgUuid - organization uuid

start - start

end - end

reportFormat - report format ('pdf' or 'html')

emailOnCompletion - whether to email the report upon successful generation

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

asynchronous task

generateVmEncryptionReport

@POST
 @Path(value="/{orgUuid}/actions/generate-vm-encryption-report")
TaskResponse generateVmEncryptionReport(@PathParam(value="orgUuid")
                                                                                                               String orgUuid,
                                                                                                               @QueryParam(value="format")
                                                                                                               String reportFormat,
                                                                                                               @QueryParam(value="emailOnCompletion")
                                                                                                               boolean emailOnCompletion,
                                                                                                               @QueryParam(value="email")
                                                                                                               String email)

Generate the VM encryption report for the given organization.

Default format is pdf if format is unspecified

Parameters:

orgUuid - organization uuid

reportFormat - report format ('pdf' or 'html')

emailOnCompletion - whether to email the report upon successful generation

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

asynchronous task

generateHIPAAReport

@POST
 @Path(value="/{orgUuid}/actions/generate-hipaa-report")
TaskResponse generateHIPAAReport(@PathParam(value="orgUuid")
                                                                                                String orgUuid,
                                                                                                @QueryParam(value="start")
                                                                                                Long start,
                                                                                                @QueryParam(value="end")
                                                                                                Long end,
                                                                                                @QueryParam(value="format")
                                                                                                String reportFormat,
                                                                                                @QueryParam(value="emailOnCompletion")
                                                                                                boolean emailOnCompletion,
                                                                                                @QueryParam(value="email")
                                                                                                String email)

Generate the HIPAA report for the given organization and time range.

Default format is pdf if format is unspecified

Parameters:

orgUuid - organization uuid

start - start

end - end

reportFormat - report format ('pdf' or 'html')

emailOnCompletion - whether to email the report upon successful generation

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

asynchronous task

generateBillingReport

@POST
 @Path(value="/{orgUuid}/actions/generate-billing-report")
 @Consumes(value="application/json")
TaskResponse generateBillingReport(@PathParam(value="orgUuid")
                                                                                                                                         String orgUuid,
                                                                                                                                         BillingReportRequest billingReportSpec,
                                                                                                                                         @QueryParam(value="emailOnCompletion")
                                                                                                                                         boolean emailOnCompletion,
                                                                                                                                         @QueryParam(value="email")
                                                                                                                                         String email)

Generate the billing report for a given organization.

Only available as report type of 'csv'.

Parameters:

orgUuid - String org uuid

billingReportSpec - BillingReportRequest billing report

emailOnCompletion - whether to email the report upon successful generation, superseded by BillingReportSpec's email property

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

TaskResponse asynchronous task

generateVmInventoryReport

@POST
 @Path(value="/{orgUuid}/actions/generate-vm-inventory-report")
TaskResponse generateVmInventoryReport(@PathParam(value="orgUuid")
                                                                                                             String orgUuid,
                                                                                                             @QueryParam(value="emailOnCompletion")
                                                                                                             boolean emailOnCompletion,
                                                                                                             @QueryParam(value="email")
                                                                                                             String email)

Generate the vm inventory report for a given organization.

Only available as report type of 'csv'.

Parameters:

orgUuid - String org uuid

emailOnCompletion - whether to email the report upon successful generation, superseded by BillingReportSpec's email property

email - email address to send the report to if emailOnCompletion is true, defaults to the user's profile email if not specified

Returns:

TaskResponse asynchronous task

getContinuityProtectionReports

@GET
 @Path(value="/{orgUuid}/continuity-protection-reports")
ReportHeaderListResponse getContinuityProtectionReports(@PathParam(value="orgUuid")
                                                                                                                      String orgUuid,
                                                                                                                      @QueryParam(value="format")
                                                                                                                      ReportFormat reportFormat,
                                                                                                                      @QueryParam(value="latest")
                                                                                                                      Boolean latest)

Get the continuity protection reports for the organization.

The endpoint also supports filtering by report format, using the query param "format".

Parameters:

orgUuid - organization UUID

Returns:

list of reports available for download

getBillingReports

@GET
 @Path(value="/{orgUuid}/billing-reports")
ReportHeaderListResponse getBillingReports(@PathParam(value="orgUuid")
                                                                                           String orgUuid,
                                                                                           @QueryParam(value="format")
                                                                                           ReportFormat reportFormat,
                                                                                           @QueryParam(value="latest")
                                                                                           Boolean latest)

Get the billing reports for the organization.

The endpoint also supports filtering by report format, using the query param "format".

Parameters:

orgUuid - organization UUID

Returns:

list of reports available for download

getVmInventoryReports

@GET
 @Path(value="/{orgUuid}/vm-inventory-reports")
ReportHeaderListResponse getVmInventoryReports(@PathParam(value="orgUuid")
                                                                                                    String orgUuid,
                                                                                                    @QueryParam(value="format")
                                                                                                    ReportFormat reportFormat,
                                                                                                    @QueryParam(value="latest")
                                                                                                    Boolean latest)

Get the VM inventory reports for the organization.

The endpoint also supports filtering by report format, using the query param "format".

Parameters:

orgUuid - organization UUID

Returns:

list of reports available for download

getSupportRequestReports

@GET
 @Path(value="/{orgUuid}/support-request-reports")
ReportHeaderListResponse getSupportRequestReports(@PathParam(value="orgUuid")
                                                                                                          String orgUuid,
                                                                                                          @QueryParam(value="format")
                                                                                                          ReportFormat reportFormat,
                                                                                                          @QueryParam(value="latest")
                                                                                                          Boolean latest)

Get the support request reports available for download for the given organization.

The endpoint also supports filtering by report format, using the query param "format".

Parameters:

orgUuid - organization uuid

Returns:

list of reports available for download

getCloudEventReports

@GET
 @Path(value="/{orgUuid}/cloud-event-reports")
ReportHeaderListResponse getCloudEventReports(@PathParam(value="orgUuid")
                                                                                                  String orgUuid,
                                                                                                  @QueryParam(value="format")
                                                                                                  ReportFormat reportFormat,
                                                                                                  @QueryParam(value="latest")
                                                                                                  Boolean latest)

Get the cloud event history reports available for download for the given organization.

The endpoint also supports filtering by report format, using the query param "format".

Parameters:

orgUuid - organization uuid

Returns:

list of reports available for download

getLoginEventReports

@GET
 @Path(value="/{orgUuid}/login-event-reports")
ReportHeaderListResponse getLoginEventReports(@PathParam(value="orgUuid")
                                                                                                  String orgUuid,
                                                                                                  @QueryParam(value="format")
                                                                                                  ReportFormat reportFormat,
                                                                                                  @QueryParam(value="latest")
                                                                                                  Boolean latest)

Get the login event history reports available for download for the given organization.

The endpoint also supports filtering by report format, using the query param "format".

Parameters:

orgUuid - organization uuid

Returns:

list of reports available for download

getVMEncryptionReports

@GET
 @Path(value="/{orgUuid}/vm-encryption-reports")
ReportHeaderListResponse getVMEncryptionReports(@PathParam(value="orgUuid")
                                                                                                      String orgUuid,
                                                                                                      @QueryParam(value="format")
                                                                                                      ReportFormat reportFormat,
                                                                                                      @QueryParam(value="latest")
                                                                                                      Boolean latest)

Get the VM encryption reports available for download for the given organization.

The endpoint also supports filtering by report format, using the query param "format".

Parameters:

orgUuid - organization uuid

Returns:

list of reports available for download

getHIPAAReports

@GET
 @Path(value="/{orgUuid}/hipaa-reports")
ReportHeaderListResponse getHIPAAReports(@PathParam(value="orgUuid")
                                                                                       String orgUuid,
                                                                                       @QueryParam(value="format")
                                                                                       ReportFormat reportFormat,
                                                                                       @QueryParam(value="latest")
                                                                                       Boolean latest)

Get the HIPAA reports available for download for the given organization.

The endpoint also supports filtering by report format, using the query param "format".

Parameters:

orgUuid - organization uuid

Returns:

list of reports available for download

getWebReputationEventReports

@GET
 @Path(value="/{orgUuid}/web-reputation-event-reports")
ReportHeaderListResponse getWebReputationEventReports(@PathParam(value="orgUuid")
                                                                                                                   String orgUuid,
                                                                                                                   @QueryParam(value="format")
                                                                                                                   ReportFormat reportFormat,
                                                                                                                   @QueryParam(value="latest")
                                                                                                                   Boolean latest)

Get the web reputation event reports available for download for the given organization.

The endpoint also supports filtering by report format, using the query param "format".

Parameters:

orgUuid - organization uuid

Returns:

list of reports available for download

getDPIEventReports

@GET
 @Path(value="/{orgUuid}/dpi-event-reports")
ReportHeaderListResponse getDPIEventReports(@PathParam(value="orgUuid")
                                                                                              String orgUuid,
                                                                                              @QueryParam(value="format")
                                                                                              ReportFormat reportFormat,
                                                                                              @QueryParam(value="latest")
                                                                                              Boolean latest)

Get the DPI event reports available for download for the given organization.

The endpoint also supports filtering by report format, using the query param "format".

Parameters:

orgUuid - organization uuid

Returns:

list of reports available for download

getIntegrityEventReports

@GET
 @Path(value="/{orgUuid}/integrity-event-reports")
ReportHeaderListResponse getIntegrityEventReports(@PathParam(value="orgUuid")
                                                                                                          String orgUuid,
                                                                                                          @QueryParam(value="format")
                                                                                                          ReportFormat reportFormat,
                                                                                                          @QueryParam(value="latest")
                                                                                                          Boolean latest)

Get the integrity event reports available for download for the given organization.

The endpoint also supports filtering by report format, using the query param "format".

Parameters:

orgUuid - organization uuid

Returns:

list of reports available for download

getFirewallEventReports

@GET
 @Path(value="/{orgUuid}/firewall-event-reports")
ReportHeaderListResponse getFirewallEventReports(@PathParam(value="orgUuid")
                                                                                                        String orgUuid,
                                                                                                        @QueryParam(value="format")
                                                                                                        ReportFormat reportFormat,
                                                                                                        @QueryParam(value="latest")
                                                                                                        Boolean latest)

Get the firewall event reports available for download for the given organization.

The endpoint also supports filtering by report format, using the query param "format".

Parameters:

orgUuid - organization uuid

Returns:

list of reports available for download

getLogInspectionEventReports

@GET
 @Path(value="/{orgUuid}/log-inspection-event-reports")
ReportHeaderListResponse getLogInspectionEventReports(@PathParam(value="orgUuid")
                                                                                                                   String orgUuid,
                                                                                                                   @QueryParam(value="format")
                                                                                                                   ReportFormat reportFormat,
                                                                                                                   @QueryParam(value="latest")
                                                                                                                   Boolean latest)

Get the log inspection reports available for download for the given organization.

The endpoint also supports filtering by report format, using the query param "format".

Parameters:

orgUuid - organization uuid

Returns:

list of reports available for download

getAntimalwareEventReports

@GET
 @Path(value="/{orgUuid}/anti-malware-event-reports")
ReportHeaderListResponse getAntimalwareEventReports(@PathParam(value="orgUuid")
                                                                                                               String orgUuid,
                                                                                                               @QueryParam(value="format")
                                                                                                               ReportFormat reportFormat,
                                                                                                               @QueryParam(value="latest")
                                                                                                               Boolean latest)

Get the anti-malware reports available for download for the given organization.

The endpoint also supports filtering by report format, using the query param "format".

Parameters:

orgUuid - organization uuid

Returns:

list of reports available for download

getVulnerabilityReports

@GET
 @Path(value="/{orgUuid}/vulnerability-reports")
ReportHeaderListResponse getVulnerabilityReports(@PathParam(value="orgUuid")
                                                                                                       String orgUuid,
                                                                                                       @QueryParam(value="format")
                                                                                                       ReportFormat reportFormat,
                                                                                                       @QueryParam(value="latest")
                                                                                                       Boolean latest)

Get the vulnerability reports available for download for the given organization.

The endpoint also supports filtering by report format, using the query param "format".

Parameters:

orgUuid - organization uuid

Returns:

list of reports available for download

getComplianceOverTimeSerie

@GET
 @Path(value="/{orgUuid}/compliance-over-time")
ComplianceOverTimeResponse getComplianceOverTimeSerie(@PathParam(value="orgUuid")
                                                                                                           String orgUuid,
                                                                                                           @QueryParam(value="type")
                                                                                                           ComplianceOverTimeResponse.SerieType type,
                                                                                                           @QueryParam(value="start")
                                                                                                           Long start,
                                                                                                           @QueryParam(value="end")
                                                                                                           Long end,
                                                                                                           @QueryParam(value="limit")
                                                                                                           Integer limit)

Get the compliance over time serie for the given organization and serie name.

The default timeframe is the past month if no start and end query params are provided.

Parameters:

orgUuid - organization uuid

type - type of the compliance over time serie

start - start date (defaults to one month prior to end param)

end - end date (defaults to current time if not provided)

limit - limit on numer of samples to return (defaults to 60)

Returns:

the compliance over time serie

getVulnerabilityOverTimeSerie

@GET
 @Path(value="/{orgUuid}/vulnerability-over-time")
VulnerabilityOverTimeResponse getVulnerabilityOverTimeSerie(@PathParam(value="orgUuid")
                                                                                                                    String orgUuid,
                                                                                                                    @QueryParam(value="start")
                                                                                                                    Long start,
                                                                                                                    @QueryParam(value="end")
                                                                                                                    Long end,
                                                                                                                    @QueryParam(value="limit")
                                                                                                                    Integer limit)

Get the vulnerability over time serie for the given organization and date range.

The default timeframe is the past month if no start and end query params are provided.

Parameters:

orgUuid - organization uuid

start - start date (defaults to Jan 1, 1970)

end - end date (defaults to current time if not provided)

limit - limit on numer of samples to return (defaults to 730)

Returns:

the vulnerability over time serie

getAntimalwareOverTimeSerie

@GET
 @Path(value="/{orgUuid}/anti-malware-over-time")
AntimalwareOverTimeResponse getAntimalwareOverTimeSerie(@PathParam(value="orgUuid")
                                                                                                               String orgUuid,
                                                                                                               @QueryParam(value="start")
                                                                                                               Long start,
                                                                                                               @QueryParam(value="end")
                                                                                                               Long end,
                                                                                                               @QueryParam(value="limit")
                                                                                                               Integer limit)

Get the antimalware over time serie for the given organization and date range.

The default timeframe is the past month if no start and end query params are provided.

Parameters:

orgUuid - organization uuid

start - start date (defaults to Jan 1, 1970)

end - end date (defaults to current time if not provided)

limit - limit on numer of samples to return (defaults to 730)

Returns:

the antimalware over time serie

getLogInspectionOverTimeSerie

@GET
 @Path(value="/{orgUuid}/log-inspection-over-time")
LogInspectionOverTimeResponse getLogInspectionOverTimeSerie(@PathParam(value="orgUuid")
                                                                                                                     String orgUuid,
                                                                                                                     @QueryParam(value="start")
                                                                                                                     Long start,
                                                                                                                     @QueryParam(value="end")
                                                                                                                     Long end,
                                                                                                                     @QueryParam(value="limit")
                                                                                                                     Integer limit)

Get the log inspection over time serie for the given organization and date range.

The default timeframe is the past month if no start and end query params are provided.

Parameters:

orgUuid - organization uuid

start - start date (defaults to Jan 1, 1970)

end - end date (defaults to current time if not provided)

limit - limit on numer of samples to return (defaults to 730)

Returns:

the log inspection over time serie

getFirewallOverTimeSerie

@GET
 @Path(value="/{orgUuid}/firewall-over-time")
FirewallOverTimeResponse getFirewallOverTimeSerie(@PathParam(value="orgUuid")
                                                                                                     String orgUuid,
                                                                                                     @QueryParam(value="start")
                                                                                                     Long start,
                                                                                                     @QueryParam(value="end")
                                                                                                     Long end,
                                                                                                     @QueryParam(value="limit")
                                                                                                     Integer limit)

Get the firewall over time serie for the given organization and date range.

The default timeframe is the past month if no start and end query params are provided.

Parameters:

orgUuid - organization uuid

start - start date (defaults to Jan 1, 1970)

end - end date (defaults to current time if not provided)

limit - limit on numer of samples to return (defaults to 730)

Returns:

the firewall over time serie

getCount

@GET
 @Path(value="/{orgUuid}/report-count")
EventCountResponse getCount(@PathParam(value="orgUuid")
                                                                         String orgUuid,
                                                                         @QueryParam(value="reportType")
                                                                         String reportType,
                                                                         @QueryParam(value="start")
                                                                         Long start,
                                                                         @QueryParam(value="end")
                                                                         Long end)

Get the number of events for the given organization, date range, and report type.

Date range limited to 24 hours. If dates not specified then range is set to last 24 hours.

Parameters:

orgUuid - organization uuid

reportType - type of report to filter on

start - start date (defaults to yesterday)

end - end date (defaults to today)