List Compliance Report Configurations

Get a list of all the compliance report configurations.

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:

  Field	Filter Condition	Description
  report_name	$contains	The substring in the name of the report to filter with. For example, "filter": "{"report_name":{"$contains":"name"}}"
  compliance_status	$eq	The compliance status of the report configuration to filter with. The possible values are "compliant" and "non_compliant". For example, "filter": "{"compliance_status":{"$eq":"compliant"}}"

  
  For more information about filtering, refer to the Filtering section of this guide.
  

Responses

• 200
• default

---

Success

application/api.clumio.report-compliance=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 uint32

  error_message string

  The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

Loading...