Skip to main content

Get Report Config

GET 
/report/:id

Returns the compliance report generation configuration with the specified ID. The response includes pass/fail counts for this ID.

Request​

Path Parameters

    id stringrequired

    Report ID

Responses​

success

Schema
    cloudType stringrequired

    Possible values: [aws, azure, gcp, alibaba_cloud, oci]

    Cloud type

    complianceStandardDeleted boolean

    Compliance Standard Deleted

    complianceStandardId uuid

    Compliance standard ID

    counts object

    Model for compliance aggregate count

    criticalSeverityFailed int64

    Number of critical-severity failures

    failed int64

    Failed

    highSeverityFailed int64

    Number of high-severity failures

    informationalSeverityFailed int64

    Number of informational-severity failures

    lowSeverityFailed int64

    Number of low-severity failures

    mediumSeverityFailed int64

    Number of medium-severity failures

    passed int64

    Passed

    total int64

    Total

    createdBy string

    User who created this report

    createdOn int64

    Report created on this timestamp

    id string

    Report ID

    lastModifiedBy string

    Last modified by

    lastModifiedOn int64

    Timestamp of last modification

    lastScheduled int64

    Timestamp of last generated report

    locale string

    Locale of caller (e.g. en_us, jp). Default is en_us.

    name stringrequired

    Report name

    nextSchedule int64

    Timestamp of next scheduled report

    status string

    Report generation status

    target object

    Model for report target

    accountGroups string[]

    List of cloud account groups

    accounts string[]

    List of cloud accounts

    complianceStandardIds string[]

    List of compliance Standard IDs

    compressionEnabled boolean

    Business unit detailed report compression enabled

    downloadNow boolean

    True = download now

    notificationTemplateId string

    Notification template id

    notifyTo string[]

    List of email addresses to receive notification

    regions string[]

    List of regions

    schedule string

    Recurring report schedule in RRULE format

    scheduleEnabled boolean

    Report scheduling enabled

    timeRange object required

    See the Time Range Model for details.

    oneOf
    relativeTimeType string

    Possible values: [BACKWARD, FORWARD]

    Direction in which to count time. Default = BACKWARD

    type string
    value objectrequired

    Model for RelativeTimeDuration

    amount int32

    Number of time units

    unit string

    Possible values: [minute, hour, day, week, month, year]

    Time unit

    totalInstanceCount int32

    Total number of reports for the report ID

    type string

    Possible values: [COMPLIANCE, RIS, INVENTORY_OVERVIEW, INVENTORY_DETAIL]

    Report type. Default is COMPLIANCE.

Loading...