Get Compliance Statistics for Requirement ID - POST

POST 
/compliance/posture/:complianceId/:requirementId

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Returns a breakdown of the passed/failed statistics and associated policies for compliance sections for the specified compliance standard ID and compliance requirement ID.

info

Replacement  Endpoint: Get Compliance Statistics for Requirement ID V2 - POST

The fields body parameter allows you to request specific fields. These fields are separate from the filters you specify. The following are valid fields items.

• cloud.account
• account.group
• cloud.region
• cloud.type
• policy.complianceStandard
• policy.complianceRequirement
• policy.complianceSection

The filters body parameter enables you to narrow your request for alerts. See Get Compliance Overview Filters and Options for for an API request to list all the valid filters.

note

This endpoint will only be able to access data from the past 1 year. This change is implemented to optimize system performance and reduce data storage requirements of deprecated endpoints.

Request

Path Parameters

complianceId uuidrequired

Compliance standard ID

requirementId uuidrequired

Compliance requirement ID

application/json

Body

detailed boolean

Detailed

fields string[]

Array of specific fields to return

filters object[]
Filtering parameters.
For filter names, refer to List Filters API.
For filter values, refer to List filter suggestions.
The only exception is resource.tagv2 filter name, provide filter value for it in the following format: "{"key":"'CustomerTagKey'","value":"'CustomerTagValue'"}"
Array [
name string
Name
operator string
Possible values: [tag:yaml.org,2002:value =]
Operator
value string
Value
]
groupBy string[]

For asset or data inventory only. Group returned items by cloud.type, cloud.service, cloud.region, cloud.account, and/or resource.type

limit number

Maximum number of items to return. When data is paginated, maximum number of items per page.The maximum cannot exceed 10,000. The default is 10,000.

offset number

The number of items to skip before selecting items to return. Default is zero

pageToken string

Setting this pagination Token to the nextPageToken from a response object returns the next page of data

sortBy string[]

Array of sort properties. Append :asc or :desc to the key to sort by ascending or descending order respectively. Example sort properties are id:asc and timestamp:desc

timeRange object

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

Responses

200

success

application/json

Schema

Schema

complianceDetails object[]
List of compliance detail
Array [
assignedPolicies int32
Number of policies assigned to the Compliance Standard/Requirement/Section
criticalSeverityFailedResources int64
Number of Compliance Standard/Requirement/Section Scanned Resources failing critical severity policies
default boolean
Is System Default
description string
Description of Compliance Standard/Requirement/Section
failedResources int64
Number of failing Compliance Standard/Requirement/Section Scanned Resources
highSeverityFailedResources int64
Number of Compliance Standard/Requirement/Section Scanned Resources failing high severity policies
id string
ID of Compliance Standard/Requirement/Section
informationalSeverityFailedResources int64
Number of Compliance Standard/Requirement/Section Scanned Resources failing informational severity policies
lowSeverityFailedResources int64
Number of Compliance Standard/Requirement/Section Scanned Resources failing low severity policies
mediumSeverityFailedResources int64
Number of Compliance Standard/Requirement/Section Scanned Resources failing medium severity policies
name string
Name of Compliance Standard/Requirement/Section
passedResources int64
Number of Passing Compliance Standard/Requirement/Section Scanned Resources
totalResources int64
Total number of Compliance Standard/Requirement/Section Scanned Resources
]
requestedTimestamp int64

Requested timestamp

requirementSummaries object[]
List of requirement summaries
Array [
id string
Compliance Requirement ID
name string
Compliance Requirement name
sectionSummaries object[]
Section Summary list for the compliance requirement
Array [
failedResources int64
Number of failed compliance section scanned resources
id string
Compliance section ID
name string
Compliance section name
passedResources int64
Number of passed compliance section scanned resources
totalResources int64
Total number of compliance section scanned resources
]
]
summary object

Model for Compliance Posture Summary

criticalSeverityFailedResources int64

Number of scanned compliance resources whose highest policy failure is critical

failedResources int64

Number of failed scanned compliance resources

highSeverityFailedResources int64

Number of scanned compliance resources that failed high severity policies

informationalSeverityFailedResources int64

Number of scanned compliance resources whose highest policy failure is informational

lowSeverityFailedResources int64

Number of scanned compliance resources whose highest policy failure is low

mediumSeverityFailedResources int64

Number of scanned compliance resources whose highest policy failure is medium

passedResources int64

Number of passed scanned compliance resources

timestamp int64

Timestamp

totalResources int64

Total number of scanned compliance resources

timestamp int64

Timestamp

Example (from schema)

{
  "complianceDetails": [
    {
      "assignedPolicies": 0,
      "criticalSeverityFailedResources": 0,
      "default": true,
      "description": "string",
      "failedResources": 0,
      "highSeverityFailedResources": 0,
      "id": "string",
      "informationalSeverityFailedResources": 0,
      "lowSeverityFailedResources": 0,
      "mediumSeverityFailedResources": 0,
      "name": "string",
      "passedResources": 0,
      "totalResources": 0
    }
  ],
  "requestedTimestamp": 0,
  "requirementSummaries": [
    {
      "id": "string",
      "name": "string",
      "sectionSummaries": [
        {
          "failedResources": 0,
          "id": "string",
          "name": "string",
          "passedResources": 0,
          "totalResources": 0
        }
      ]
    }
  ],
  "summary": {
    "criticalSeverityFailedResources": 0,
    "failedResources": 0,
    "highSeverityFailedResources": 0,
    "informationalSeverityFailedResources": 0,
    "lowSeverityFailedResources": 0,
    "mediumSeverityFailedResources": 0,
    "passedResources": 0,
    "timestamp": 0,
    "totalResources": 0
  },
  "timestamp": 0
}

400

bad_request

Loading...