Add Report Config V2

POST 
/v2/report

Creates a compliance report generation configuration based on the specified parameters. Report generation can be either one-time or recurring.

You can use the body parameters to specify whether the report is a one-time report or a recurring report. Specify a recurring report by providing a valid target.schedule body parameter.

Note: The complianceStandardIds parameter is not applicable to COMPLIANCE or RIS report types

Request

application/json; charset=UTF-8

Body

required

Model for report generation configuration

cloudType stringrequired

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

Cloud type

locale string

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

name stringrequired

Report name

target object

Model for base 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

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

type string

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

Report type. Default is COMPLIANCE.

Responses

200

successful operation

application/json; charset=UTF-8

Schema

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

RelativeTimeRangeConfigModel

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

AbsoluteTimeRangeConfigModel

type string

value objectrequired

Model for Time

endTime int64

End timestamp

startTime int64

Start timestamp

ToNowTimeRangeConfigModel

value string

Possible values: [MINUTE, HOUR, DAY, WEEK, MONTH, YEAR, EPOCH, LOGIN]

Time range object

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.

Example (from schema)

{
  "cloudType": "aws",
  "complianceStandardDeleted": true,
  "complianceStandardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "counts": {
    "criticalSeverityFailed": 0,
    "failed": 0,
    "highSeverityFailed": 0,
    "informationalSeverityFailed": 0,
    "lowSeverityFailed": 0,
    "mediumSeverityFailed": 0,
    "passed": 0,
    "total": 0
  },
  "createdBy": "string",
  "createdOn": 0,
  "id": "string",
  "lastModifiedBy": "string",
  "lastModifiedOn": 0,
  "lastScheduled": 0,
  "locale": "string",
  "name": "string",
  "nextSchedule": 0,
  "status": "string",
  "target": {
    "accountGroups": [
      "string"
    ],
    "accounts": [
      "string"
    ],
    "complianceStandardIds": [
      "string"
    ],
    "compressionEnabled": true,
    "downloadNow": true,
    "notificationTemplateId": "string",
    "notifyTo": [
      "string"
    ],
    "regions": [
      "string"
    ],
    "schedule": "string",
    "scheduleEnabled": true,
    "timeRange": {
      "relativeTimeType": "BACKWARD",
      "type": "relative",
      "value": {
        "amount": 0,
        "unit": "minute"
      }
    }
  },
  "totalInstanceCount": 0,
  "type": "COMPLIANCE"
}

400

missing_required_parameter / invalid_parameter_value

Loading...