List Compliance Report Run
Get a list of all the compliance report runs belonging to the configuration.
Path Parameters
- configuration_id string required
Performs the operation on the compliance report configuration with the specified ID.
Query Parameters
- limit int64
Limits the size of the response on each page to the specified number of items.
- start string
Sets the page token used to browse the collection. Leave this parameter empty to get the first page.
- filter string
Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:
For more information about filtering, refer to the Filtering section of this guide.Field Filter Condition Description status $in The generation status of the report configuration to filter with. The possible values are "completed", "failed" and "generating". For example, "filter": "{"status":{"$in":["completed"]}}"
.compliance_status $in The compliance status of the report run to filter with. The possible values are "compliant" and "non_compliant". For example, "filter": "{"compliance_status":{"$in":["compliant"]}}"
.
- 200
- default
Success
- application/api.clumio.report-compliance-runs=v1+json
- Schema
- Example (from schema)
Schema
- current_count int64
The number of items listed on the current page.
- filter_applied string
The filter used in the request. The filter includes both manually-specified and system-generated filters.
- limit int64
The maximum number of items displayed per page in the response.
- start string
The page token used to get this response.
{
"current_count": 0,
"filter_applied": "string",
"limit": 0,
"start": "string"
}
Error
- application/json
- Schema
- Example (from schema)
Schema
errors object[]
A list of errors encountered during runtime.
error_code uint32error_message stringThe reason for the error.
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}